Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The configurationGroupValues resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridNetwork/configurationGroupValues resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridNetwork/configurationGroupValues@2023-09-01' = {
location: 'string'
name: 'string'
properties: {
configurationGroupSchemaResourceReference: {
idType: 'string'
// For remaining properties, see DeploymentResourceIdReference objects
}
configurationType: 'string'
// For remaining properties, see ConfigurationGroupValuePropertiesFormat objects
}
tags: {
{customized property}: 'string'
}
}
DeploymentResourceIdReference objects
Set the idType property to specify the type of object.
For Open, use:
{
id: 'string'
idType: 'Open'
}
For Secret, use:
{
id: 'string'
idType: 'Secret'
}
ConfigurationGroupValuePropertiesFormat objects
Set the configurationType property to specify the type of object.
For Open, use:
{
configurationType: 'Open'
configurationValue: 'string'
}
For Secret, use:
{
configurationType: 'Secret'
secretConfigurationValue: 'string'
}
Property Values
Microsoft.HybridNetwork/configurationGroupValues
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Hybrid configuration group value properties. | ConfigurationGroupValuePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ConfigurationGroupValuePropertiesFormat
| Name | Description | Value |
|---|---|---|
| configurationGroupSchemaResourceReference | The configuration group schema resource reference. | DeploymentResourceIdReference |
| configurationType | Set to 'Open' for type ConfigurationValueWithoutSecrets. Set to 'Secret' for type ConfigurationValueWithSecrets. | 'Open' 'Secret' (required) |
ConfigurationValueWithoutSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Open' (required) |
| configurationValue | Name and value pairs that define the configuration value. It can be a well formed escaped JSON string. | string |
ConfigurationValueWithSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Secret' (required) |
| secretConfigurationValue | Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string. | string Constraints: Sensitive value. Pass in as a secure parameter. |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The configurationGroupValues resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.HybridNetwork/configurationGroupValues resource, add the following JSON to your template.
{
"type": "Microsoft.HybridNetwork/configurationGroupValues",
"apiVersion": "2023-09-01",
"name": "string",
"location": "string",
"properties": {
"configurationGroupSchemaResourceReference": {
"idType": "string"
// For remaining properties, see DeploymentResourceIdReference objects
},
"configurationType": "string"
// For remaining properties, see ConfigurationGroupValuePropertiesFormat objects
},
"tags": {
"{customized property}": "string"
}
}
DeploymentResourceIdReference objects
Set the idType property to specify the type of object.
For Open, use:
{
"id": "string",
"idType": "Open"
}
For Secret, use:
{
"id": "string",
"idType": "Secret"
}
ConfigurationGroupValuePropertiesFormat objects
Set the configurationType property to specify the type of object.
For Open, use:
{
"configurationType": "Open",
"configurationValue": "string"
}
For Secret, use:
{
"configurationType": "Secret",
"secretConfigurationValue": "string"
}
Property Values
Microsoft.HybridNetwork/configurationGroupValues
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Hybrid configuration group value properties. | ConfigurationGroupValuePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HybridNetwork/configurationGroupValues' |
ConfigurationGroupValuePropertiesFormat
| Name | Description | Value |
|---|---|---|
| configurationGroupSchemaResourceReference | The configuration group schema resource reference. | DeploymentResourceIdReference |
| configurationType | Set to 'Open' for type ConfigurationValueWithoutSecrets. Set to 'Secret' for type ConfigurationValueWithSecrets. | 'Open' 'Secret' (required) |
ConfigurationValueWithoutSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Open' (required) |
| configurationValue | Name and value pairs that define the configuration value. It can be a well formed escaped JSON string. | string |
ConfigurationValueWithSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Secret' (required) |
| secretConfigurationValue | Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string. | string Constraints: Sensitive value. Pass in as a secure parameter. |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The configurationGroupValues resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridNetwork/configurationGroupValues resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridNetwork/configurationGroupValues@2023-09-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
configurationGroupSchemaResourceReference = {
idType = "string"
// For remaining properties, see DeploymentResourceIdReference objects
}
configurationType = "string"
// For remaining properties, see ConfigurationGroupValuePropertiesFormat objects
}
}
}
DeploymentResourceIdReference objects
Set the idType property to specify the type of object.
For Open, use:
{
id = "string"
idType = "Open"
}
For Secret, use:
{
id = "string"
idType = "Secret"
}
ConfigurationGroupValuePropertiesFormat objects
Set the configurationType property to specify the type of object.
For Open, use:
{
configurationType = "Open"
configurationValue = "string"
}
For Secret, use:
{
configurationType = "Secret"
secretConfigurationValue = "string"
}
Property Values
Microsoft.HybridNetwork/configurationGroupValues
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Max length = 64 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ (required) |
| properties | Hybrid configuration group value properties. | ConfigurationGroupValuePropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HybridNetwork/configurationGroupValues@2023-09-01" |
ConfigurationGroupValuePropertiesFormat
| Name | Description | Value |
|---|---|---|
| configurationGroupSchemaResourceReference | The configuration group schema resource reference. | DeploymentResourceIdReference |
| configurationType | Set to 'Open' for type ConfigurationValueWithoutSecrets. Set to 'Secret' for type ConfigurationValueWithSecrets. | 'Open' 'Secret' (required) |
ConfigurationValueWithoutSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Open' (required) |
| configurationValue | Name and value pairs that define the configuration value. It can be a well formed escaped JSON string. | string |
ConfigurationValueWithSecrets
| Name | Description | Value |
|---|---|---|
| configurationType | The value which indicates if configuration values are secrets | 'Secret' (required) |
| secretConfigurationValue | Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string. | string Constraints: Sensitive value. Pass in as a secure parameter. |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|