Microsoft.AppConfiguration (stable:2024-06-01)

2025/05/01 • 29 new methods

ConfigurationStores_List (new)
Description :  Lists the configuration stores for a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$skipToken:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_ListByResourceGroup (new)
Description :  Lists the configuration stores for a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$skipToken:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_Get (new)
Description :  Gets the properties of the specified configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_Create (new)
Description :  Creates a configuration store with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
configStoreCreationParameters:
{
Description: The parameters for creating a configuration store. ,
Required: True ,
}
{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_Delete (new)
Description :  Deletes a configuration store.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
location:
{
Description: URL to query for the operation result ,
}
string ,
retry-after:
{
Description: Indicates how long the client should wait before polling the URL in the Location or Azure-AsyncOperation header. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_Update (new)
Description :  Updates a configuration store with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
configStoreUpdateParameters:
{
Description: The parameters for updating a configuration store. ,
Required: True ,
}
{
properties:
{
Description: The properties for updating a configuration store. ,
Required: False ,
}
{
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed identity information for the configuration store. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU of the configuration store. ,
Required: False ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: The managed identity information, if configured. ,
Required: False ,
}
{
type:
{
Description: 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. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
principalId:
{
Description: The principal id of the identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties of a configuration store. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the configuration store. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of configuration store. ,
Format: date-time ,
Required: False ,
}
string ,
endpoint:
{
Description: The DNS endpoint where the configuration store API will be available. ,
Required: False ,
}
string ,
encryption:
{
Description: The encryption settings of the configuration store. ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
identityClientId:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
}
,
}
,
privateEndpointConnections:
{
Description: The list of private endpoint connections that are set up for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Control permission for data plane traffic coming from public networks while private endpoint is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
disableLocalAuth:
{
Description: Disables all authentication methods other than AAD authentication. ,
Required: False ,
}
boolean ,
softDeleteRetentionInDays:
{
Description: The amount of time in days that the configuration store will be retained when it is soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultKeyValueRevisionRetentionPeriodInSeconds:
{
Description: The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores. ,
Format: int64 ,
Required: False ,
}
integer ,
enablePurgeProtection:
{
Description: Property specifying whether protection against purge is enabled for this configuration store. ,
Required: False ,
}
boolean ,
dataPlaneProxy:
{
Description: Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). ,
Required: False ,
}
{
authenticationMode:
{
Description: The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. ,
Enum:
{
Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. ,
Pass-through: 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). ,
}
,
Required: False ,
}
enum ,
privateLinkDelegation:
{
Description: 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. ,
Enum:
{
Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. ,
Disabled: Request is denied if the resource requires private link. ,
}
,
Required: False ,
}
enum ,
}
,
createMode:
{
Description: Indicates whether the configuration store need to be recovered. ,
Enum:
{
Recover: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_CheckNameAvailability (new)
Description :  Checks whether the configuration store name is available for use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
checkNameAvailabilityParameters:
{
Description: The object containing information for the availability request. ,
Required: True ,
}
{
name:
{
Description: The name to check for availability. ,
Required: True ,
}
string ,
type:
{
Description: The resource type to check for name availability. ,
Enum:
{
Microsoft.AppConfiguration/configurationStores: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value indicating whether the resource name is available. ,
Required: False ,
}
boolean ,
message:
{
Description: If any, the error message that provides more detail for the reason that the name is not available. ,
Required: False ,
}
string ,
reason:
{
Description: If any, the reason that the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_ListKeys (new)
Description :  Lists the access key for the specified configuration store.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$skipToken:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The key ID. ,
Required: False ,
}
string ,
name:
{
Description: A name for the key describing its usage. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key that is used for authentication purposes. ,
Required: False ,
}
string ,
connectionString:
{
Description: A connection string that can be used by supporting clients for authentication. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last time any of the key's properties were modified. ,
Format: date-time ,
Required: False ,
}
string ,
readOnly:
{
Description: Whether this key can only be used for read operations. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_RegenerateKey (new)
Description :  Regenerates an access key for the specified configuration store.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/regenerateKey
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
regenerateKeyParameters:
{
Description: The parameters for regenerating an access key. ,
Required: True ,
}
{
id:
{
Description: The id of the key to regenerate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The key ID. ,
Required: False ,
}
string ,
name:
{
Description: A name for the key describing its usage. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key that is used for authentication purposes. ,
Required: False ,
}
string ,
connectionString:
{
Description: A connection string that can be used by supporting clients for authentication. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last time any of the key's properties were modified. ,
Format: date-time ,
Required: False ,
}
string ,
readOnly:
{
Description: Whether this key can only be used for read operations. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists the operations available from this provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AppConfiguration/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$skipToken:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The display information for the configuration store operation. ,
Required: False ,
}
{
provider:
{
Description: The resource provider name: Microsoft App Configuration." ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation that users can perform. ,
Required: False ,
}
string ,
description:
{
Description: The description for the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specifications of the operation ,
Required: False ,
}
{
logSpecifications:
{
Description: Specifications of the Log for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration of the log ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit that makes sense for the metric ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
internalMetricName:
{
Description: Internal metric name. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Internal name of the dimension. ,
Required: False ,
}
string ,
}
,
]
,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByConfigurationStore (new)
Description :  Lists all private endpoint connections for a configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Update the state of the specified private endpoint connection associated with the configuration store. This operation cannot be used to create a private endpoint connection. Private endpoint connections must be created with the Network resource provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a private endpoint. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status of the private endpoint connection. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: The resource Id for private endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByConfigurationStore (new)
Description :  Gets the private link resources that need to be created for a configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The list of required DNS zone names of the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource that need to be created for a configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Private link resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The list of required DNS zone names of the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KeyValues_Get (new)
Description :  Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
keyValueName:
{
Description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All key-value properties. ,
Required: False ,
}
{
key:
{
Description: The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. ,
Required: False ,
}
string ,
label:
{
Description: A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key-value. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. ,
Required: False ,
}
string ,
eTag:
{
Description: An ETag indicating the state of a key-value within a configuration store. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last time a modifying operation was performed on the given key-value. ,
Format: date-time ,
Required: False ,
}
string ,
locked:
{
Description: A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. ,
Required: False ,
}
boolean ,
tags:
{
Description: A dictionary of tags that can help identify what a key-value may be applicable for. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KeyValues_CreateOrUpdate (new)
Description :  Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
keyValueName:
{
Description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. ,
Required: True ,
}
string ,
keyValueParameters:
{
Description: The parameters for creating a key-value. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All key-value properties. ,
Required: False ,
}
{
key:
{
Description: The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. ,
Required: False ,
}
string ,
label:
{
Description: A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key-value. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. ,
Required: False ,
}
string ,
eTag:
{
Description: An ETag indicating the state of a key-value within a configuration store. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last time a modifying operation was performed on the given key-value. ,
Format: date-time ,
Required: False ,
}
string ,
locked:
{
Description: A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. ,
Required: False ,
}
boolean ,
tags:
{
Description: A dictionary of tags that can help identify what a key-value may be applicable for. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All key-value properties. ,
Required: False ,
}
{
key:
{
Description: The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. ,
Required: False ,
}
string ,
label:
{
Description: A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key-value. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. ,
Required: False ,
}
string ,
eTag:
{
Description: An ETag indicating the state of a key-value within a configuration store. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last time a modifying operation was performed on the given key-value. ,
Format: date-time ,
Required: False ,
}
string ,
locked:
{
Description: A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. ,
Required: False ,
}
boolean ,
tags:
{
Description: A dictionary of tags that can help identify what a key-value may be applicable for. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KeyValues_Delete (new)
Description :  Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
keyValueName:
{
Description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_ListDeleted (new)
Description :  Gets information about the deleted configuration stores in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/deletedConfigurationStores
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of deleted configuration store. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID for the deleted configuration store. ,
Required: False ,
}
string ,
name:
{
Description: The name of the configuration store. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the configuration store. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the deleted configuration store ,
Required: False ,
}
{
configurationStoreId:
{
Description: The resource id of the original configuration store. ,
Required: False ,
}
string ,
location:
{
Description: The location of the original configuration store. ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deleted date. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purged date. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the original configuration store. ,
Required: False ,
}
object ,
purgeProtectionEnabled:
{
Description: Purge protection status of the original configuration store. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of deleted configuration stores. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_GetDeleted (new)
Description :  Gets a deleted Azure app configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
location:
{
Description: The location in which uniqueness will be verified. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID for the deleted configuration store. ,
Required: False ,
}
string ,
name:
{
Description: The name of the configuration store. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of the configuration store. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the deleted configuration store ,
Required: False ,
}
{
configurationStoreId:
{
Description: The resource id of the original configuration store. ,
Required: False ,
}
string ,
location:
{
Description: The location of the original configuration store. ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deleted date. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The scheduled purged date. ,
Format: date-time ,
Required: False ,
}
string ,
tags:
{
Description: Tags of the original configuration store. ,
Required: False ,
}
object ,
purgeProtectionEnabled:
{
Description: Purge protection status of the original configuration store. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConfigurationStores_PurgeDeleted (new)
Description :  Permanently deletes the specified configuration store.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}/purge
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
location:
{
Description: The location in which uniqueness will be verified. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_RegionalCheckNameAvailability (new)
Description :  Checks whether the configuration store name is available for use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
location:
{
Description: The location in which uniqueness will be verified. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
checkNameAvailabilityParameters:
{
Description: The object containing information for the availability request. ,
Required: True ,
}
{
name:
{
Description: The name to check for availability. ,
Required: True ,
}
string ,
type:
{
Description: The resource type to check for name availability. ,
Enum:
{
Microsoft.AppConfiguration/configurationStores: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value indicating whether the resource name is available. ,
Required: False ,
}
boolean ,
message:
{
Description: If any, the error message that provides more detail for the reason that the name is not available. ,
Required: False ,
}
string ,
reason:
{
Description: If any, the reason that the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_ListByConfigurationStore (new)
Description :  Lists the replicas for a given configuration store.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$skipToken:
{
Description: 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. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the replica. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: All replica properties. ,
Required: False ,
}
{
endpoint:
{
Description: The URI of the replica where the replica API will be available. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the replica. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_Get (new)
Description :  Gets the properties of the specified replica.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the replica. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: All replica properties. ,
Required: False ,
}
{
endpoint:
{
Description: The URI of the replica where the replica API will be available. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the replica. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_Create (new)
Description :  Creates a replica with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
replicaCreationParameters:
{
Description: The parameters for creating a replica. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the replica. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: All replica properties. ,
Required: False ,
}
{
endpoint:
{
Description: The URI of the replica where the replica API will be available. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the replica. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the replica. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: All replica properties. ,
Required: False ,
}
{
endpoint:
{
Description: The URI of the replica where the replica API will be available. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the replica. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the replica. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: All replica properties. ,
Required: False ,
}
{
endpoint:
{
Description: The URI of the replica where the replica API will be available. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the replica. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Replicas_Delete (new)
Description :  Deletes a replica.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Snapshots_Get (new)
Description :  Gets the properties of the specified snapshot. NOTE: This operation is intended for use in Azure Resource Manager (ARM) Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the snapshot. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All snapshot properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the snapshot. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of the snapshot. ,
Enum:
{
Provisioning: No description available. ,
Ready: No description available. ,
Archived: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: A list of filters used to filter the key-values included in the snapshot. ,
Required: True ,
}
[
{
key:
{
Description: Filters key-values by their key field. ,
Required: True ,
}
string ,
label:
{
Description: Filters key-values by their label field. ,
Required: False ,
}
string ,
}
,
]
,
compositionType:
{
Description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. ,
Enum:
{
Key: No description available. ,
Key_Label: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The time that the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
expires:
{
Description: The time that the snapshot will expire. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriod:
{
Description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. ,
Format: int64 ,
Required: False ,
}
integer ,
size:
{
Description: The size in bytes of the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsCount:
{
Description: The amount of key-values in the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Snapshots_Create (new)
Description :  Creates a snapshot. NOTE: This operation is intended for use in Azure Resource Manager (ARM) Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
snapshotName:
{
Description: The name of the snapshot. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters for creating a snapshot. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the snapshot. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All snapshot properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the snapshot. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of the snapshot. ,
Enum:
{
Provisioning: No description available. ,
Ready: No description available. ,
Archived: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: A list of filters used to filter the key-values included in the snapshot. ,
Required: True ,
}
[
{
key:
{
Description: Filters key-values by their key field. ,
Required: True ,
}
string ,
label:
{
Description: Filters key-values by their label field. ,
Required: False ,
}
string ,
}
,
]
,
compositionType:
{
Description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. ,
Enum:
{
Key: No description available. ,
Key_Label: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The time that the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
expires:
{
Description: The time that the snapshot will expire. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriod:
{
Description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. ,
Format: int64 ,
Required: False ,
}
integer ,
size:
{
Description: The size in bytes of the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsCount:
{
Description: The amount of key-values in the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the snapshot. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All snapshot properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the snapshot. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of the snapshot. ,
Enum:
{
Provisioning: No description available. ,
Ready: No description available. ,
Archived: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: A list of filters used to filter the key-values included in the snapshot. ,
Required: True ,
}
[
{
key:
{
Description: Filters key-values by their key field. ,
Required: True ,
}
string ,
label:
{
Description: Filters key-values by their label field. ,
Required: False ,
}
string ,
}
,
]
,
compositionType:
{
Description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. ,
Enum:
{
Key: No description available. ,
Key_Label: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The time that the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
expires:
{
Description: The time that the snapshot will expire. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriod:
{
Description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. ,
Format: int64 ,
Required: False ,
}
integer ,
size:
{
Description: The size in bytes of the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsCount:
{
Description: The amount of key-values in the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the snapshot. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: All snapshot properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the snapshot. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of the snapshot. ,
Enum:
{
Provisioning: No description available. ,
Ready: No description available. ,
Archived: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: A list of filters used to filter the key-values included in the snapshot. ,
Required: True ,
}
[
{
key:
{
Description: Filters key-values by their key field. ,
Required: True ,
}
string ,
label:
{
Description: Filters key-values by their label field. ,
Required: False ,
}
string ,
}
,
]
,
compositionType:
{
Description: The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. ,
Enum:
{
Key: No description available. ,
Key_Label: No description available. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The time that the snapshot was created. ,
Format: date-time ,
Required: False ,
}
string ,
expires:
{
Description: The time that the snapshot will expire. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriod:
{
Description: The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. ,
Format: int64 ,
Required: False ,
}
integer ,
size:
{
Description: The size in bytes of the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
itemsCount:
{
Description: The amount of key-values in the snapshot. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}