New-AzApiManagementSubscription
Crée un abonnement.
Syntaxe
New-AzApiManagementSubscription
-Context <PsApiManagementContext>
[-SubscriptionId <String>]
-Name <String>
-UserId <String>
-ProductId <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-AllowTracing]
[-State <PsApiManagementSubscriptionState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzApiManagementSubscription
-Context <PsApiManagementContext>
[-SubscriptionId <String>]
-Name <String>
[-UserId <String>]
-Scope <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-AllowTracing]
[-State <PsApiManagementSubscriptionState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
La cmdlet New-AzApiManagementSubscription crée un abonnement.
Exemples
Exemple 1 : Abonner un utilisateur à un produit
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"Cette commande abonne un utilisateur existant à un produit.
Exemple 2 : Créer un abonnement pour toutes les étendues d’API
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"Exemple 3 : Créer un abonnement pour l’étendue du produit
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"Paramètres
-AllowTracing
Indicateur qui détermine si le suivi peut être activé au niveau de l’abonnement. Il s’agit d’un paramètre facultatif et la valeur par défaut est $null.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Context
Spécifie un objet PsApiManagementContext.
| Type: | PsApiManagementContext |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
| Type: | IAzureContextContainer |
| Alias: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-Name
Spécifie le nom de l’abonnement.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-PrimaryKey
Spécifie la clé primaire de l’abonnement. Si ce paramètre n’est pas spécifié, la clé est générée automatiquement. Ce paramètre doit avoir une longueur de 1 à 256 caractères.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-ProductId
Spécifie l’ID du produit auquel s’abonner.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Scope
Étendue de l’abonnement, qu’il s’agisse de l’étendue de l’API /apis/{apiId} ou de l’étendue du produit /products/{productId} ou de l’étendue de l’API globale /apis ou de l’étendue globale /. Ce paramètre est requis.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-SecondaryKey
Spécifie la clé secondaire de l’abonnement. Ce paramètre est généré automatiquement s’il n’est pas spécifié. Ce paramètre doit avoir une longueur de 1 à 256 caractères.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-State
Spécifie l’état de l’abonnement. La valeur par défaut est $Null.
| Type: | Nullable<T>[PsApiManagementSubscriptionState] |
| Valeurs acceptées: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-SubscriptionId
Spécifie l’ID d’abonnement. Ce paramètre est généré s’il n’est pas spécifié.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-UserId
Spécifie l’ID d’abonné.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
Entrées
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
