Configuration Stores - Update

Updates a configuration store with the specified parameters.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}?api-version=2019-10-01

URI Parameters

Name In Required Type Description
configStoreName
path True
  • string

The name of the configuration store.

Regex pattern: ^[a-zA-Z0-9_-]*$

resourceGroupName
path True
  • string

The name of the resource group to which the container registry belongs.

subscriptionId
path True
  • string

The Microsoft Azure subscription ID.

api-version
query True
  • string

The client API version.

Request Body

Name Type Description
identity

The managed identity information for the configuration store.

sku

The SKU of the configuration store.

tags
  • object

The ARM resource tags.

Responses

Name Type Description
200 OK

The request was successful; the request was well-formed and received properly.

201 Created

The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.

Other Status Codes

Error response describing why the operation failed

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ConfigurationStores_Update
ConfigurationStores_Update_WithIdentity

ConfigurationStores_Update

Sample Request

PATCH https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso?api-version=2019-10-01
{
  "tags": {
    "Category": "Marketing"
  },
  "sku": {
    "name": "Standard"
  }
}

Sample Response

{
  "type": "Microsoft.AppConfiguration/configurationStores",
  "properties": {
    "provisioningState": "Succeeded",
    "creationDate": "2018-04-24T16:30:55+00:00",
    "endpoint": "https://contoso.azconfig.io"
  },
  "sku": {
    "name": "Standard"
  },
  "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
  "name": "contoso",
  "location": "westus",
  "tags": {
    "Category": "Marketing"
  }
}
{
  "type": "Microsoft.AppConfiguration/configurationStores",
  "properties": {
    "provisioningState": "Updating",
    "creationDate": "2018-04-24T16:30:55+00:00",
    "endpoint": "https://contoso.azconfig.io"
  },
  "sku": {
    "name": "Standard"
  },
  "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
  "name": "contoso",
  "location": "westus",
  "tags": {
    "Category": "Marketing"
  }
}

ConfigurationStores_Update_WithIdentity

Sample Request

PATCH https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso?api-version=2019-10-01
{
  "tags": {
    "Category": "Marketing"
  },
  "sku": {
    "name": "Standard"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {}
    }
  }
}

Sample Response

{
  "type": "Microsoft.AppConfiguration/configurationStores",
  "properties": {
    "provisioningState": "Succeeded",
    "creationDate": "2018-04-24T16:30:55+00:00",
    "endpoint": "https://contoso.azconfig.io"
  },
  "sku": {
    "name": "Standard"
  },
  "identity": {
    "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
    "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
        "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC",
        "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"
      }
    }
  },
  "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
  "name": "contoso",
  "location": "westus",
  "tags": {
    "Category": "Marketing"
  }
}
{
  "type": "Microsoft.AppConfiguration/configurationStores",
  "properties": {
    "provisioningState": "Updating",
    "creationDate": "2018-04-24T16:30:55+00:00",
    "endpoint": "https://contoso.azconfig.io"
  },
  "sku": {
    "name": "Standard"
  },
  "identity": {
    "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
    "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
        "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC",
        "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"
      }
    }
  },
  "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
  "name": "contoso",
  "location": "westus",
  "tags": {
    "Category": "Marketing"
  }
}

Definitions

ConfigurationStore

The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.

ConfigurationStoreUpdateParameters

The parameters for updating a configuration store.

Error

AppConfiguration error object.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.

ProvisioningState

The provisioning state of the configuration store.

ResourceIdentity
Sku

Describes a configuration store SKU.

UserIdentity

ConfigurationStore

The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.

Name Type Description
id
  • string

The resource ID.

identity

The managed identity information, if configured.

location
  • string

The location of the resource. This cannot be changed after the resource is created.

name
  • string

The name of the resource.

properties.creationDate
  • string

The creation date of configuration store.

properties.endpoint
  • string

The DNS endpoint where the configuration store API will be available.

properties.provisioningState

The provisioning state of the configuration store.

sku

The sku of the configuration store.

tags
  • object

The tags of the resource.

type
  • string

The type of the resource.

ConfigurationStoreUpdateParameters

The parameters for updating a configuration store.

Name Type Description
identity

The managed identity information for the configuration store.

sku

The SKU of the configuration store.

tags
  • object

The ARM resource tags.

Error

AppConfiguration error object.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ProvisioningState

The provisioning state of the configuration store.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ResourceIdentity

Name Type Description
principalId
  • string

The principal id of the identity. This property will only be provided for a system-assigned identity.

tenantId
  • string

The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.

type

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.

userAssignedIdentities

The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Sku

Describes a configuration store SKU.

Name Type Description
name
  • string

The SKU name of the configuration store.

UserIdentity

Name Type Description
clientId
  • string

The client ID of the user-assigned identity.

principalId
  • string

The principal ID of the user-assigned identity.