New-AzApiManagementSubscription
Tworzy subskrypcję.
Składnia
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>] Opis
Polecenie cmdlet New-AzApiManagementSubscription tworzy subskrypcję.
Przykłady
Przykład 1. Subskrybowanie użytkownika do produktu
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"To polecenie subskrybuje istniejącego użytkownika do produktu.
Przykład 2. Tworzenie subskrypcji dla całego zakresu interfejsu API
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"Przykład 3. Tworzenie subskrypcji dla zakresu produktu
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"Parametry
-AllowTracing
Flaga określająca, czy śledzenie można włączyć na poziomie subskrypcji. Jest to opcjonalny parametr, a wartość domyślna to $null.
| Typ: | SwitchParameter |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Context
Określa obiekt PsApiManagementContext.
| Typ: | PsApiManagementContext |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
| Typ: | IAzureContextContainer |
| Aliasy: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | False |
| Akceptowanie symboli wieloznacznych: | False |
-Name
Określa nazwę subskrypcji.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-PrimaryKey
Określa klucz podstawowy subskrypcji. Jeśli ten parametr nie zostanie określony, klucz zostanie wygenerowany automatycznie. Ten parametr musi mieć długość od 1 do 256 znaków.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-ProductId
Określa identyfikator produktu, do którego ma być subskrybowany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Scope
Zakres subskrypcji, niezależnie od tego, czy jest to zakres interfejsu API /apis/{apiId}, zakres produktu /products/{productId} lub globalny zakres interfejsu API /apis lub zakres globalny /. Ten parametr jest wymagany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-SecondaryKey
Określa klucz pomocniczy subskrypcji. Ten parametr jest generowany automatycznie, jeśli nie zostanie określony. Ten parametr musi mieć długość od 1 do 256 znaków.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-State
Określa stan subskrypcji. Wartość domyślna to $Null.
| Typ: | Nullable<T>[PsApiManagementSubscriptionState] |
| Dopuszczalne wartości: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-SubscriptionId
Określa identyfikator subskrypcji. Ten parametr jest generowany, jeśli nie zostanie określony.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-UserId
Określa identyfikator subskrybenta.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
Dane wejściowe
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
