swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ConfigurationStores API
schemes:
- https
tags:
- name: ConfigurationStores
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores:
    get:
      tags:
      - ConfigurationStores
      description: Lists the configuration stores for a given subscription.
      operationId: microsoftAzureConfigurationstoresList
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: $skipToken
        in: query
        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
        type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ConfigurationStoreListResult'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_List:
          $ref: ./examples/ConfigurationStoresList.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Appconfiguration Configurationstores
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores
  : get:
      tags:
      - ConfigurationStores
      description: Lists the configuration stores for a given resource group.
      operationId: microsoftAzureConfigurationstoresListbyresourcegroup
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: $skipToken
        in: query
        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
        type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ConfigurationStoreListResult'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_ListByResourceGroup:
          $ref: ./examples/ConfigurationStoresListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
  : get:
      tags:
      - ConfigurationStores
      description: Gets the properties of the specified configuration store.
      operationId: microsoftAzureConfigurationstoresGet
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ConfigurationStore'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_Get:
          $ref: ./examples/ConfigurationStoresGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename
    put:
      tags:
      - ConfigurationStores
      description: Creates a configuration store with the specified parameters.
      operationId: microsoftAzureConfigurationstoresCreate
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: configStoreCreationParameters
        in: body
        description: The parameters for creating a configuration store.
        required: true
        schema:
          $ref: '#/definitions/ConfigurationStore'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ConfigurationStore'
        '201':
          description: The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.
          schema:
            $ref: '#/definitions/ConfigurationStore'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_Create:
          $ref: ./examples/ConfigurationStoresCreate.json
        ConfigurationStores_Create_With_Identity:
          $ref: ./examples/ConfigurationStoresCreateWithIdentity.json
        ConfigurationStores_Create_With_Local_Auth_Disabled:
          $ref: ./examples/ConfigurationStoresCreateWithLocalAuthDisabled.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename
    delete:
      tags:
      - ConfigurationStores
      description: Deletes a configuration store.
      operationId: microsoftAzureConfigurationstoresDelete
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
        '202':
          description: The request was successful; the operation will complete asynchronously.
        '204':
          description: No Content - the specified resource was not found.
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_Delete:
          $ref: ./examples/ConfigurationStoresDelete.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename
    patch:
      tags:
      - ConfigurationStores
      description: Updates a configuration store with the specified parameters.
      operationId: microsoftAzureConfigurationstoresUpdate
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: configStoreUpdateParameters
        in: body
        description: The parameters for updating a configuration store.
        required: true
        schema:
          $ref: '#/definitions/ConfigurationStoreUpdateParameters'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ConfigurationStore'
        '201':
          description: The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.
          schema:
            $ref: '#/definitions/ConfigurationStore'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_Update:
          $ref: ./examples/ConfigurationStoresUpdate.json
        ConfigurationStores_Update_With_Identity:
          $ref: ./examples/ConfigurationStoresUpdateWithIdentity.json
        ConfigurationStores_Update_Disable_Local_Auth:
          $ref: ./examples/ConfigurationStoresUpdateDisableLocalAuth.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys
  : post:
      tags:
      - ConfigurationStores
      description: Lists the access key for the specified configuration store.
      operationId: microsoftAzureConfigurationstoresListkeys
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: $skipToken
        in: query
        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
        type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ApiKeyListResult'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_ListKeys:
          $ref: ./examples/ConfigurationStoresListKeys.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Listkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/regenerateKey
  : post:
      tags:
      - ConfigurationStores
      description: Regenerates an access key for the specified configuration store.
      operationId: microsoftAzureConfigurationstoresRegeneratekey
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ConfigStoreNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: regenerateKeyParameters
        in: body
        description: The parameters for regenerating an access key.
        required: true
        schema:
          $ref: '#/definitions/RegenerateKeyParameters'
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          schema:
            $ref: '#/definitions/ApiKey'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        ConfigurationStores_RegenerateKey:
          $ref: ./examples/ConfigurationStoresRegenerateKey.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appconfiguration Configurationstores Configstorename Regeneratekey
