Configuration Stores - List Keys

参考

服务:: App Configuration

API 版本:: 2024-06-01

列出指定配置存储的访问密钥。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
configStoreName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9_-]*$	配置存储区的名称。
resourceGroupName	path	True	string	容器注册表所属的资源组的名称。
subscriptionId	path	True	string	Microsoft Azure 订阅 ID。
api-version	query	True	string	客户端 API 版本。
$skipToken	query		string	跳过令牌用于在作返回部分结果后继续检索项。如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个 skipToken 参数，该参数指定用于后续调用的起点。

响应

名称	类型	说明
200 OK	ApiKeyListResult	请求成功;请求格式正确，已正确接收。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ConfigurationStores_ListKeys

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "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
    }
  ]
}

定义

名称	说明
ApiKey	用于通过配置存储终结点进行身份验证的 API 密钥。
ApiKeyListResult	列出 API 密钥的请求的结果。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。错误消息中提供了原因。

ApiKey

Object

用于通过配置存储终结点进行身份验证的 API 密钥。

名称	类型	说明
connectionString	string	支持客户端进行身份验证时可以使用的连接字符串。
id	string	密钥 ID。
lastModified	string (date-time)	上次修改任何键的属性的时间。
name	string	描述其用法的密钥的名称。
readOnly	boolean	此密钥是否只能用于读取作。
value	string	用于身份验证的密钥的值。

ApiKeyListResult

Object

列出 API 密钥的请求的结果。

名称	类型	说明
nextLink	string	可用于请求下一组分页结果的 URI。
value	ApiKey[]	集合值。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetails

Object

错误的详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
message	string	指示操作失败的原因的错误消息。

ErrorResponse

Object

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

名称	类型	说明
error	ErrorDetails	错误的详细信息。