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

Tenant Access - List Secrets

获取租户访问信息详细信息。

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

URI 参数

Name In Required Type Description
accessName
path True

Access 配置的标识符。

resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

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

api-version
query True
  • string

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

响应

Name Type Description
200 OK

租户访问信息。

Headers

  • ETag: string
Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementListSecretsTenantAccess

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access/listSecrets?api-version=2021-12-01-preview

Sample Response

{
  "id": "5600b59375ff190048030003",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "enabled": true
}

定义

AccessIdName

Access 配置的标识符。

AccessInformationSecretsContract

API 管理服务的租户访问信息协定。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

AccessIdName

Access 配置的标识符。

Name Type Description
access
  • string
gitAccess
  • string

AccessInformationSecretsContract

API 管理服务的租户访问信息协定。

Name Type Description
enabled
  • boolean

确定是否启用了直接访问。

id
  • string

访问信息类型 (“access”或“gitAccess”)

primaryKey
  • string

主访问密钥。 此属性不会在“GET”操作上填充! 使用“/listSecrets”POST 请求获取该值。

principalId
  • string

主体 (用户) 标识符。

secondaryKey
  • string

辅助访问密钥。 此属性不会在“GET”操作上填充! 使用“/listSecrets”POST 请求获取该值。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

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

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

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

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

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