definitions:
  EncryptionProperties:
    type: object
    description: The encryption settings for a configuration store.
    properties:
      keyVaultProperties:
        $ref: '#/definitions/KeyVaultProperties'
        description: Key vault properties.
  UserIdentity:
    type: object
    description: A resource identity that is managed by the user of the service.
    properties:
      principalId:
        description: The principal ID of the user-assigned identity.
        type: string
        readOnly: true
      clientId:
        description: The client ID of the user-assigned identity.
        type: string
        readOnly: true
  PrivateEndpointConnectionReference:
    type: object
    description: A reference to a related private endpoint connection.
    properties:
      id:
        description: The resource ID.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/PrivateEndpointConnectionProperties'
        description: The properties of a private endpoint connection.
        x-ms-client-flatten: true
  PrivateEndpoint:
    type: object
    description: Private endpoint which a connection belongs to.
    properties:
      id:
        description: The resource Id for private endpoint
        type: string
  ConfigurationStoreListResult:
    description: The result of a request to list configuration stores.
    type: object
    properties:
      value:
        description: The collection value.
        type: array
        items:
          $ref: '#/definitions/ConfigurationStore'
      nextLink:
        description: The URI that can be used to request the next set of paged results.
        type: string
  ErrorDetails:
    description: The details of the error.
    properties:
      code:
        description: Error code.
        type: string
        readOnly: true
      message:
        description: Error message indicating why the operation failed.
        type: string
        readOnly: true
      additionalInfo:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ErrorAdditionalInfo'
        x-ms-identifiers: []
        description: The error additional info.
  Sku:
    type: object
    required:
    - name
    properties:
      name:
        description: The SKU name of the configuration store.
        type: string
    description: Describes a configuration store SKU.
  ConfigurationStore:
    description: The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.
    required:
    - location
    - sku
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
    properties:
      identity:
        $ref: '#/definitions/ResourceIdentity'
        description: The managed identity information, if configured.
      properties:
        $ref: '#/definitions/ConfigurationStoreProperties'
        description: The properties of a configuration store.
        x-ms-client-flatten: true
      sku:
        $ref: '#/definitions/Sku'
        description: The sku of the configuration store.
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Resource system metadata.
  ConfigurationStoreProperties:
    description: The properties of a configuration store.
    type: object
    properties:
      provisioningState:
        description: The provisioning state of the configuration store.
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Failed
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      creationDate:
        format: date-time
        description: The creation date of configuration store.
        type: string
        readOnly: true
      endpoint:
        description: The DNS endpoint where the configuration store API will be available.
        type: string
        readOnly: true
      encryption:
        $ref: '#/definitions/EncryptionProperties'
        description: The encryption settings of the configuration store.
      privateEndpointConnections:
        description: The list of private endpoint connections that are set up for this resource.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/PrivateEndpointConnectionReference'
      publicNetworkAccess:
        description: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: PublicNetworkAccess
          modelAsString: true
      disableLocalAuth:
        type: boolean
        default: false
        description: Disables all authentication methods other than AAD authentication.
      softDeleteRetentionInDays:
        type: integer
        format: int32
        default: 7
        description: The amount of time in days that the configuration store will be retained when it is soft deleted.
      enablePurgeProtection:
        type: boolean
        default: false
        description: Property specifying whether protection against purge is enabled for this configuration store.
      createMode:
        type: string
        description: Indicates whether the configuration store need to be recovered.
        enum:
        - Recover
        - Default
        x-ms-enum:
          name: CreateMode
          modelAsString: false
        x-ms-mutability:
        - create
  PrivateLinkServiceConnectionState:
    description: The state of a private link service connection.
    type: object
    properties:
      status:
        enum:
        - Pending
        - Approved
        - Rejected
        - Disconnected
        type: string
        description: The private link service connection status.
        x-ms-enum:
          name: ConnectionStatus
          modelAsString: true
      description:
        type: string
        description: The private link service connection description.
      actionsRequired:
        enum:
        - None
        - Recreate
        type: string
        readOnly: true
        description: Any action that is required beyond basic workflow (approve/ reject/ disconnect)
        x-ms-enum:
          name: ActionsRequired
          modelAsString: true
  ErrorAdditionalInfo:
    properties:
      type:
        readOnly: true
        type: string
        description: The additional info type.
      info:
        readOnly: true
        type: object
        description: The additional info.
    description: The resource management error additional info.
  ApiKey:
    description: An API key used for authenticating with a configuration store endpoint.
    type: object
    properties:
      id:
        description: The key ID.
        type: string
        readOnly: true
      name:
        description: A name for the key describing its usage.
        type: string
        readOnly: true
      value:
        description: The value of the key that is used for authentication purposes.
        type: string
        readOnly: true
      connectionString:
        description: A connection string that can be used by supporting clients for authentication.
        type: string
        readOnly: true
      lastModified:
        format: date-time
        description: The last time any of the key's properties were modified.
        type: string
        readOnly: true
      readOnly:
        description: Whether this key can only be used for read operations.
        type: boolean
        readOnly: true
  PrivateEndpointConnectionProperties:
    type: object
    description: Properties of a private endpoint connection.
    properties:
      provisioningState:
        enum:
        - Creating
        - Updating
        - Deleting
        - Succeeded
        - Failed
        - Canceled
        type: string
        readOnly: true
        description: The provisioning status of the private endpoint connection.
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      privateEndpoint:
        $ref: '#/definitions/PrivateEndpoint'
        description: The resource of private endpoint.
      privateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
        description: A collection of information about the state of the connection between service consumer and provider.
    required:
    - privateLinkServiceConnectionState
  ResourceIdentity:
    type: object
    description: An identity that can be associated with a resource.
    properties:
      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
        - SystemAssigned
        - UserAssigned
        - SystemAssigned, UserAssigned
        type: string
        x-ms-enum:
          name: IdentityType
          modelAsString: true
      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}''.'
        type: object
        additionalProperties:
          $ref: '#/definitions/UserIdentity'
      principalId:
        description: The principal id of the identity. This property will only be provided for a system-assigned identity.
        type: string
        readOnly: true
      tenantId:
        description: The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
        type: string
        readOnly: true
  ConfigurationStoreUpdateParameters:
    description: The parameters for updating a configuration store.
    type: object
    properties:
      properties:
        $ref: '#/definitions/ConfigurationStorePropertiesUpdateParameters'
        description: The properties for updating a configuration store.
        x-ms-client-flatten: true
      identity:
        $ref: '#/definitions/ResourceIdentity'
        description: The managed identity information for the configuration store.
      sku:
        $ref: '#/definitions/Sku'
        description: The SKU of the configuration store.
      tags:
        description: The ARM resource tags.
        type: object
        additionalProperties:
          type: string
  KeyVaultProperties:
    type: object
    description: Settings concerning key vault encryption for a configuration store.
    properties:
      keyIdentifier:
        description: The URI of the key vault key used to encrypt data.
        type: string
      identityClientId:
        description: The client id of the identity which will be used to access key vault.
        type: string
  ApiKeyListResult:
    description: The result of a request to list API keys.
    type: object
    properties:
      value:
        description: The collection value.
        type: array
        items:
          $ref: '#/definitions/ApiKey'
      nextLink:
        description: The URI that can be used to request the next set of paged results.
        type: string
  ConfigurationStorePropertiesUpdateParameters:
    description: The properties for updating a configuration store.
    type: object
    properties:
      encryption:
        $ref: '#/definitions/EncryptionProperties'
        description: The encryption settings of the configuration store.
      disableLocalAuth:
        type: boolean
        description: Disables all authentication methods other than AAD authentication.
      publicNetworkAccess:
        description: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: PublicNetworkAccess
          modelAsString: true
  RegenerateKeyParameters:
    description: The parameters used to regenerate an API key.
    type: object
    properties:
      id:
        description: The id of the key to regenerate.
        type: string
  ErrorResponse:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        description: The details of the error.
        $ref: '#/definitions/ErrorDetails'
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: The client API version.
    required: true
    type: string
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The name of the resource group to which the container registry belongs.
    required: true
    type: string
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Microsoft Azure subscription ID.
    required: true
    type: string
  ConfigStoreNameParameter:
    name: configStoreName
    in: path
    description: The name of the configuration store.
    required: true
    type: string
    maxLength: 50
    minLength: 5
    pattern: ^[a-zA-Z0-9_-]*$
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'