你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Configuration Stores - List
列出给定订阅的配置存储。
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores?api-version=2023-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores?api-version=2023-03-01&$skipToken={$skipToken}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
subscription
|
path | True |
string |
Microsoft Azure 订阅 ID。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$skip
|
query |
string |
跳过标记用于在操作返回部分结果后继续检索项。 如果以前的响应包含 nextLink 元素,则 nextLink 元素的值将包含 skipToken 参数,该参数指定要用于后续调用的起点。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求成功;请求格式正确,已正确接收。 |
|
Other Status Codes |
描述操作失败原因的错误响应 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ConfigurationStores_List
Sample Request
Sample Response
{
"value": [
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Succeeded",
"creationDate": "2018-04-24T16:30:55+00:00",
"endpoint": "https://contoso.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"identity": {
"principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
"tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
"type": "SystemAssigned"
},
"id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
"name": "contoso",
"location": "westus",
"tags": {}
},
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Succeeded",
"creationDate": "2018-04-24T23:06:59+00:00",
"endpoint": "https://contoso2.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"identity": {
"principalId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC",
"tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
"type": "SystemAssigned"
},
"id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso2",
"name": "contoso2",
"location": "westus",
"tags": {}
}
]
}
定义
名称 | 说明 |
---|---|
Actions |
基本工作流以外的任何操作 (批准/拒绝/断开连接) |
Configuration |
配置存储以及所有资源属性。 配置存储将拥有开始使用它的所有信息。 |
Configuration |
请求列出配置存储的结果。 |
Connection |
专用链接服务连接状态。 |
created |
创建资源的标识类型。 |
Create |
指示是否需要恢复配置存储。 |
Encryption |
配置存储的加密设置。 |
Error |
资源管理错误附加信息。 |
Error |
错误的详细信息。 |
Error |
错误响应指示服务无法处理传入请求。 错误消息中提供了原因。 |
Identity |
使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 |
Key |
有关配置存储的密钥保管库加密的设置。 |
Private |
连接所属的专用终结点。 |
Private |
对相关专用终结点连接的引用。 |
Private |
专用链接服务连接的状态。 |
Provisioning |
配置存储的预配状态。 |
Public |
启用专用终结点时,控制来自公用网络的数据平面流量的权限。 |
Resource |
可以与资源关联的标识。 |
Sku |
描述配置存储 SKU。 |
system |
与资源的创建和上次修改相关的元数据。 |
User |
由服务的用户管理的资源标识。 |
ActionsRequired
基本工作流以外的任何操作 (批准/拒绝/断开连接)
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
Recreate |
string |
ConfigurationStore
配置存储以及所有资源属性。 配置存储将拥有开始使用它的所有信息。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
托管标识信息(如果已配置)。 |
||
location |
string |
资源所在的地理位置 |
|
name |
string |
资源的名称 |
|
properties.createMode |
指示是否需要恢复配置存储。 |
||
properties.creationDate |
string |
配置存储的创建日期。 |
|
properties.disableLocalAuth |
boolean |
False |
禁用除 AAD 身份验证以外的所有身份验证方法。 |
properties.enablePurgeProtection |
boolean |
False |
指定是否为此配置存储启用清除防护的属性。 |
properties.encryption |
配置存储的加密设置。 |
||
properties.endpoint |
string |
配置存储 API 将可用的 DNS 终结点。 |
|
properties.privateEndpointConnections |
为此资源设置的专用终结点连接的列表。 |
||
properties.provisioningState |
配置存储的预配状态。 |
||
properties.publicNetworkAccess |
启用专用终结点时,控制来自公用网络的数据平面流量的权限。 |
||
properties.softDeleteRetentionInDays |
integer |
7 |
软删除配置存储时将保留该存储的时间(以天为单位)。 |
sku |
配置存储的 SKU。 |
||
systemData |
资源系统元数据。 |
||
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
ConfigurationStoreListResult
请求列出配置存储的结果。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
可用于请求下一组分页结果的 URI。 |
value |
集合值。 |
ConnectionStatus
专用链接服务连接状态。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
指示是否需要恢复配置存储。
名称 | 类型 | 说明 |
---|---|---|
Default |
string |
|
Recover |
string |
EncryptionProperties
配置存储的加密设置。
名称 | 类型 | 说明 |
---|---|---|
keyVaultProperties |
密钥保管库属性。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetails
错误的详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
message |
string |
指示操作失败原因的错误消息。 |
ErrorResponse
错误响应指示服务无法处理传入请求。 错误消息中提供了原因。
名称 | 类型 | 说明 |
---|---|---|
error |
错误的详细信息。 |
IdentityType
使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
KeyVaultProperties
有关配置存储的密钥保管库加密的设置。
名称 | 类型 | 说明 |
---|---|---|
identityClientId |
string |
将用于访问密钥保管库的标识的客户端 ID。 |
keyIdentifier |
string |
用于加密数据的密钥保管库密钥的 URI。 |
PrivateEndpoint
连接所属的专用终结点。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点的资源 ID |
PrivateEndpointConnectionReference
对相关专用终结点连接的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
name |
string |
资源的名称。 |
properties.privateEndpoint |
专用终结点的资源。 |
|
properties.privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
properties.provisioningState |
专用终结点连接的预配状态。 |
|
type |
string |
资源类型。 |
PrivateLinkServiceConnectionState
专用链接服务连接的状态。
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
基本工作流以外的任何操作 (批准/拒绝/断开连接) |
|
description |
string |
专用链接服务连接说明。 |
status |
专用链接服务连接状态。 |
ProvisioningState
配置存储的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PublicNetworkAccess
启用专用终结点时,控制来自公用网络的数据平面流量的权限。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentity
可以与资源关联的标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
标识的主体 ID。 仅为系统分配的标识提供此属性。 |
tenantId |
string |
与资源标识关联的租户 ID。 仅为系统分配的标识提供此属性。 |
type |
使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 |
|
userAssignedIdentities |
<string,
User |
与资源关联的用户分配标识的列表。 用户分配的标识字典密钥将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
Sku
描述配置存储 SKU。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
配置存储的 SKU 名称。 |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
UserIdentity
由服务的用户管理的资源标识。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配的标识的客户端 ID。 |
principalId |
string |
用户分配的标识的主体 ID。 |