通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

说明

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 范围 /api 或全局范围 /。 此参数是必需的。

类型: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

指定订阅 ID。

类型: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