Configuration Stores - List Keys

列出指定組態存放區的存取金鑰。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01&$skipToken={$skipToken}

URI 參數

名稱 位於 必要 類型 Description
configStoreName
path True

string

組態存放區的名稱。

Regex pattern: ^[a-zA-Z0-9_-]*$

resourceGroupName
path True

string

容器登錄所屬的資源群組名稱。

subscriptionId
path True

string

Microsoft Azure 訂用帳戶標識碼。

api-version
query True

string

用戶端 API 版本。

$skipToken
query

string

略過令牌可用來在作業傳回部分結果之後繼續擷取專案。 如果先前的回應包含 nextLink 元素,nextLink 元素的值將包含 skipToken 參數,指定要用於後續呼叫的起點。

回應

名稱 類型 Description
200 OK

ApiKeyListResult

要求成功;要求格式正確,且已正確接收。

Other Status Codes

ErrorResponse

描述作業為何失敗的錯誤回應

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ConfigurationStores_ListKeys

Sample Request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2023-03-01

Sample Response

{
  "value": [
    {
      "id": "439AD01B4BE67DB1",
      "name": "Primary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "CB45E100456857B9",
      "name": "Secondary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "B3AC55B7E71431A9",
      "name": "Primary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    },
    {
      "id": "E2AF6A9A89DCC177",
      "name": "Secondary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    }
  ]
}

定義

名稱 Description
ApiKey

用來向組態存放區端點進行驗證的 API 金鑰。

ApiKeyListResult

列出 API 金鑰的要求結果。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetails

錯誤的詳細數據。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。

ApiKey

用來向組態存放區端點進行驗證的 API 金鑰。

名稱 類型 Description
connectionString

string

連接字串,可藉由支援客戶端進行驗證。

id

string

金鑰識別碼。

lastModified

string

上次修改任何索引鍵屬性的時間。

name

string

描述其使用方式之索引鍵的名稱。

readOnly

boolean

此索引鍵是否只能用於讀取作業。

value

string

用於驗證之金鑰的值。

ApiKeyListResult

列出 API 金鑰的要求結果。

名稱 類型 Description
nextLink

string

可用來要求下一組分頁結果的 URI。

value

ApiKey[]

集合值。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetails

錯誤的詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

message

string

指出作業失敗原因的錯誤訊息。

ErrorResponse

錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。

名稱 類型 Description
error

ErrorDetails

錯誤的詳細數據。