App Configuration Stores [Microsoft.AppConfiguration/configurationStores]

This module deploys an App Configuration Store.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/app-config-stores/main.bicep.

• Using only defaults
• Using Customer-Managed-Keys with User-Assigned identity
• Using large parameter set
• Private endpoint-enabled deployment
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module configurationStore './packages/app-config-stores/main.bicep' = {
  name: 'configurationStoreDeployment'
  params: {
    // Required parameters
    name: 'accmin001'
    // Non-required parameters
    enablePurgeProtection: false
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "accmin001"
    },
    // Non-required parameters
    "enablePurgeProtection": {
      "value": false
    }
  }
}

using './packages/app-config-stores/main.bicep'

// Required parameters
param name = 'accmin001'
// Non-required parameters
param enablePurgeProtection = false

Example 2: Using Customer-Managed-Keys with User-Assigned identity

This instance deploys the module using Customer-Managed-Keys using a User-Assigned Identity to access the Customer-Managed-Key secret.

module configurationStore './packages/app-config-stores/main.bicep' = {
  name: 'configurationStoreDeployment'
  params: {
    // Required parameters
    name: 'accencr001'
    // Non-required parameters
    createMode: 'Default'
    customerManagedKey: {
      keyName: '<keyName>'
      keyVaultResourceId: '<keyVaultResourceId>'
      userAssignedIdentityResourceId: '<userAssignedIdentityResourceId>'
    }
    disableLocalAuth: '<disableLocalAuth>'
    enablePurgeProtection: false
    keyValues: [
      {
        contentType: 'contentType'
        name: 'keyName'
        roleAssignments: [
          {
            principalId: '<principalId>'
            principalType: 'ServicePrincipal'
            roleDefinitionIdOrName: 'Reader'
          }
        ]
        value: 'valueName'
      }
    ]
    managedIdentities: {
      userAssignedResourceIds: [
        '<managedIdentityResourceId>'
      ]
    }
    softDeleteRetentionInDays: 1
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "accencr001"
    },
    // Non-required parameters
    "createMode": {
      "value": "Default"
    },
    "customerManagedKey": {
      "value": {
        "keyName": "<keyName>",
        "keyVaultResourceId": "<keyVaultResourceId>",
        "userAssignedIdentityResourceId": "<userAssignedIdentityResourceId>"
      }
    },
    "disableLocalAuth": {
      "value": "<disableLocalAuth>"
    },
    "enablePurgeProtection": {
      "value": false
    },
    "keyValues": {
      "value": [
        {
          "contentType": "contentType",
          "name": "keyName",
          "roleAssignments": [
            {
              "principalId": "<principalId>",
              "principalType": "ServicePrincipal",
              "roleDefinitionIdOrName": "Reader"
            }
          ],
          "value": "valueName"
        }
      ]
    },
    "managedIdentities": {
      "value": {
        "userAssignedResourceIds": [
          "<managedIdentityResourceId>"
        ]
      }
    },
    "softDeleteRetentionInDays": {
      "value": 1
    }
  }
}

using './packages/app-config-stores/main.bicep'

// Required parameters
param name = 'accencr001'
// Non-required parameters
param createMode = 'Default'
param customerManagedKey = {
  keyName: '<keyName>'
  keyVaultResourceId: '<keyVaultResourceId>'
  userAssignedIdentityResourceId: '<userAssignedIdentityResourceId>'
}
param disableLocalAuth = '<disableLocalAuth>'
param enablePurgeProtection = false
param keyValues = [
  {
    contentType: 'contentType'
    name: 'keyName'
    roleAssignments: [
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Reader'
      }
    ]
    value: 'valueName'
  }
]
param managedIdentities = {
  userAssignedResourceIds: [
    '<managedIdentityResourceId>'
  ]
}
param softDeleteRetentionInDays = 1

Example 3: Using large parameter set

This instance deploys the module with most of its features enabled.

