Microsoft.AppConfiguration (preview:2025-02-01)

2025/10/14 • 29 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists the operations available from this provider."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    }
  ]
}

⚼ Request

GET:  /providers/Microsoft.AppConfiguration/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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 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 ,
}
,
]
,
}
,
}
Operations_CheckNameAvailability (updated)
Description :  Checks whether the configuration store name is available for use.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "checkNameAvailabilityParameters",
      "Description": {
        "new": "The request body",
        "old": "The object containing information for the availability request."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
checkNameAvailabilityParameters:
{
Description: The request body ,
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 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 ,
}
,
]
,
}
,
}
ConfigurationStores_List (updated)
Description :  Lists the configuration stores for a given subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ConfigurationStore list operation.",
        "old": "The result of a request to list configuration stores."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConfigurationStore items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_c60657a2d38943e0a286bc61d94d2661": {
                "#name": "systemData",
                "Description": "Resource system metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ConfigurationStore items on this page ,
Required: True ,
}
[
{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
ConfigurationStores_ListDeleted (updated)
Description :  Gets information about the deleted configuration stores in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_ListDeleted",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a DeletedConfigurationStore list operation.",
        "old": "List of deleted configuration stores"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DeletedConfigurationStore items on this page",
            "old": "The list of deleted configuration store."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_5743cdf9800547398db9c0f3de44e056": {
                "#name": "id",
                "Description": "The resource ID for the deleted configuration store.",
                "Required": false,
                "Type": "string"
              },
              "@removed_7bb35c88678d4162aa40f2e87e5f8945": {
                "#name": "name",
                "Description": "The name of the configuration store.",
                "Required": false,
                "Type": "string"
              },
              "@removed_0cabef04daef4193a9626bb60ef2098c": {
                "#name": "type",
                "Description": "The resource type of the configuration store.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to get the next set of deleted configuration stores."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/deletedConfigurationStores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeletedConfigurationStore items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Operations_RegionalCheckNameAvailability (updated)
Description :  Checks whether the configuration store name is available for use.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_RegionalCheckNameAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "The location in which uniqueness will be verified."
      }
    },
    {
      "#name": "checkNameAvailabilityParameters",
      "Description": {
        "new": "The request body",
        "old": "The object containing information for the availability request."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
checkNameAvailabilityParameters:
{
Description: The request body ,
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 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 ,
}
,
]
,
}
,
}
ConfigurationStores_GetDeleted (updated)
Description :  Gets a deleted Azure app configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_GetDeleted",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "The location in which uniqueness will be verified."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_cbd5c64843ba45c4b3e1cf2302e12157": {
          "#name": "id",
          "Description": "The resource ID for the deleted configuration store.",
          "Required": false,
          "Type": "string"
        },
        "@removed_18562a73c324416281af85ff915dd8ae": {
          "#name": "name",
          "Description": "The name of the configuration store.",
          "Required": false,
          "Type": "string"
        },
        "@removed_aca7d47ecbe446b59c68a2c941afc3e9": {
          "#name": "type",
          "Description": "The resource type of the configuration store.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 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 ,
}
,
]
,
}
,
}
ConfigurationStores_PurgeDeleted (updated)
Description :  Permanently deletes the specified configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_PurgeDeleted",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "location",
      "Description": {
        "new": "The name of the Azure region.",
        "old": "The location in which uniqueness will be verified."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/locations/{location}/deletedConfigurationStores/{configStoreName}/purge
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
configStoreName:
{
Description: The name of the configuration store. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ConfigurationStores_ListByResourceGroup (updated)
Description :  Lists the configuration stores for a given resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a ConfigurationStore list operation.",
        "old": "The result of a request to list configuration stores."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ConfigurationStore items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_10c933e905204198ada1e4054b189b70": {
                "#name": "systemData",
                "Description": "Resource system metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
$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 ConfigurationStore items on this page ,
Required: True ,
}
[
{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
ConfigurationStores_Get (updated)
Description :  Gets the properties of the specified configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_4a36df3c3474443ab7495920e98a19a7": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ConfigurationStores_Create (updated)
Description :  Creates a configuration store with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    },
    {
      "configStoreCreationParameters": {
        "$properties": {
          "@removed_832ac9c9313f40d581e0e3511dfbcbaa": {
            "#name": "systemData",
            "Description": "Resource system metadata.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_2c266edb06454285b08415aea90b672d": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_3a949bc05b294b3fbe26be1fd9aa02dc": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
configStoreCreationParameters:
{
Description: The parameters for creating a configuration store. ,
Required: True ,
}
{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it. ,
}
{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ConfigurationStores_Update (updated)
Description :  Updates a configuration store with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_964763fcec0b47b582525f584108fc04": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_64d012ced1cf4839bfe98a1606a5b6ce": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry to update for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
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)

{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it. ,
}
{
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 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 ARM private link is allowed when the data plane resource requires private link. ,
Enum:
{
Enabled: 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 ,
telemetry:
{
Description: Property specifying the configuration of telemetry for this configuration store ,
Required: False ,
}
{
resourceId:
{
Description: Resource ID of a resource enabling telemetry collection ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
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 ,
}
,
sku:
{
Description: The sku of the configuration store. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the configuration store. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
ConfigurationStores_Delete (updated)
Description :  Deletes a configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Indicates how long the client should wait before polling the URL in the Location or Azure-AsyncOperation header."
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ 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: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
KeyValues_Get (updated)
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 ¶

⚶ Changes

{
  "#id": "KeyValues_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "key",
            "Description": {
              "new": "The primary identifier of a key-value.\nThe key is used in unison with the label to uniquely identify a key-value.",
              "old": "The primary identifier of a key-value.\r\nThe key is used in unison with the label to uniquely identify a key-value."
            }
          },
          {
            "#name": "label",
            "Description": {
              "new": "A value used to group key-values.\nThe label is used in unison with the key to uniquely identify a key-value.",
              "old": "A value used to group key-values.\r\nThe label is used in unison with the key to uniquely identify a key-value."
            }
          },
          {
            "#name": "contentType",
            "Description": {
              "new": "The content type of the key-value's value.\nProviding a proper content-type can enable transformations of values when they are retrieved by applications.",
              "old": "The content type of the key-value's value.\r\nProviding a proper content-type can enable transformations of values when they are retrieved by applications."
            }
          },
          {
            "#name": "locked",
            "Description": {
              "new": "A value indicating whether the key-value is locked.\nA locked key-value may not be modified until it is unlocked.",
              "old": "A value indicating whether the key-value is locked.\r\nA locked key-value may not be modified until it is unlocked."
            }
          }
        ],
        "@removed_8c53df5682024e5096d4ffdd2585005f": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_44b5a9910f93486e9038933a5ebbbe78": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_9f3a0a6d171c43fa948245bba4b565b1": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
keyValueName:
{
Description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 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 ,
}
,
]
,
}
,
}
KeyValues_CreateOrUpdate (updated)
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 ¶

⚶ Changes

{
  "#id": "KeyValues_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    },
    {
      "keyValueParameters": {
        "$properties": {
          "properties": [
            {
              "#name": "key",
              "Description": {
                "new": "The primary identifier of a key-value.\nThe key is used in unison with the label to uniquely identify a key-value.",
                "old": "The primary identifier of a key-value.\r\nThe key is used in unison with the label to uniquely identify a key-value."
              }
            },
            {
              "#name": "label",
              "Description": {
                "new": "A value used to group key-values.\nThe label is used in unison with the key to uniquely identify a key-value.",
                "old": "A value used to group key-values.\r\nThe label is used in unison with the key to uniquely identify a key-value."
              }
            },
            {
              "#name": "contentType",
              "Description": {
                "new": "The content type of the key-value's value.\nProviding a proper content-type can enable transformations of values when they are retrieved by applications.",
                "old": "The content type of the key-value's value.\r\nProviding a proper content-type can enable transformations of values when they are retrieved by applications."
              }
            },
            {
              "#name": "locked",
              "Description": {
                "new": "A value indicating whether the key-value is locked.\nA locked key-value may not be modified until it is unlocked.",
                "old": "A value indicating whether the key-value is locked.\r\nA locked key-value may not be modified until it is unlocked."
              }
            }
          ],
          "@removed_a0e4dc8ab0f74143b8cd0522af8f22de": {
            "#name": "id",
            "Description": "The resource ID.",
            "Required": false,
            "Type": "string"
          },
          "@removed_a6970d37cc8f4bf1bd9b4b2b7683adc5": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_0b7624e7215b4e719f462d7bd51af995": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "key",
            "Description": {
              "new": "The primary identifier of a key-value.\nThe key is used in unison with the label to uniquely identify a key-value.",
              "old": "The primary identifier of a key-value.\r\nThe key is used in unison with the label to uniquely identify a key-value."
            }
          },
          {
            "#name": "label",
            "Description": {
              "new": "A value used to group key-values.\nThe label is used in unison with the key to uniquely identify a key-value.",
              "old": "A value used to group key-values.\r\nThe label is used in unison with the key to uniquely identify a key-value."
            }
          },
          {
            "#name": "contentType",
            "Description": {
              "new": "The content type of the key-value's value.\nProviding a proper content-type can enable transformations of values when they are retrieved by applications.",
              "old": "The content type of the key-value's value.\r\nProviding a proper content-type can enable transformations of values when they are retrieved by applications."
            }
          },
          {
            "#name": "locked",
            "Description": {
              "new": "A value indicating whether the key-value is locked.\nA locked key-value may not be modified until it is unlocked.",
              "old": "A value indicating whether the key-value is locked.\r\nA locked key-value may not be modified until it is unlocked."
            }
          }
        ],
        "@removed_5c621c7e12664777b1ef8b9099debb0b": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_131c64504927490482e9aa87d99e1dd1": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bf8fc5c28c7a49de885ee66b4bc7ec18": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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 ,
}
{
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)

{
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 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 ,
}
,
]
,
}
,
}
KeyValues_Delete (updated)
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 ¶

⚶ Changes

{
  "#id": "KeyValues_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ConfigurationStores_ListKeys (updated)
Description :  Lists the access key for the specified configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_ListKeys",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ApiKey items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
$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 ApiKey items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByConfigurationStore (updated)
Description :  Lists all private endpoint connections for a configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByConfigurationStore",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateEndpointConnection list operation.",
        "old": "A list of private endpoint connections"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnection items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_6196cfc9b3d44199a0c3690d006d5bfa": {
                "#name": "id",
                "Description": "The resource ID.",
                "Required": false,
                "Type": "string"
              },
              "@removed_0e2947925a4442fc8a777e6ac308d448": {
                "#name": "name",
                "Description": "The name of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_4748603610904f11a568a9c9fc584502": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (updated)
Description :  Gets the specified private endpoint connection associated with the configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_a0e46cff7ad14f28b3dfa765ec691e9d": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_94e9c56fcc9446a3880a1a34efec3ae8": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_8b5536e29baf44eda5b84b07f3c2a838": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (updated)
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 ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    },
    {
      "privateEndpointConnection": {
        "$properties": {
          "@removed_b79e84e6cb3e4c59a5035acf5fbca0be": {
            "#name": "id",
            "Description": "The resource ID.",
            "Required": false,
            "Type": "string"
          },
          "@removed_9b034a4a19a840b4b8baf23033862235": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_73460e62218448a299108e60c98f50a3": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_e3cc6ac75fe6403f9d8bd2cf31c15839": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_2ea501123b594f11947a93d3887b46ed": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_ac6441e9b64e492c81387f3fbe013c82": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_21b1e1bdcb8d42fbb65a29d102a469d3": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_957cc3cea5b94f28ac76b4a30df167b7": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bb17a08ae60f4a348138e8490989b622": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
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)

{
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)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A private endpoint connection ,
}
{
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 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description :  Deletes a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
privateEndpointConnectionName:
{
Description: Private endpoint connection name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByConfigurationStore (updated)
Description :  Gets the private link resources that need to be created for a configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByConfigurationStore",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a PrivateLinkResource list operation.",
        "old": "A list of private link resources."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_339182a8002a4285bcba8a86a4731fd6": {
                "#name": "id",
                "Description": "The resource ID.",
                "Required": false,
                "Type": "string"
              },
              "@removed_d51fad2c8c324d5083b67a1762efacee": {
                "#name": "name",
                "Description": "The name of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_05e8a6f63dce4a86bd0f59174e3e49bf": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
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 link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (updated)
Description :  Gets a private link resource that need to be created for a configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_a74a0c36b76640ee9eee38e5cf6a97ea": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_e7cfd1aa31c34c5ebece064fd5042ff1": {
          "#name": "name",
          "Description": "The name of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_9b579549898f4cf2a4282410c019c423": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
groupName:
{
Description: The name of the private link resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 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 ,
}
,
]
,
}
,
}
ConfigurationStores_RegenerateKey (updated)
Description :  Regenerates an access key for the specified configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConfigurationStores_RegenerateKey",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/regenerateKey
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
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 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 ,
}
,
]
,
}
,
}
Replicas_ListByConfigurationStore (updated)
Description :  Lists the replicas for a given configuration store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_ListByConfigurationStore",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Replica list operation.",
        "old": "The result of a request to list replicas."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Replica items on this page",
            "old": "The collection value."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_33ae946e0aeb4786b7f14d93b381e94b": {
                "#name": "id",
                "Description": "The resource ID.",
                "Required": false,
                "Type": "string"
              },
              "@removed_986e3a48c06a4a0497700fdc8d5b84d7": {
                "#name": "name",
                "Description": "The name of the replica.",
                "Required": false,
                "Type": "string"
              },
              "@removed_c65a620374724922b8fd4ce05fc83ee7": {
                "#name": "type",
                "Description": "The type of the resource.",
                "Required": false,
                "Type": "string"
              },
              "@removed_84e4a19aef4c484e924562c3b9b16535": {
                "#name": "systemData",
                "Description": "Resource system metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URI that can be used to request the next set of paged results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
$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 Replica items on this page ,
Required: True ,
}
[
{
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 ,
}
,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Replicas_Get (updated)
Description :  Gets the properties of the specified replica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_9343235356b5472ab11ad2056b8971b1": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_f0ccc90a44c44f93a0e5eefa58557ba6": {
          "#name": "name",
          "Description": "The name of the replica.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0c0a879f8abc4e729e129a2945e61a89": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_8c49a23175e34346ad4b7c6e3148c024": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
location:
{
Description: The location of the replica. ,
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 ,
}
,
]
,
}
,
}
Replicas_Create (updated)
Description :  Creates a replica with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    },
    {
      "replicaCreationParameters": {
        "$properties": {
          "@removed_7ceee2c3d2b64a8c865489bdfe38192a": {
            "#name": "id",
            "Description": "The resource ID.",
            "Required": false,
            "Type": "string"
          },
          "@removed_96ab6b6b20c14f72b3a784d1ef5ded13": {
            "#name": "name",
            "Description": "The name of the replica.",
            "Required": false,
            "Type": "string"
          },
          "@removed_bece99375fa64b2a8a805307ab7f997b": {
            "#name": "type",
            "Description": "The type of the resource.",
            "Required": false,
            "Type": "string"
          },
          "@removed_b36263c535ef45d9b83bfe2fbb29f826": {
            "#name": "systemData",
            "Description": "Resource system metadata.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_d7fbca521db3473aa950c2171a23c8f1": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0556c0b319ac4f08bff55f193bf5ef85": {
          "#name": "name",
          "Description": "The name of the replica.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7020c19394d74c89bb77d2ad96a9e406": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_cb03c88273e149b69e31d20575d3b17c": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_5c0c7f6d405546d0862c92b4e5bffbdf": {
          "#name": "id",
          "Description": "The resource ID.",
          "Required": false,
          "Type": "string"
        },
        "@removed_3e94736a292d483294a0c28f51a35ea2": {
          "#name": "name",
          "Description": "The name of the replica.",
          "Required": false,
          "Type": "string"
        },
        "@removed_269db388995f4a1397b8f3287862230a": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        },
        "@removed_88f125b09c3a448ea335de03794b5ab7": {
          "#name": "systemData",
          "Description": "Resource system metadata.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
replicaCreationParameters:
{
Description: The parameters for creating a replica. ,
Required: True ,
}
{
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 ,
}
,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
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 ,
}
,
location:
{
Description: The location of the replica. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The replica resource. ,
}
{
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 ,
}
,
location:
{
Description: The location of the replica. ,
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 ,
}
,
]
,
}
,
}
Replicas_Delete (updated)
Description :  Deletes a replica.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replicas_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "The client API version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription. The value must be an UUID.",
        "old": "The Microsoft Azure subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group to which the container registry belongs."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL to query for status of the operation."
        }
      },
      {
        "@added_70b6497aa06343fa966499e46626b585": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
replicaName:
{
Description: The name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_Get (updated)
Description :  Gets the properties of the specified snapshot. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Snapshots_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_580ed5dc0acb4a739138a925539567ba": {
          "#name": "id",
          "Description": "The resource ID.",
          "Format": "arm-id",
          "Required": false,
          "Type": "string"
        },
        "@removed_5bfcdb0429c34f34a60742ffc85cd290": {
          "#name": "name",
          "Description": "The name of the snapshot.",
          "Required": false,
          "Type": "string"
        },
        "@removed_054698181b4c41dead0b4099327d9229": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
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 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 (updated)
Description :  Creates a snapshot. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Snapshots_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "@removed_afb163ce3aa5417f86b19159615ac455": {
          "#name": "id",
          "Description": "The resource ID.",
          "Format": "arm-id",
          "Required": false,
          "Type": "string"
        },
        "@removed_37f4bd8a8b544a6a8c111d644e5539e3": {
          "#name": "name",
          "Description": "The name of the snapshot.",
          "Required": false,
          "Type": "string"
        },
        "@removed_d6f54f8c82c34eed8921b9f5b953fc61": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_5a98692b74164898b0fa8ae4be351916": {
          "#name": "id",
          "Description": "The resource ID.",
          "Format": "arm-id",
          "Required": false,
          "Type": "string"
        },
        "@removed_f939811a43b64419a783f1b8e16b1957": {
          "#name": "name",
          "Description": "The name of the snapshot.",
          "Required": false,
          "Type": "string"
        },
        "@removed_724204fd4487427b832b23e73b95768b": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_a82c241d93ab4255b255b0bc303f0461": {
          "#name": "id",
          "Description": "The resource ID.",
          "Format": "arm-id",
          "Required": false,
          "Type": "string"
        },
        "@removed_b7a2544ea0a14c309ab9dcf0efd194c1": {
          "#name": "name",
          "Description": "The name of the snapshot.",
          "Required": false,
          "Type": "string"
        },
        "@removed_3eeb7f0a5e3347c995310306a123fb3b": {
          "#name": "type",
          "Description": "The type of the resource.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
body:
{
Description: The parameters for creating a snapshot. ,
Required: True ,
}
{
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 ARM tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
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 ARM tags. ,
Required: False ,
}
object ,
etag:
{
Description: A value representing the current state of the snapshot. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The snapshot resource. ,
}
{
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 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 ,
}
,
]
,
}
,
}