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

Subscription - List Secrets

获取指定的订阅密钥。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/listSecrets?api-version=2021-08-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

sid
path True

string

订阅实体标识符。 实体表示用户与API 管理产品之间的关联。

正则表达式模式: ^[^*#&+:<>?]+$

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

响应

名称 类型 说明
200 OK

SubscriptionKeysContract

响应正文包含订阅密钥。

标头

ETag: string

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementSubscriptionListSecrets

示例请求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8/listSecrets?api-version=2021-08-01

示例响应

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

SubscriptionKeysContract

订阅密钥。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

SubscriptionKeysContract

订阅密钥。

名称 类型 说明
primaryKey

string

订阅主密钥。

secondaryKey

string

订阅辅助密钥。