Configuration Group Values - Create Or Update

Referência

Serviço:: Hybrid Network

Versão da API:: 2023-09-01

Cria ou atualiza um valor de grupo de configuração híbrida.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
configurationGroupValueName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	O nome do valor do grupo de configuração.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	A localização geográfica onde o recurso reside
properties		configurationGroupValuePropertiesFormat: ConfigurationValueWithSecrets ConfigurationValueWithoutSecrets	Propriedades de valor do grupo de configuração híbrida.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	configurationGroupValue	A operação de criação ou atualização foi concluída com êxito.
201 Created	configurationGroupValue	A operação de criação ou atualização foi concluída com êxito. O cabeçalho contém o cabeçalho 'Azure-AsyncOperation' apontando para um recurso de operações. O URI da operação pode ser consultado para localizar o estado atual da operação.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Solicitação de exemplo

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\"}}}"
  }
}

Resposta de exemplo

Código de status:: 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\"}}}"
  }
}

Código de status:: 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

Solicitação de exemplo

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\"}}}"
  }
}

Resposta de exemplo

Código de status:: 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"
    }
  }
}

Código de status:: 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

Solicitação de exemplo

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\"}}}"
  }
}

Resposta de exemplo

Código de status:: 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\"}}}"
  }
}

Código de status:: 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\"}}}"
  }
}

Definições

Nome	Description
configurationGroupValue	Recurso de valor do grupo de configuração híbrida.
ConfigurationValueWithoutSecrets	O ConfigurationValue sem segredos.
ConfigurationValueWithSecrets	O ConfigurationValue com segredos.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OpenDeploymentResourceReference	Referência de ID de recurso de implantação não secreta.
ProvisioningState	O estado de provisionamento atual.
PublisherScope	Escopo do Publicador.
SecretDeploymentResourceReference	Referência de ID de recurso de implantação secreta.
systemData	Metadados relativos à criação e última modificação do recurso.

configurationGroupValue

Objeto

Recurso de valor do grupo de configuração híbrida.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties	configurationGroupValuePropertiesFormat: ConfigurationValueWithSecrets ConfigurationValueWithoutSecrets	Propriedades de valor do grupo de configuração híbrida.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ConfigurationValueWithoutSecrets

Objeto

O ConfigurationValue sem segredos.

Nome	Tipo	Description
configurationGroupSchemaName	string	O nome do esquema do grupo de configuração.
configurationGroupSchemaOfferingLocation	string	O local da oferta de esquema do grupo de configuração.
configurationGroupSchemaResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	A referência de recurso de esquema do grupo de configuração.
configurationType	string: Open	O valor que indica se os valores de configuração são segredos
configurationValue	string	Pares de nome e valor que definem o valor de configuração. Pode ser uma cadeia de caracteres JSON com escape bem formada.
provisioningState	ProvisioningState	O estado de provisionamento do recurso do site.
publisherName	string	O nome do editor para o esquema do grupo de configuração.
publisherScope	PublisherScope	O escopo do editor.

ConfigurationValueWithSecrets

Objeto

O ConfigurationValue com segredos.

Nome	Tipo	Description
configurationGroupSchemaName	string	O nome do esquema do grupo de configuração.
configurationGroupSchemaOfferingLocation	string	O local da oferta de esquema do grupo de configuração.
configurationGroupSchemaResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	A referência de recurso de esquema do grupo de configuração.
configurationType	string: Secret	O valor que indica se os valores de configuração são segredos
provisioningState	ProvisioningState	O estado de provisionamento do recurso do site.
publisherName	string	O nome do editor para o esquema do grupo de configuração.
publisherScope	PublisherScope	O escopo do editor.
secretConfigurationValue	string	Pares de nome e valor que definem os segredos de valor de configuração. Pode ser uma cadeia de caracteres JSON com escape bem formada.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

OpenDeploymentResourceReference

Objeto

Referência de ID de recurso de implantação não secreta.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
idType	string: Open	Open	O tipo de ID do braço de referência de recurso.

ProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Accepted
Canceled
Converging
Deleted
Deleting
Failed
Succeeded
Unknown

PublisherScope

Enumeração

Escopo do Publicador.

Valor	Description
Private
Unknown

SecretDeploymentResourceReference

Objeto

Referência de ID de recurso de implantação secreta.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
idType	string: Secret	Open	O tipo de ID do braço de referência de recurso.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Configuration Group Values - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create or update configuration group value

Solicitação de exemplo

Resposta de exemplo

Create or update configuration group value with secrets

Solicitação de exemplo

Resposta de exemplo

Create or update first party configuration group value

Solicitação de exemplo

Resposta de exemplo

Definições

configurationGroupValue

ConfigurationValueWithoutSecrets

ConfigurationValueWithSecrets

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OpenDeploymentResourceReference

ProvisioningState

PublisherScope

SecretDeploymentResourceReference

systemData