共用方式為

New-AzApiManagementSubscription

  • 參考
模組:
Az.ApiManagement

建立訂用帳戶。

語法

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 會建立訂用帳戶。

範例

範例 1：訂閱用戶產品

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

此命令會將現有的使用者訂閱至產品。

範例 2：為所有 Api 範圍建立訂用帳戶

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

範例 3：建立產品範圍的訂用帳戶

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

參數

-AllowTracing

旗標，決定是否可以在訂用帳戶層級啟用追蹤。 這是選擇性參數，預設值為 $null。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Context

指定 PsApiManagementContext 物件。

類型:PsApiManagementContext
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Name

指定訂用帳戶名稱。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-PrimaryKey

指定訂用帳戶主鍵。 如果未指定此參數，則會自動產生金鑰。 此參數長度必須為 1 到 256 個字元。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ProductId

指定要訂閱的產品標識碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Scope

訂用帳戶的範圍，無論是 Api 範圍 /apis/{apiId} 或產品範圍 /products/{productId} 或全域 API 範圍 /apis 或全域範圍 /。 這是必要參數。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-SecondaryKey

指定訂用帳戶次要金鑰。 如果未指定此參數，則會自動產生此參數。 此參數長度必須為 1 到 256 個字元。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-State

指定訂用帳戶狀態。 預設值為 $Null。

類型:Nullable<T>[PsApiManagementSubscriptionState]
接受的值:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-SubscriptionId

指定訂用帳戶標識碼。 如果未指定，就會產生此參數。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-UserId

指定訂閱者標識碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

輸入

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]]

輸出

PsApiManagementSubscription