共用方式為

Set-AzApiManagementSubscription

  • 參考
模組:
Az.ApiManagement

設定現有的訂用帳戶詳細數據。

語法

Set-AzApiManagementSubscription
   -InputObject <PsApiManagementSubscription>
   [-Scope <String>]
   [-UserId <String>]
   [-Name <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-State <PsApiManagementSubscriptionState>]
   [-ExpiresOn <DateTime>]
   [-StateComment <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementSubscription
   -Context <PsApiManagementContext>
   -SubscriptionId <String>
   [-Scope <String>]
   [-UserId <String>]
   [-Name <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-State <PsApiManagementSubscriptionState>]
   [-ExpiresOn <DateTime>]
   [-StateComment <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-AzApiManagementSubscription Cmdlet 會設定現有的訂用帳戶詳細數據。

範例

範例 1：設定訂用帳戶的狀態和主要和次要密鑰

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"

此命令會設定訂用帳戶的主要和次要金鑰，並加以啟用。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-Context

指定 PsApiManagementContext 物件。

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

-DefaultProfile

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

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

-ExpiresOn

指定訂閱到期日。 此參數的預設值為 $Null。

類型:Nullable<T>[DateTime]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-InputObject

PsApiManagementSubscription 的實例。 此為必要參數。

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

-Name

指定訂用帳戶名稱。

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

-PassThru

passthru

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

-PrimaryKey

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

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

-Scope

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

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

-SecondaryKey

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

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

-State

指定訂用帳戶狀態。 此參數的預設值為 $Null。

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

-StateComment

指定訂閱狀態批註。 此參數的預設值為 $Null。

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

-SubscriptionId

指定訂用帳戶標識碼。

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

-UserId

訂用帳戶的擁有者。 這是選擇性參數。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

類型:SwitchParameter
別名:wi
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元: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]]

Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

SwitchParameter

輸出

PsApiManagementSubscription