module configurationStore './packages/app-config-stores/main.bicep' = {
  name: 'configurationStoreDeployment'
  params: {
    // Required parameters
    name: 'accmax001'
    // Non-required parameters
    createMode: 'Default'
    diagnosticSettings: [
      {
        eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
        eventHubName: '<eventHubName>'
        metricCategories: [
          {
            category: 'AllMetrics'
          }
        ]
        name: 'customSetting'
        storageAccountResourceId: '<storageAccountResourceId>'
        workspaceResourceId: '<workspaceResourceId>'
      }
    ]
    disableLocalAuth: '<disableLocalAuth>'
    enablePurgeProtection: false
    keyValues: [
      {
        contentType: 'contentType'
        name: 'keyName'
        roleAssignments: [
          {
            name: '56e2c190-b31e-4518-84de-170b8a5c1b24'
            principalId: '<principalId>'
            principalType: 'ServicePrincipal'
            roleDefinitionIdOrName: 'Owner'
          }
          {
            principalId: '<principalId>'
            principalType: 'ServicePrincipal'
            roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
          }
          {
            principalId: '<principalId>'
            principalType: 'ServicePrincipal'
            roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
          }
        ]
        value: 'valueName'
      }
      {
        name: 'keyName2'
        value: 'valueName2'
      }
    ]
    location: '<location>'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    managedIdentities: {
      systemAssigned: true
      userAssignedResourceIds: [
        '<managedIdentityResourceId>'
      ]
    }
    replicaLocations: [
      {
        name: 'mycentralusreplica'
        replicaLocation: 'centralus'
      }
      {
        replicaLocation: 'westus'
      }
    ]
    roleAssignments: [
      {
        name: '695044c2-3f1f-4843-970a-bed584b95a9a'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    softDeleteRetentionInDays: 1
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "accmax001"
    },
    // Non-required parameters
    "createMode": {
      "value": "Default"
    },
    "diagnosticSettings": {
      "value": [
        {
          "eventHubAuthorizationRuleResourceId": "<eventHubAuthorizationRuleResourceId>",
          "eventHubName": "<eventHubName>",
          "metricCategories": [
            {
              "category": "AllMetrics"
            }
          ],
          "name": "customSetting",
          "storageAccountResourceId": "<storageAccountResourceId>",
          "workspaceResourceId": "<workspaceResourceId>"
        }
      ]
    },
    "disableLocalAuth": {
      "value": "<disableLocalAuth>"
    },
    "enablePurgeProtection": {
      "value": false
    },
    "keyValues": {
      "value": [
        {
          "contentType": "contentType",
          "name": "keyName",
          "roleAssignments": [
            {
              "name": "56e2c190-b31e-4518-84de-170b8a5c1b24",
              "principalId": "<principalId>",
              "principalType": "ServicePrincipal",
              "roleDefinitionIdOrName": "Owner"
            },
            {
              "principalId": "<principalId>",
              "principalType": "ServicePrincipal",
              "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
            },
            {
              "principalId": "<principalId>",
              "principalType": "ServicePrincipal",
              "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
            }
          ],
          "value": "valueName"
        },
        {
          "name": "keyName2",
          "value": "valueName2"
        }
      ]
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "managedIdentities": {
      "value": {
        "systemAssigned": true,
        "userAssignedResourceIds": [
          "<managedIdentityResourceId>"
        ]
      }
    },
    "replicaLocations": {
      "value": [
        {
          "name": "mycentralusreplica",
          "replicaLocation": "centralus"
        },
        {
          "replicaLocation": "westus"
        }
      ]
    },
    "roleAssignments": {
      "value": [
        {
          "name": "695044c2-3f1f-4843-970a-bed584b95a9a",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "softDeleteRetentionInDays": {
      "value": 1
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/app-config-stores/main.bicep'

// Required parameters
param name = 'accmax001'
// Non-required parameters
param createMode = 'Default'
param diagnosticSettings = [
  {
    eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
    eventHubName: '<eventHubName>'
    metricCategories: [
      {
        category: 'AllMetrics'
      }
    ]
    name: 'customSetting'
    storageAccountResourceId: '<storageAccountResourceId>'
    workspaceResourceId: '<workspaceResourceId>'
  }
]
param disableLocalAuth = '<disableLocalAuth>'
param enablePurgeProtection = false
param keyValues = [
  {
    contentType: 'contentType'
    name: 'keyName'
    roleAssignments: [
      {
        name: '56e2c190-b31e-4518-84de-170b8a5c1b24'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    value: 'valueName'
  }
  {
    name: 'keyName2'
    value: 'valueName2'
  }
]
param location = '<location>'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param managedIdentities = {
  systemAssigned: true
  userAssignedResourceIds: [
    '<managedIdentityResourceId>'
  ]
}
param replicaLocations = [
  {
    name: 'mycentralusreplica'
    replicaLocation: 'centralus'
  }
  {
    replicaLocation: 'westus'
  }
]
param roleAssignments = [
  {
    name: '695044c2-3f1f-4843-970a-bed584b95a9a'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param softDeleteRetentionInDays = 1
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Example 4: Private endpoint-enabled deployment

This instance deploys the module with private endpoints.

module configurationStore './packages/app-config-stores/main.bicep' = {
  name: 'configurationStoreDeployment'
  params: {
    // Required parameters
    name: 'accpe001'
    // Non-required parameters
    createMode: 'Default'
    enablePurgeProtection: false
    privateEndpoints: [
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
        tags: {
          Environment: 'Non-Prod'
          'hidden-title': 'This is visible in the resource name'
          Role: 'DeploymentValidation'
        }
      }
      {
        privateDnsZoneGroup: {
          privateDnsZoneGroupConfigs: [
            {
              privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
            }
          ]
        }
        subnetResourceId: '<subnetResourceId>'
      }
    ]
    softDeleteRetentionInDays: 1
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "accpe001"
    },
    // Non-required parameters
    "createMode": {
      "value": "Default"
    },
    "enablePurgeProtection": {
      "value": false
    },
    "privateEndpoints": {
      "value": [
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>",
          "tags": {
            "Environment": "Non-Prod",
            "hidden-title": "This is visible in the resource name",
            "Role": "DeploymentValidation"
          }
        },
        {
          "privateDnsZoneGroup": {
            "privateDnsZoneGroupConfigs": [
              {
                "privateDnsZoneResourceId": "<privateDnsZoneResourceId>"
              }
            ]
          },
          "subnetResourceId": "<subnetResourceId>"
        }
      ]
    },
    "softDeleteRetentionInDays": {
      "value": 1
    }
  }
}

using './packages/app-config-stores/main.bicep'

// Required parameters
param name = 'accpe001'
// Non-required parameters
param createMode = 'Default'
param enablePurgeProtection = false
param privateEndpoints = [
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
  {
    privateDnsZoneGroup: {
      privateDnsZoneGroupConfigs: [
        {
          privateDnsZoneResourceId: '<privateDnsZoneResourceId>'
        }
      ]
    }
    subnetResourceId: '<subnetResourceId>'
  }
]
param softDeleteRetentionInDays = 1

Example 5: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module configurationStore './packages/app-config-stores/main.bicep' = {
  name: 'configurationStoreDeployment'
  params: {
    // Required parameters
    name: 'accwaf001'
    // Non-required parameters
    createMode: 'Default'
    diagnosticSettings: [
      {
        eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
        eventHubName: '<eventHubName>'
        storageAccountResourceId: '<storageAccountResourceId>'
        workspaceResourceId: '<workspaceResourceId>'
      }
    ]
    disableLocalAuth: '<disableLocalAuth>'
    enablePurgeProtection: false
    keyValues: [
      {
        contentType: 'contentType'
        name: 'keyName'
        value: 'valueName'
      }
    ]
    replicaLocations: [
      {
        replicaLocation: 'centralus'
      }
      {
        replicaLocation: 'westus'
      }
    ]
    softDeleteRetentionInDays: 1
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "name": {
      "value": "accwaf001"
    },
    // Non-required parameters
    "createMode": {
      "value": "Default"
    },
    "diagnosticSettings": {
      "value": [
        {
          "eventHubAuthorizationRuleResourceId": "<eventHubAuthorizationRuleResourceId>",
          "eventHubName": "<eventHubName>",
          "storageAccountResourceId": "<storageAccountResourceId>",
          "workspaceResourceId": "<workspaceResourceId>"
        }
      ]
    },
    "disableLocalAuth": {
      "value": "<disableLocalAuth>"
    },
    "enablePurgeProtection": {
      "value": false
    },
    "keyValues": {
      "value": [
        {
          "contentType": "contentType",
          "name": "keyName",
          "value": "valueName"
        }
      ]
    },
    "replicaLocations": {
      "value": [
        {
          "replicaLocation": "centralus"
        },
        {
          "replicaLocation": "westus"
        }
      ]
    },
    "softDeleteRetentionInDays": {
      "value": 1
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/app-config-stores/main.bicep'

// Required parameters
param name = 'accwaf001'
// Non-required parameters
param createMode = 'Default'
param diagnosticSettings = [
  {
    eventHubAuthorizationRuleResourceId: '<eventHubAuthorizationRuleResourceId>'
    eventHubName: '<eventHubName>'
    storageAccountResourceId: '<storageAccountResourceId>'
    workspaceResourceId: '<workspaceResourceId>'
  }
]
param disableLocalAuth = '<disableLocalAuth>'
param enablePurgeProtection = false
param keyValues = [
  {
    contentType: 'contentType'
    name: 'keyName'
    value: 'valueName'
  }
]
param replicaLocations = [
  {
    replicaLocation: 'centralus'
  }
  {
    replicaLocation: 'westus'
  }
]
param softDeleteRetentionInDays = 1
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Optional parameters

Parameter: name

Name of the Azure App Configuration.

• Required: Yes
• Type: string

Parameter: createMode

Indicates whether the configuration store need to be recovered.

• Required: No
• Type: string
• Default: 'Default'
• Allowed:

  [
    'Default'
    'Recover'
  ]
  

Parameter: customerManagedKey

The customer managed key definition.

• Required: No
• Type: object

Required parameters

Optional parameters

Parameter: customerManagedKey.keyName

The name of the customer managed key to use for encryption.

• Required: Yes
• Type: string

Parameter: customerManagedKey.keyVaultResourceId

The resource ID of a key vault to reference a customer managed key for encryption from.

• Required: Yes
• Type: string

Parameter: customerManagedKey.autoRotationEnabled

Enable or disable auto-rotating to the latest key version. Default is true. If set to false, the latest key version at the time of the deployment is used.

• Required: No
• Type: bool

Parameter: customerManagedKey.keyVersion

The version of the customer managed key to reference for encryption. If not provided, using version as per 'autoRotationEnabled' setting.

• Required: No
• Type: string

Parameter: customerManagedKey.userAssignedIdentityResourceId

User assigned identity to use when fetching the customer managed key. Required if no system assigned identity is available for use.

• Required: No
• Type: string

Parameter: dataPlaneProxy

Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).

• Required: No
• Type: object

Required parameters

Optional parameters

Parameter: dataPlaneProxy.privateLinkDelegation

The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link.

• Required: Yes
• Type: string
• Allowed:

  [
    'Disabled'
    'Enabled'
  ]
  

Parameter: dataPlaneProxy.authenticationMode

The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. 'Pass-through' is recommended.

• Required: No
• Type: string
• Allowed:

  [
    'Local'
    'Pass-through'
  ]
  

Parameter: diagnosticSettings

The diagnostic settings of the service.

• Required: No
• Type: array

Optional parameters

Parameter: diagnosticSettings.eventHubAuthorizationRuleResourceId

Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to.

• Required: No
• Type: string

Parameter: diagnosticSettings.eventHubName

Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: diagnosticSettings.logAnalyticsDestinationType

A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type.

• Required: No
• Type: string
• Allowed:

  [
    'AzureDiagnostics'
    'Dedicated'
  ]
  

Parameter: diagnosticSettings.logCategoriesAndGroups

The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to [] to disable log collection.

• Required: No
• Type: array

Optional parameters

Parameter: diagnosticSettings.logCategoriesAndGroups.category

Name of a Diagnostic Log category for a resource type this setting is applied to. Set the specific logs to collect here.

• Required: No
• Type: string

Parameter: diagnosticSettings.logCategoriesAndGroups.categoryGroup

Name of a Diagnostic Log category group for a resource type this setting is applied to. Set to allLogs to collect all logs.

• Required: No
• Type: string

Parameter: diagnosticSettings.logCategoriesAndGroups.enabled

Enable or disable the category explicitly. Default is true.

• Required: No
• Type: bool

Parameter: diagnosticSettings.marketplacePartnerResourceId

The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.

• Required: No
• Type: string

Parameter: diagnosticSettings.metricCategories

The name of metrics that will be streamed. "allMetrics" includes all possible metrics for the resource. Set to [] to disable metric collection.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: diagnosticSettings.metricCategories.category

Name of a Diagnostic Metric category for a resource type this setting is applied to. Set to AllMetrics to collect all metrics.

• Required: Yes
• Type: string

Parameter: diagnosticSettings.metricCategories.enabled

Enable or disable the category explicitly. Default is true.

• Required: No
• Type: bool

Parameter: diagnosticSettings.name

The name of the diagnostic setting.

• Required: No
• Type: string

Parameter: diagnosticSettings.storageAccountResourceId

Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: diagnosticSettings.workspaceResourceId

Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.

• Required: No
• Type: string

Parameter: disableLocalAuth

Disables all authentication methods other than AAD authentication.

• Required: No
• Type: bool
• Default: True

Parameter: enablePurgeProtection

Property specifying whether protection against purge is enabled for this configuration store. Defaults to true unless sku is set to Free, since purge protection is not available in Free tier.

• Required: No
• Type: bool
• Default: True

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: keyValues

All Key / Values to create. Requires local authentication to be enabled.

• Required: No
• Type: array

Parameter: location

Location for all Resources.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: managedIdentities

The managed identity definition for this resource.

• Required: No
• Type: object

Optional parameters

Parameter: managedIdentities.systemAssigned

Enables system assigned managed identity on the resource.

• Required: No
• Type: bool

Parameter: managedIdentities.userAssignedResourceIds

The resource ID(s) to assign to the resource. Required if a user assigned identity is used for encryption.

• Required: No
• Type: array

Parameter: privateEndpoints

Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.subnetResourceId

Resource ID of the subnet where the endpoint needs to be created.

• Required: Yes
• Type: string

Parameter: privateEndpoints.applicationSecurityGroupResourceIds

Application security groups in which the Private Endpoint IP configuration is included.

• Required: No
• Type: array

Parameter: privateEndpoints.customDnsConfigs

Custom DNS configurations.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.customDnsConfigs.ipAddresses

A list of private IP addresses of the private endpoint.

• Required: Yes
• Type: array

Parameter: privateEndpoints.customDnsConfigs.fqdn

FQDN that resolves to private endpoint IP address.

• Required: No
• Type: string

Parameter: privateEndpoints.customNetworkInterfaceName

The custom name of the network interface attached to the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool

Parameter: privateEndpoints.ipConfigurations

A list of IP configurations of the Private Endpoint. This will be used to map to the first-party Service endpoints.

• Required: No
• Type: array

Required parameters

Parameter: privateEndpoints.ipConfigurations.name

The name of the resource that is unique within a resource group.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties

Properties of private endpoint IP configurations.

• Required: Yes
• Type: object

Required parameters

Parameter: privateEndpoints.ipConfigurations.properties.groupId

The ID of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.memberName

The member name of a group obtained from the remote resource that this private endpoint should connect to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.ipConfigurations.properties.privateIPAddress

A private IP address obtained from the private endpoint's subnet.

• Required: Yes
• Type: string

Parameter: privateEndpoints.isManualConnection

If Manual Private Link Connection is required.

• Required: No
• Type: bool

Parameter: privateEndpoints.location

The location to deploy the Private Endpoint to.

• Required: No
• Type: string

Parameter: privateEndpoints.lock

Specify the type of lock.

• Required: No
• Type: object

Optional parameters

Parameter: privateEndpoints.lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: privateEndpoints.lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: privateEndpoints.lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: privateEndpoints.manualConnectionRequestMessage

A message passed to the owner of the remote resource with the manual connection request.

• Required: No
• Type: string

Parameter: privateEndpoints.name

The name of the Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup

The private DNS Zone Group to configure for the Private Endpoint.

• Required: No
• Type: object

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs

The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group can support up to 5 DNS zones.

• Required: Yes
• Type: array

Required parameters

Optional parameters

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.privateDnsZoneResourceId

The resource id of the private DNS zone.

• Required: Yes
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name

The name of the private DNS Zone Group config.

• Required: No
• Type: string

Parameter: privateEndpoints.privateDnsZoneGroup.name

The name of the Private DNS Zone Group.

• Required: No
• Type: string

Parameter: privateEndpoints.privateLinkServiceConnectionName

The name of the private link connection to create.

• Required: No
• Type: string

Parameter: privateEndpoints.resourceGroupResourceId

The resource ID of the Resource Group the Private Endpoint will be created in. If not specified, the Resource Group of the provided Virtual Network Subnet is used.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'DNS Resolver Contributor'
  • 'DNS Zone Contributor'
  • 'Domain Services Contributor'
  • 'Domain Services Reader'
  • 'Network Contributor'
  • 'Owner'
  • 'Private DNS Zone Contributor'
  • 'Reader'
  • 'Role Based Access Control Administrator'

Required parameters

Optional parameters

Parameter: privateEndpoints.roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: privateEndpoints.roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: privateEndpoints.roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: privateEndpoints.service

The subresource to deploy the Private Endpoint for. For example "vault" for a Key Vault Private Endpoint.

• Required: No
• Type: string

Parameter: privateEndpoints.tags

Tags to be applied on all resources/Resource Groups in this deployment.

• Required: No
• Type: object

Parameter: publicNetworkAccess

Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set.

• Required: No
• Type: string
• Allowed:

  [
    'Disabled'
    'Enabled'
  ]
  

Parameter: replicaLocations

All Replicas to create.

• Required: No
• Type: array

Required parameters

Optional parameters

Parameter: replicaLocations.replicaLocation

Location of the replica.

• Required: Yes
• Type: string

Parameter: replicaLocations.name

Name of the replica.

• Required: No
• Type: string

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'App Compliance Automation Administrator'
  • 'App Compliance Automation Reader'
  • 'App Configuration Data Owner'
  • 'App Configuration Data Reader'
  • 'App Configuration Reader'
  • 'App Configuration Contributor'
  • 'Contributor'
  • 'Owner'
  • 'Reader'
  • 'Role Based Access Control Administrator'
  • 'User Access Administrator'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: sku

Pricing tier of App Configuration.

• Required: No
• Type: string
• Default: 'Standard'
• Allowed:

  [
    'Developer'
    'Free'
    'Premium'
    'Standard'
  ]
  

Parameter: softDeleteRetentionInDays

The amount of time in days that the configuration store will be retained when it is soft deleted.

• Required: No
• Type: int
• Default: 1
• MinValue: 1
• MaxValue: 7

Parameter: tags

Tags of the resource.

• Required: No
• Type: object

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.