Configuration Stores - List
Lists the configuration stores for a given subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores?api-version=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores?api-version=2024-05-01&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
The Microsoft Azure subscription ID. |
api-version
|
query | True |
string |
The client API version. |
$skip
|
query |
string |
A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request was successful; the request was well-formed and received properly. |
|
Other Status Codes |
Error response describing why the operation failed |
Security
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 | impersonate your user account |
Examples
ConfigurationStores_List
Sample request
GET https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.AppConfiguration/configurationStores?api-version=2024-05-01
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": {}
}
]
}
Definitions
Name | Description |
---|---|
Actions |
Any action that is required beyond basic workflow (approve/ reject/ disconnect) |
Authentication |
The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. |
Configuration |
The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it. |
Configuration |
The result of a request to list configuration stores. |
Connection |
The private link service connection status. |
created |
The type of identity that created the resource. |
Create |
Indicates whether the configuration store need to be recovered. |
Data |
The data plane proxy settings for a configuration store. |
Encryption |
The encryption settings for a configuration store. |
Error |
The resource management error additional info. |
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Identity |
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. |
Key |
Settings concerning key vault encryption for a configuration store. |
Private |
Private endpoint which a connection belongs to. |
Private |
A reference to a related private endpoint connection. |
Private |
The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. |
Private |
The state of a private link service connection. |
Provisioning |
The provisioning state of the configuration store. |
Public |
Control permission for data plane traffic coming from public networks while private endpoint is enabled. |
Resource |
An identity that can be associated with a resource. |
Sku |
Describes a configuration store SKU. |
system |
Metadata pertaining to creation and last modification of the resource. |
User |
A resource identity that is managed by the user of the service. |
ActionsRequired
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Name | Type | Description |
---|---|---|
None |
string |
|
Recreate |
string |
AuthenticationMode
The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources.
Name | Type | Description |
---|---|---|
Local |
string |
The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. |
Pass-through |
string |
The pass-through authentication mode. User identity will be passed through from Azure Resource Manager (ARM), requiring user to have data plane action permissions (Available via App Configuration Data Owner/ App Configuration Data Reader). |
ConfigurationStore
The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
The managed identity information, if configured. |
||
location |
string |
The geo-location where the resource lives |
|
name |
string |
The name of the resource |
|
properties.createMode |
Indicates whether the configuration store need to be recovered. |
||
properties.creationDate |
string |
The creation date of configuration store. |
|
properties.dataPlaneProxy |
Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). |
||
properties.disableLocalAuth |
boolean |
False |
Disables all authentication methods other than AAD authentication. |
properties.enablePurgeProtection |
boolean |
False |
Property specifying whether protection against purge is enabled for this configuration store. |
properties.encryption |
The encryption settings of the configuration store. |
||
properties.endpoint |
string |
The DNS endpoint where the configuration store API will be available. |
|
properties.privateEndpointConnections |
The list of private endpoint connections that are set up for this resource. |
||
properties.provisioningState |
The provisioning state of the configuration store. |
||
properties.publicNetworkAccess |
Control permission for data plane traffic coming from public networks while private endpoint is enabled. |
||
properties.softDeleteRetentionInDays |
integer |
7 |
The amount of time in days that the configuration store will be retained when it is soft deleted. |
sku |
The sku of the configuration store. |
||
systemData |
Resource system metadata. |
||
tags |
object |
Resource tags. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ConfigurationStoreListResult
The result of a request to list configuration stores.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI that can be used to request the next set of paged results. |
value |
The collection value. |
ConnectionStatus
The private link service connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
Indicates whether the configuration store need to be recovered.
Name | Type | Description |
---|---|---|
Default |
string |
|
Recover |
string |
DataPlaneProxyProperties
The data plane proxy settings for a configuration store.
Name | Type | Description |
---|---|---|
authenticationMode |
The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. |
|
privateLinkDelegation |
The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. |
EncryptionProperties
The encryption settings for a configuration store.
Name | Type | Description |
---|---|---|
keyVaultProperties |
Key vault properties. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
IdentityType
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
KeyVaultProperties
Settings concerning key vault encryption for a configuration store.
Name | Type | Description |
---|---|---|
identityClientId |
string |
The client id of the identity which will be used to access key vault. |
keyIdentifier |
string |
The URI of the key vault key used to encrypt data. |
PrivateEndpoint
Private endpoint which a connection belongs to.
Name | Type | Description |
---|---|---|
id |
string |
The resource Id for private endpoint |
PrivateEndpointConnectionReference
A reference to a related private endpoint connection.
Name | Type | Description |
---|---|---|
id |
string |
The resource ID. |
name |
string |
The name of the resource. |
properties.privateEndpoint |
The resource of private endpoint. |
|
properties.privateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
|
properties.provisioningState |
The provisioning status of the private endpoint connection. |
|
type |
string |
The type of the resource. |
PrivateLinkDelegation
The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link.
Name | Type | Description |
---|---|---|
Disabled |
string |
Request is denied if the resource requires private link. |
Enabled |
string |
Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. |
PrivateLinkServiceConnectionState
The state of a private link service connection.
Name | Type | Description |
---|---|---|
actionsRequired |
Any action that is required beyond basic workflow (approve/ reject/ disconnect) |
|
description |
string |
The private link service connection description. |
status |
The private link service connection status. |
ProvisioningState
The provisioning state of the configuration store.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PublicNetworkAccess
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceIdentity
An identity that can be associated with a resource.
Name | Type | Description |
---|---|---|
principalId |
string |
The principal id of the identity. This property will only be provided for a system-assigned identity. |
tenantId |
string |
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. |
type |
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. |
|
userAssignedIdentities |
<string,
User |
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Sku
Describes a configuration store SKU.
Name | Type | Description |
---|---|---|
name |
string |
The SKU name of the configuration store. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
UserIdentity
A resource identity that is managed by the user of the service.
Name | Type | Description |
---|---|---|
clientId |
string |
The client ID of the user-assigned identity. |
principalId |
string |
The principal ID of the user-assigned identity. |