Configuration Group Values - Create Or Update

Service:: Hybrid Network

API Version:: 2023-09-01

Creates or updates a hybrid configuration group value.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/configurationGroupValues/{configurationGroupValueName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
configurationGroupValueName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	The name of the configuration group value.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties		configurationGroupValuePropertiesFormat: ConfigurationValueWithSecrets ConfigurationValueWithoutSecrets	Hybrid configuration group value properties.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	configurationGroupValue	Create or update operation has been completed successfully.
201 Created	configurationGroupValue	Create or update operation has been completed successfully. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.
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

Create or update configuration group value

Create or update configuration group value with secrets

Create or update first party configuration group value

Create or update configuration group value

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue?api-version=2023-09-01

{
  "location": "eastus",
  "properties": {
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    },
    "configurationType": "Open",
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Sample response

Status code:: 200

{
  "name": "testConfigurationGroupValue",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue",
  "type": "Microsoft.HybridNetwork/configurationGroupValues",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationType": "Open",
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    },
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Status code:: 201

{
  "name": "testConfigurationGroup",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup",
  "type": "Microsoft.HybridNetwork/configurationGroups",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    },
    "configurationType": "Open",
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Create or update configuration group value with secrets

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue?api-version=2023-09-01

{
  "location": "eastus",
  "properties": {
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    },
    "configurationType": "Secret",
    "secretConfigurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Sample response

Status code:: 200

{
  "name": "testConfigurationGroupValue",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue",
  "type": "Microsoft.HybridNetwork/configurationGroupValues",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationType": "Secret",
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    }
  }
}

Status code:: 201

{
  "name": "testConfigurationGroup",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup",
  "type": "Microsoft.HybridNetwork/configurationGroups",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationType": "Secret",
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Open"
    }
  }
}

Create or update first party configuration group value

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue?api-version=2023-09-01

{
  "location": "eastus",
  "properties": {
    "configurationGroupSchemaResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName",
      "idType": "Secret"
    },
    "configurationType": "Open",
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Sample response

Status code:: 200

{
  "name": "testConfigurationGroupValue",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue",
  "type": "Microsoft.HybridNetwork/configurationGroupValues",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Private",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationType": "Open",
    "configurationGroupSchemaResourceReference": {
      "idType": "Secret"
    },
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Status code:: 201

{
  "name": "testConfigurationGroup",
  "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroups/testConfigurationGroup",
  "type": "Microsoft.HybridNetwork/configurationGroups",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "eastus",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "publisherName": "testPublisher",
    "publisherScope": "Private",
    "configurationGroupSchemaName": "testConfigurationGroupSchemaName",
    "configurationGroupSchemaOfferingLocation": "eastus",
    "configurationType": "Open",
    "configurationGroupSchemaResourceReference": {
      "idType": "Secret"
    },
    "configurationValue": "{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"
  }
}

Definitions

Name	Description
configurationGroupValue	Hybrid configuration group value resource.
ConfigurationValueWithoutSecrets	The ConfigurationValue with no secrets.
ConfigurationValueWithSecrets	The ConfigurationValue with secrets.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OpenDeploymentResourceReference	Non secret deployment resource id reference.
ProvisioningState	The current provisioning state.
PublisherScope	Publisher Scope.
SecretDeploymentResourceReference	Secret deployment resource id reference.
systemData	Metadata pertaining to creation and last modification of the resource.

configurationGroupValue

Object

Hybrid configuration group value resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	configurationGroupValuePropertiesFormat: ConfigurationValueWithSecrets ConfigurationValueWithoutSecrets	Hybrid configuration group value properties.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ConfigurationValueWithoutSecrets

Object

The ConfigurationValue with no secrets.

Name	Type	Description
configurationGroupSchemaName	string	The configuration group schema name.
configurationGroupSchemaOfferingLocation	string	The location of the configuration group schema offering.
configurationGroupSchemaResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	The configuration group schema resource reference.
configurationType	string: Open	The value which indicates if configuration values are secrets
configurationValue	string	Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
provisioningState	ProvisioningState	The provisioning state of the site resource.
publisherName	string	The publisher name for the configuration group schema.
publisherScope	PublisherScope	The scope of the publisher.

ConfigurationValueWithSecrets

Object

The ConfigurationValue with secrets.

Name	Type	Description
configurationGroupSchemaName	string	The configuration group schema name.
configurationGroupSchemaOfferingLocation	string	The location of the configuration group schema offering.
configurationGroupSchemaResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	The configuration group schema resource reference.
configurationType	string: Secret	The value which indicates if configuration values are secrets
provisioningState	ProvisioningState	The provisioning state of the site resource.
publisherName	string	The publisher name for the configuration group schema.
publisherScope	PublisherScope	The scope of the publisher.
secretConfigurationValue	string	Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OpenDeploymentResourceReference

Object

Non secret deployment resource id reference.

Name	Type	Default value	Description
id	string		Resource ID.
idType	string: Open	Open	The resource reference arm id type.

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

PublisherScope

Enumeration

Publisher Scope.

Value	Description
Unknown
Private

SecretDeploymentResourceReference

Object

Secret deployment resource id reference.

Name	Type	Default value	Description
id	string		Resource ID.
idType	string: Secret	Open	The resource reference arm id type.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

Share via

Configuration Group Values - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or update configuration group value

Sample request

Sample response

Create or update configuration group value with secrets

Sample request

Sample response

Create or update first party configuration group value

Sample request

Sample response

Definitions

configurationGroupValue

ConfigurationValueWithoutSecrets

ConfigurationValueWithSecrets

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OpenDeploymentResourceReference

ProvisioningState

PublisherScope

SecretDeploymentResourceReference

systemData