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 參數

Name In Required Type Description
resourceGroupName
path True
  • string

資源群組的名稱。

serviceName
path True
  • string

API 管理服務的名稱。

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

sid
path True
  • string

訂用帳戶實體識別碼。 實體代表使用者與 API 管理中的產品之間的關聯。

Regex pattern: ^[^*#&+:<>?]+$

subscriptionId
path True
  • string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳號憑證。 訂用帳戶識別碼會構成每個服務呼叫 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 模擬您的使用者帳戶

範例

ApiManagementSubscriptionListSecrets

Sample Request

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

Sample Response

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

定義

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

SubscriptionKeysContract

訂用帳戶金鑰。

ErrorFieldContract

錯誤欄位合約。

Name Type Description
code
  • string

屬性層級錯誤碼。

message
  • string

人們可讀取的屬性層級錯誤標記法。

target
  • string

屬性名稱。

ErrorResponse

錯誤回應。

Name Type Description
error.code
  • string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

如果發生驗證錯誤,則為不正確欄位清單會送出要求。

error.message
  • string

錯誤的人們可讀取標記法。

SubscriptionKeysContract

訂用帳戶金鑰。

Name Type Description
primaryKey
  • string

訂用帳戶主要金鑰。

secondaryKey
  • string

訂用帳戶次要金鑰。