Updates a configuration store with the specified parameters.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}?api-version=2023-03-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
|
ResourceIdentity
|
The managed identity information for the configuration store.
|
properties.disableLocalAuth
|
boolean
|
Disables all authentication methods other than AAD authentication.
|
properties.enablePurgeProtection
|
boolean
|
Property specifying whether protection against purge is enabled for this configuration store.
|
properties.encryption
|
EncryptionProperties
|
The encryption settings of the configuration store.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
|
sku
|
Sku
|
The SKU of the configuration store.
|
tags
|
object
|
The ARM resource tags.
|
Responses
Name |
Type |
Description |
200 OK
|
ConfigurationStore
|
The request was successful; the request was well-formed and received properly.
|
201 Created
|
ConfigurationStore
|
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
|
ErrorResponse
|
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
Sample request
PATCH https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso?api-version=2023-03-01
{
"tags": {
"Category": "Marketing"
},
"sku": {
"name": "Standard"
}
}
import com.azure.resourcemanager.appconfiguration.models.ConfigurationStore;
import com.azure.resourcemanager.appconfiguration.models.Sku;
import java.util.HashMap;
import java.util.Map;
/** Samples for ConfigurationStores Update. */
public final class Main {
/*
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json
*/
/**
* Sample code: ConfigurationStores_Update.
*
* @param manager Entry point to AppConfigurationManager.
*/
public static void configurationStoresUpdate(
com.azure.resourcemanager.appconfiguration.AppConfigurationManager manager) {
ConfigurationStore resource =
manager
.configurationStores()
.getByResourceGroupWithResponse("myResourceGroup", "contoso", com.azure.core.util.Context.NONE)
.getValue();
resource.update().withTags(mapOf("Category", "Marketing")).withSku(new Sku().withName("Standard")).apply();
}
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.appconfiguration import AppConfigurationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-appconfiguration
# USAGE
python configuration_stores_update.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AppConfigurationManagementClient(
credential=DefaultAzureCredential(),
subscription_id="c80fb759-c965-4c6a-9110-9b2b2d038882",
)
response = client.configuration_stores.begin_update(
resource_group_name="myResourceGroup",
config_store_name="contoso",
config_store_update_parameters={"sku": {"name": "Standard"}, "tags": {"Category": "Marketing"}},
).result()
print(response)
# x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armappconfiguration_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json
func ExampleConfigurationStoresClient_BeginUpdate_configurationStoresUpdate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
SKU: &armappconfiguration.SKU{
Name: to.Ptr("Standard"),
},
Tags: map[string]*string{
"Category": to.Ptr("Marketing"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// Name: to.Ptr("contoso"),
// Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "Category": to.Ptr("Marketing"),
// },
// Properties: &armappconfiguration.ConfigurationStoreProperties{
// CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// DisableLocalAuth: to.Ptr(false),
// Encryption: &armappconfiguration.EncryptionProperties{
// KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// },
// },
// Endpoint: to.Ptr("https://contoso.azconfig.io"),
// PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// },
// ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// },
// SKU: &armappconfiguration.SKU{
// Name: to.Ptr("Standard"),
// },
// SystemData: &armappconfiguration.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// CreatedBy: to.Ptr("foo@contoso.com"),
// CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// LastModifiedBy: to.Ptr("foo@contoso.com"),
// LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates a configuration store with the specified parameters.
*
* @summary Updates a configuration store with the specified parameters.
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json
*/
async function configurationStoresUpdate() {
const subscriptionId =
process.env["APPCONFIGURATION_SUBSCRIPTION_ID"] || "c80fb759-c965-4c6a-9110-9b2b2d038882";
const resourceGroupName = process.env["APPCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroup";
const configStoreName = "contoso";
const configStoreUpdateParameters = {
sku: { name: "Standard" },
tags: { category: "Marketing" },
};
const credential = new DefaultAzureCredential();
const client = new AppConfigurationManagementClient(credential, subscriptionId);
const result = await client.configurationStores.beginUpdateAndWait(
resourceGroupName,
configStoreName,
configStoreUpdateParameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppConfiguration;
using Azure.ResourceManager.AppConfiguration.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdate.json
// this example is just showing the usage of "ConfigurationStores_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this AppConfigurationStoreResource created on azure
// for more information of creating AppConfigurationStoreResource, please refer to the document of AppConfigurationStoreResource
string subscriptionId = "c80fb759-c965-4c6a-9110-9b2b2d038882";
string resourceGroupName = "myResourceGroup";
string configStoreName = "contoso";
ResourceIdentifier appConfigurationStoreResourceId = AppConfigurationStoreResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, configStoreName);
AppConfigurationStoreResource appConfigurationStore = client.GetAppConfigurationStoreResource(appConfigurationStoreResourceId);
// invoke the operation
AppConfigurationStorePatch patch = new AppConfigurationStorePatch()
{
SkuName = "Standard",
Tags =
{
["Category"] = "Marketing",
},
};
ArmOperation<AppConfigurationStoreResource> lro = await appConfigurationStore.UpdateAsync(WaitUntil.Completed, patch);
AppConfigurationStoreResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppConfigurationStoreData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Succeeded",
"creationDate": "2018-04-24T16:30:55+00:00",
"endpoint": "https://contoso.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"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",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
"name": "contoso",
"location": "westus",
"tags": {
"Category": "Marketing"
}
}
ConfigurationStores_Update_Disable_Local_Auth
Sample request
PATCH https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso?api-version=2023-03-01
{
"sku": {
"name": "Standard"
},
"properties": {
"disableLocalAuth": true
}
}
import com.azure.resourcemanager.appconfiguration.models.ConfigurationStore;
import com.azure.resourcemanager.appconfiguration.models.Sku;
import java.util.HashMap;
import java.util.Map;
/** Samples for ConfigurationStores Update. */
public final class Main {
/*
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json
*/
/**
* Sample code: ConfigurationStores_Update_Disable_Local_Auth.
*
* @param manager Entry point to AppConfigurationManager.
*/
public static void configurationStoresUpdateDisableLocalAuth(
com.azure.resourcemanager.appconfiguration.AppConfigurationManager manager) {
ConfigurationStore resource =
manager
.configurationStores()
.getByResourceGroupWithResponse("myResourceGroup", "contoso", com.azure.core.util.Context.NONE)
.getValue();
resource.update().withSku(new Sku().withName("Standard")).withDisableLocalAuth(true).apply();
}
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.appconfiguration import AppConfigurationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-appconfiguration
# USAGE
python configuration_stores_update_disable_local_auth.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AppConfigurationManagementClient(
credential=DefaultAzureCredential(),
subscription_id="c80fb759-c965-4c6a-9110-9b2b2d038882",
)
response = client.configuration_stores.begin_update(
resource_group_name="myResourceGroup",
config_store_name="contoso",
config_store_update_parameters={"properties": {"disableLocalAuth": True}, "sku": {"name": "Standard"}},
).result()
print(response)
# x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armappconfiguration_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json
func ExampleConfigurationStoresClient_BeginUpdate_configurationStoresUpdateDisableLocalAuth() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
Properties: &armappconfiguration.ConfigurationStorePropertiesUpdateParameters{
DisableLocalAuth: to.Ptr(true),
},
SKU: &armappconfiguration.SKU{
Name: to.Ptr("Standard"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// Name: to.Ptr("contoso"),
// Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// },
// Properties: &armappconfiguration.ConfigurationStoreProperties{
// CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// DisableLocalAuth: to.Ptr(true),
// Encryption: &armappconfiguration.EncryptionProperties{
// KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// },
// },
// Endpoint: to.Ptr("https://contoso.azconfig.io"),
// PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// },
// ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// },
// SKU: &armappconfiguration.SKU{
// Name: to.Ptr("Standard"),
// },
// SystemData: &armappconfiguration.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// CreatedBy: to.Ptr("foo@contoso.com"),
// CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// LastModifiedBy: to.Ptr("foo@contoso.com"),
// LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates a configuration store with the specified parameters.
*
* @summary Updates a configuration store with the specified parameters.
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json
*/
async function configurationStoresUpdateDisableLocalAuth() {
const subscriptionId =
process.env["APPCONFIGURATION_SUBSCRIPTION_ID"] || "c80fb759-c965-4c6a-9110-9b2b2d038882";
const resourceGroupName = process.env["APPCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroup";
const configStoreName = "contoso";
const configStoreUpdateParameters = {
disableLocalAuth: true,
sku: { name: "Standard" },
};
const credential = new DefaultAzureCredential();
const client = new AppConfigurationManagementClient(credential, subscriptionId);
const result = await client.configurationStores.beginUpdateAndWait(
resourceGroupName,
configStoreName,
configStoreUpdateParameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppConfiguration;
using Azure.ResourceManager.AppConfiguration.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateDisableLocalAuth.json
// this example is just showing the usage of "ConfigurationStores_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this AppConfigurationStoreResource created on azure
// for more information of creating AppConfigurationStoreResource, please refer to the document of AppConfigurationStoreResource
string subscriptionId = "c80fb759-c965-4c6a-9110-9b2b2d038882";
string resourceGroupName = "myResourceGroup";
string configStoreName = "contoso";
ResourceIdentifier appConfigurationStoreResourceId = AppConfigurationStoreResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, configStoreName);
AppConfigurationStoreResource appConfigurationStore = client.GetAppConfigurationStoreResource(appConfigurationStoreResourceId);
// invoke the operation
AppConfigurationStorePatch patch = new AppConfigurationStorePatch()
{
SkuName = "Standard",
DisableLocalAuth = true,
};
ArmOperation<AppConfigurationStoreResource> lro = await appConfigurationStore.UpdateAsync(WaitUntil.Completed, patch);
AppConfigurationStoreResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppConfigurationStoreData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Succeeded",
"creationDate": "2018-04-24T16:30:55+00:00",
"endpoint": "https://contoso.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": true,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
"name": "contoso",
"location": "westus",
"tags": {}
}
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Updating",
"creationDate": "2018-04-24T16:30:55+00:00",
"endpoint": "https://contoso.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": true,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso",
"name": "contoso",
"location": "westus",
"tags": {}
}
ConfigurationStores_Update_With_Identity
Sample request
PATCH https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso?api-version=2023-03-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": {}
}
}
}
import com.azure.resourcemanager.appconfiguration.models.ConfigurationStore;
import com.azure.resourcemanager.appconfiguration.models.IdentityType;
import com.azure.resourcemanager.appconfiguration.models.ResourceIdentity;
import com.azure.resourcemanager.appconfiguration.models.Sku;
import com.azure.resourcemanager.appconfiguration.models.UserIdentity;
import java.util.HashMap;
import java.util.Map;
/** Samples for ConfigurationStores Update. */
public final class Main {
/*
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json
*/
/**
* Sample code: ConfigurationStores_Update_With_Identity.
*
* @param manager Entry point to AppConfigurationManager.
*/
public static void configurationStoresUpdateWithIdentity(
com.azure.resourcemanager.appconfiguration.AppConfigurationManager manager) {
ConfigurationStore resource =
manager
.configurationStores()
.getByResourceGroupWithResponse("myResourceGroup", "contoso", com.azure.core.util.Context.NONE)
.getValue();
resource
.update()
.withTags(mapOf("Category", "Marketing"))
.withIdentity(
new ResourceIdentity()
.withType(IdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED)
.withUserAssignedIdentities(
mapOf(
"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2",
new UserIdentity())))
.withSku(new Sku().withName("Standard"))
.apply();
}
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.appconfiguration import AppConfigurationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-appconfiguration
# USAGE
python configuration_stores_update_with_identity.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AppConfigurationManagementClient(
credential=DefaultAzureCredential(),
subscription_id="c80fb759-c965-4c6a-9110-9b2b2d038882",
)
response = client.configuration_stores.begin_update(
resource_group_name="myResourceGroup",
config_store_name="contoso",
config_store_update_parameters={
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {}
},
},
"sku": {"name": "Standard"},
"tags": {"Category": "Marketing"},
},
).result()
print(response)
# x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armappconfiguration_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1f22d4dbd99b0fe347ad79e79d4eb1ed44a87291/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json
func ExampleConfigurationStoresClient_BeginUpdate_configurationStoresUpdateWithIdentity() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationStoresClient().BeginUpdate(ctx, "myResourceGroup", "contoso", armappconfiguration.ConfigurationStoreUpdateParameters{
Identity: &armappconfiguration.ResourceIdentity{
Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
"/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {},
},
},
SKU: &armappconfiguration.SKU{
Name: to.Ptr("Standard"),
},
Tags: map[string]*string{
"Category": to.Ptr("Marketing"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationStore = armappconfiguration.ConfigurationStore{
// Name: to.Ptr("contoso"),
// Type: to.Ptr("Microsoft.AppConfiguration/configurationStores"),
// ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "Category": to.Ptr("Marketing"),
// },
// Identity: &armappconfiguration.ResourceIdentity{
// Type: to.Ptr(armappconfiguration.IdentityTypeSystemAssignedUserAssigned),
// PrincipalID: to.Ptr("AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"),
// TenantID: to.Ptr("BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"),
// UserAssignedIdentities: map[string]*armappconfiguration.UserIdentity{
// "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": &armappconfiguration.UserIdentity{
// ClientID: to.Ptr("CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC"),
// PrincipalID: to.Ptr("DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"),
// },
// },
// },
// Properties: &armappconfiguration.ConfigurationStoreProperties{
// CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// DisableLocalAuth: to.Ptr(false),
// Encryption: &armappconfiguration.EncryptionProperties{
// KeyVaultProperties: &armappconfiguration.KeyVaultProperties{
// },
// },
// Endpoint: to.Ptr("https://contoso.azconfig.io"),
// PrivateEndpointConnections: []*armappconfiguration.PrivateEndpointConnectionReference{
// },
// ProvisioningState: to.Ptr(armappconfiguration.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armappconfiguration.PublicNetworkAccessDisabled),
// },
// SKU: &armappconfiguration.SKU{
// Name: to.Ptr("Standard"),
// },
// SystemData: &armappconfiguration.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// CreatedBy: to.Ptr("foo@contoso.com"),
// CreatedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55.000Z"); return t}()),
// LastModifiedBy: to.Ptr("foo@contoso.com"),
// LastModifiedByType: to.Ptr(armappconfiguration.CreatedByTypeUser),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates a configuration store with the specified parameters.
*
* @summary Updates a configuration store with the specified parameters.
* x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json
*/
async function configurationStoresUpdateWithIdentity() {
const subscriptionId =
process.env["APPCONFIGURATION_SUBSCRIPTION_ID"] || "c80fb759-c965-4c6a-9110-9b2b2d038882";
const resourceGroupName = process.env["APPCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroup";
const configStoreName = "contoso";
const configStoreUpdateParameters = {
identity: {
type: "SystemAssigned, UserAssigned",
userAssignedIdentities: {
"/subscriptions/c80fb759C9654c6a91109b2b2d038882/resourcegroups/myResourceGroup1/providers/MicrosoftManagedIdentity/userAssignedIdentities/identity2":
{},
},
},
sku: { name: "Standard" },
tags: { category: "Marketing" },
};
const credential = new DefaultAzureCredential();
const client = new AppConfigurationManagementClient(credential, subscriptionId);
const result = await client.configurationStores.beginUpdateAndWait(
resourceGroupName,
configStoreName,
configStoreUpdateParameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.AppConfiguration;
using Azure.ResourceManager.AppConfiguration.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/examples/ConfigurationStoresUpdateWithIdentity.json
// this example is just showing the usage of "ConfigurationStores_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this AppConfigurationStoreResource created on azure
// for more information of creating AppConfigurationStoreResource, please refer to the document of AppConfigurationStoreResource
string subscriptionId = "c80fb759-c965-4c6a-9110-9b2b2d038882";
string resourceGroupName = "myResourceGroup";
string configStoreName = "contoso";
ResourceIdentifier appConfigurationStoreResourceId = AppConfigurationStoreResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, configStoreName);
AppConfigurationStoreResource appConfigurationStore = client.GetAppConfigurationStoreResource(appConfigurationStoreResourceId);
// invoke the operation
AppConfigurationStorePatch patch = new AppConfigurationStorePatch()
{
Identity = new ManagedServiceIdentity("SystemAssigned, UserAssigned")
{
UserAssignedIdentities =
{
[new ResourceIdentifier("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2")] = new UserAssignedIdentity(),
},
},
SkuName = "Standard",
Tags =
{
["Category"] = "Marketing",
},
};
ArmOperation<AppConfigurationStoreResource> lro = await appConfigurationStore.UpdateAsync(WaitUntil.Completed, patch);
AppConfigurationStoreResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppConfigurationStoreData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"type": "Microsoft.AppConfiguration/configurationStores",
"properties": {
"provisioningState": "Succeeded",
"creationDate": "2018-04-24T16:30:55+00:00",
"endpoint": "https://contoso.azconfig.io",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"identity": {
"principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
"tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
"type": "SystemAssigned, 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",
"encryption": {
"keyVaultProperties": {
"keyIdentifier": null,
"identityClientId": null
}
},
"disableLocalAuth": false,
"privateEndpointConnections": [],
"publicNetworkAccess": "Disabled"
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
},
"sku": {
"name": "Standard"
},
"identity": {
"principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
"tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
"type": "SystemAssigned, 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
Name |
Description |
ActionsRequired
|
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
|
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.
|
ConnectionStatus
|
The private link service connection status.
|
createdByType
|
The type of identity that created the resource.
|
CreateMode
|
Indicates whether the configuration store need to be recovered.
|
EncryptionProperties
|
The encryption settings for a configuration store.
|
ErrorAdditionalInfo
|
The resource management error additional info.
|
ErrorDetails
|
The details of the error.
|
ErrorResponse
|
Error response indicates that the service is not able to process the incoming request. The reason is provided in the 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.
|
KeyVaultProperties
|
Settings concerning key vault encryption for a configuration store.
|
PrivateEndpoint
|
Private endpoint which a connection belongs to.
|
PrivateEndpointConnectionReference
|
A reference to a related private endpoint connection.
|
PrivateLinkServiceConnectionState
|
The state of a private link service connection.
|
ProvisioningState
|
The provisioning state of the configuration store.
|
PublicNetworkAccess
|
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
|
ResourceIdentity
|
An identity that can be associated with a resource.
|
Sku
|
Describes a configuration store SKU.
|
systemData
|
Metadata pertaining to creation and last modification of the resource.
|
UserIdentity
|
A resource identity that is managed by the user of the service.
|
ActionsRequired
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
Name |
Type |
Description |
None
|
string
|
|
Recreate
|
string
|
|
ConfigurationStore
The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.
Name |
Type |
Default value |
Description |
id
|
string
|
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
identity
|
ResourceIdentity
|
|
The managed identity information, if configured.
|
location
|
string
|
|
The geo-location where the resource lives
|
name
|
string
|
|
The name of the resource
|
properties.createMode
|
CreateMode
|
|
Indicates whether the configuration store need to be recovered.
|
properties.creationDate
|
string
|
|
The creation date of configuration store.
|
properties.disableLocalAuth
|
boolean
|
False
|
Disables all authentication methods other than AAD authentication.
|
properties.enablePurgeProtection
|
boolean
|
False
|
Property specifying whether protection against purge is enabled for this configuration store.
|
properties.encryption
|
EncryptionProperties
|
|
The encryption settings of the configuration store.
|
properties.endpoint
|
string
|
|
The DNS endpoint where the configuration store API will be available.
|
properties.privateEndpointConnections
|
PrivateEndpointConnectionReference[]
|
|
The list of private endpoint connections that are set up for this resource.
|
properties.provisioningState
|
ProvisioningState
|
|
The provisioning state of the configuration store.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
|
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
|
properties.softDeleteRetentionInDays
|
integer
|
7
|
The amount of time in days that the configuration store will be retained when it is soft deleted.
|
sku
|
Sku
|
|
The sku of the configuration store.
|
systemData
|
systemData
|
|
Resource system metadata.
|
tags
|
object
|
|
Resource tags.
|
type
|
string
|
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
ConfigurationStoreUpdateParameters
The parameters for updating a configuration store.
Name |
Type |
Description |
identity
|
ResourceIdentity
|
The managed identity information for the configuration store.
|
properties.disableLocalAuth
|
boolean
|
Disables all authentication methods other than AAD authentication.
|
properties.enablePurgeProtection
|
boolean
|
Property specifying whether protection against purge is enabled for this configuration store.
|
properties.encryption
|
EncryptionProperties
|
The encryption settings of the configuration store.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
|
sku
|
Sku
|
The SKU of the configuration store.
|
tags
|
object
|
The ARM resource tags.
|
ConnectionStatus
The private link service connection status.
Name |
Type |
Description |
Approved
|
string
|
|
Disconnected
|
string
|
|
Pending
|
string
|
|
Rejected
|
string
|
|
createdByType
The type of identity that created the resource.
Name |
Type |
Description |
Application
|
string
|
|
Key
|
string
|
|
ManagedIdentity
|
string
|
|
User
|
string
|
|
CreateMode
Indicates whether the configuration store need to be recovered.
Name |
Type |
Description |
Default
|
string
|
|
Recover
|
string
|
|
EncryptionProperties
The encryption settings for a configuration store.
ErrorAdditionalInfo
The resource management error additional info.
Name |
Type |
Description |
info
|
object
|
The additional info.
|
type
|
string
|
The additional info type.
|
ErrorDetails
The details of the error.
Name |
Type |
Description |
additionalInfo
|
ErrorAdditionalInfo[]
|
The error additional info.
|
code
|
string
|
Error code.
|
message
|
string
|
Error message indicating why the operation failed.
|
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name |
Type |
Description |
error
|
ErrorDetails
|
The details of the error.
|
IdentityType
The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
Name |
Type |
Description |
None
|
string
|
|
SystemAssigned
|
string
|
|
SystemAssigned, UserAssigned
|
string
|
|
UserAssigned
|
string
|
|
KeyVaultProperties
Settings concerning key vault encryption for a configuration store.
Name |
Type |
Description |
identityClientId
|
string
|
The client id of the identity which will be used to access key vault.
|
keyIdentifier
|
string
|
The URI of the key vault key used to encrypt data.
|
PrivateEndpoint
Private endpoint which a connection belongs to.
Name |
Type |
Description |
id
|
string
|
The resource Id for private endpoint
|
PrivateEndpointConnectionReference
A reference to a related private endpoint connection.
Name |
Type |
Description |
id
|
string
|
The resource ID.
|
name
|
string
|
The name of the resource.
|
properties.privateEndpoint
|
PrivateEndpoint
|
The resource of private endpoint.
|
properties.privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
A collection of information about the state of the connection between service consumer and provider.
|
properties.provisioningState
|
ProvisioningState
|
The provisioning status of the private endpoint connection.
|
type
|
string
|
The type of the resource.
|
PrivateLinkServiceConnectionState
The state of a private link service connection.
Name |
Type |
Description |
actionsRequired
|
ActionsRequired
|
Any action that is required beyond basic workflow (approve/ reject/ disconnect)
|
description
|
string
|
The private link service connection description.
|
status
|
ConnectionStatus
|
The private link service connection status.
|
ProvisioningState
The provisioning state of the configuration store.
Name |
Type |
Description |
Canceled
|
string
|
|
Creating
|
string
|
|
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
Updating
|
string
|
|
PublicNetworkAccess
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
Name |
Type |
Description |
Disabled
|
string
|
|
Enabled
|
string
|
|
ResourceIdentity
An identity that can be associated with a resource.
Name |
Type |
Description |
principalId
|
string
|
The principal id of the identity. This property will only be provided for a system-assigned identity.
|
tenantId
|
string
|
The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.
|
type
|
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.
|
userAssignedIdentities
|
<string,
UserIdentity>
|
The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
|
Sku
Describes a configuration store SKU.
Name |
Type |
Description |
name
|
string
|
The SKU name of the configuration store.
|
systemData
Metadata pertaining to creation and last modification of the resource.
Name |
Type |
Description |
createdAt
|
string
|
The timestamp of resource creation (UTC).
|
createdBy
|
string
|
The identity that created the resource.
|
createdByType
|
createdByType
|
The type of identity that created the resource.
|
lastModifiedAt
|
string
|
The timestamp of resource last modification (UTC)
|
lastModifiedBy
|
string
|
The identity that last modified the resource.
|
lastModifiedByType
|
createdByType
|
The type of identity that last modified the resource.
|
UserIdentity
A resource identity that is managed by the user of the service.
Name |
Type |
Description |
clientId
|
string
|
The client ID of the user-assigned identity.
|
principalId
|
string
|
The principal ID of the user-assigned identity.
|