Aracılığıyla paylaş

New-AzApiManagementSubscription

  • Başvuru
Modül:
Az.ApiManagement

Bir abonelik oluşturur.

Sözdizimi

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

New-AzApiManagementSubscription cmdlet'i bir abonelik oluşturur.

Örnekler

Örnek 1: Kullanıcıyı bir ürüne abone etme

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

Bu komut mevcut bir kullanıcıyı bir ürüne abone eder.

Örnek 2: Tüm Api Kapsamı için abonelik oluşturma

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

Örnek 3: Ürün Kapsamı için abonelik oluşturma

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

Parametreler

-AllowTracing

İzlemenin Abonelik Düzeyinde etkinleştirilip etkinleştirilmeyeceğini belirleyen bayrak. Bu isteğe bağlı parametredir ve varsayılan olarak $null.

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Context

PsApiManagementContext nesnesini belirtir.

Tür:PsApiManagementContext
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Name

Abonelik adını belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PrimaryKey

Abonelik birincil anahtarını belirtir. Bu parametre belirtilmezse anahtar otomatik olarak oluşturulur. Bu parametre 1 ile 256 karakter uzunluğunda olmalıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ProductId

Abone olunacak ürünün kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Scope

Api Kapsamı /apis/{apiId} veya Ürün Kapsamı /products/{productId} veya Genel API Kapsamı /apis veya Genel kapsam / olsun, Aboneliğin Kapsamı. Bu parametre zorunludur.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SecondaryKey

Abonelik ikincil anahtarını belirtir. Bu parametre belirtilmezse otomatik olarak oluşturulur. Bu parametre 1 ile 256 karakter uzunluğunda olmalıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-State

Abonelik durumunu belirtir. Varsayılan değer $Null.

Tür:Nullable<T>[PsApiManagementSubscriptionState]
Kabul edilen değerler:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-SubscriptionId

Abonelik kimliğini belirtir. Belirtilmezse bu parametre oluşturulur.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-UserId

Abone kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

Girişler

PsApiManagementContext

String

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

Çıkışlar

PsApiManagementSubscription