New-AzApiManagementSubscription
Crea una sottoscrizione.
Sintassi
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>] Descrizione
Il cmdlet New-AzApiManagementSubscription
Esempio
Esempio 1: Sottoscrivere un utente a un prodotto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"Questo comando sottoscrive un utente esistente a un prodotto.
Esempio 2: Creare una sottoscrizione per tutti gli ambiti api
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"Esempio 3: Creare una sottoscrizione per l'ambito del prodotto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"Parametri
-AllowTracing
Flag che determina se la traccia può essere abilitata a livello di sottoscrizione. Si tratta di un parametro facoltativo e il valore predefinito è $null.
| Tipo: | SwitchParameter |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Context
Specifica un oggetto PsApiManagementContext
| Tipo: | PsApiManagementContext |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-DefaultProfile
Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.
| Tipo: | IAzureContextContainer |
| Alias: | AzContext, AzureRmContext, AzureCredential |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | False |
| Accettare caratteri jolly: | False |
-Name
Specifica il nome della sottoscrizione.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-PrimaryKey
Specifica la chiave primaria della sottoscrizione. Se questo parametro non viene specificato, la chiave viene generata automaticamente. Questo parametro deve essere lungo da 1 a 256 caratteri.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-ProductId
Specifica l'ID del prodotto a cui eseguire la sottoscrizione.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Scope
Ambito della sottoscrizione, ovvero ambito API /apis/{apiId} o Ambito prodotto /products/{productId} o Ambito API globale /apis o ambito globale /. Questo parametro è obbligatorio.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-SecondaryKey
Specifica la chiave secondaria della sottoscrizione. Questo parametro viene generato automaticamente se non è specificato. Questo parametro deve essere lungo da 1 a 256 caratteri.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-State
Specifica lo stato della sottoscrizione. Il valore predefinito è $Null.
| Tipo: | Nullable<T>[PsApiManagementSubscriptionState] |
| Valori accettati: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-SubscriptionId
Specifica l'ID sottoscrizione. Questo parametro viene generato se non specificato.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-UserId
Specifica l'ID sottoscrittore.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
Input
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
