Sdílet prostřednictvím

New-AzApiManagementSubscription

  • Reference
Modul:
Az.ApiManagement

Vytvoří předplatné.

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

Rutina New-AzApiManagementSubscription vytvoří předplatné.

Příklady

Příklad 1: Přihlášení uživatele k odběru produktu

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"

Tento příkaz přihlásí existujícího uživatele k odběru produktu.

Příklad 2: Vytvoření předplatného pro všechny obory rozhraní API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"

Příklad 3: Vytvoření předplatného pro obor produktu

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"

Parametry

-AllowTracing

Příznak určující, jestli je možné povolit trasování na úrovni předplatného. Jedná se o volitelný parametr a výchozí hodnota je $null.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Context

Určuje PsApiManagementContext objektu.

Typ:PsApiManagementContext
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Name

Určuje název předplatného.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-PrimaryKey

Určuje primární klíč předplatného. Pokud tento parametr není zadán, klíč se vygeneruje automaticky. Tento parametr musí mít délku 1 až 256 znaků.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ProductId

Určuje ID produktu, ke kterému se má přihlásit k odběru.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Scope

Rozsah předplatného, ať už se jedná o obor rozhraní API /apis/{apiId} nebo rozsah produktu /products/{productId} nebo globální obor rozhraní API /apis nebo globální obor /. Tento parametr je povinný.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SecondaryKey

Určuje sekundární klíč předplatného. Tento parametr se vygeneruje automaticky, pokud není zadaný. Tento parametr musí mít délku 1 až 256 znaků.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-State

Určuje stav předplatného. Výchozí hodnota je $Null.

Typ:Nullable<T>[PsApiManagementSubscriptionState]
Přípustné hodnoty:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionId

Určuje ID předplatného. Tento parametr se vygeneruje, pokud není zadaný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-UserId

Určuje ID odběratele.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

Vstupy

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Výstupy