Configuration Group Schemas - List By Publisher

Referência

Serviço:: Hybrid Network

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

Obtém informações dos esquemas do grupo de configuração em um publicador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/configurationGroupSchemas?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	O nome do editor.
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.

Respostas

Nome	Tipo	Description
200 OK	ConfigurationGroupSchemaListResult	A solicitação foi bem-sucedida. A operação retorna o recurso de esquema de grupo de configuração resultante.
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

Get networkFunctionDefinition groups under publisher resource

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/publishers/testPublisher/configurationGroupSchemas?api-version=2023-09-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "name": "testConfigurationGroupSchema",
      "id": "/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema",
      "type": "Microsoft.HybridNetwork/publishers/configurationGroupSchemas",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "location": "westUs2",
      "properties": {
        "provisioningState": "Accepted",
        "schemaDefinition": "{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}",
        "description": "Schema with no secrets"
      }
    }
  ]
}

Definições

Nome	Description
ConfigurationGroupSchema	Recurso de esquema do grupo de configuração.
ConfigurationGroupSchemaListResult	Uma lista de recursos de esquema do grupo de configuração.
ConfigurationGroupSchemaPropertiesFormat	Propriedades do esquema do grupo de configuração.
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
ProvisioningState	O estado de provisionamento atual.
systemData	Metadados relativos à criação e última modificação do recurso.
versionState	O estado de versão do esquema do grupo de configuração.

ConfigurationGroupSchema

Objeto

Recurso de esquema do grupo de configuração.

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	ConfigurationGroupSchemaPropertiesFormat	Propriedades do esquema do grupo de configuração.
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"

ConfigurationGroupSchemaListResult

Objeto

Uma lista de recursos de esquema do grupo de configuração.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de resultados.
value	ConfigurationGroupSchema[]	Uma lista do esquema do grupo de configuração.

ConfigurationGroupSchemaPropertiesFormat

Objeto

Propriedades do esquema do grupo de configuração.

Nome	Tipo	Description
description	string	Descrição do esquema que pode conter.
provisioningState	ProvisioningState	O estado de provisionamento do recurso de esquema do grupo de configuração.
schemaDefinition	string	Pares de nome e valor que definem o valor de configuração. Pode ser uma cadeia de caracteres JSON com escape bem formada.
versionState	versionState	O estado de versão do esquema do grupo de configuração.

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.

ProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Accepted
Canceled
Converging
Deleted
Deleting
Failed
Succeeded
Unknown

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.

versionState

Enumeração

O estado de versão do esquema do grupo de configuração.

Valor	Description
Active
Deprecated
Preview
Unknown

Compartilhar via

Configuration Group Schemas - List By Publisher

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get networkFunctionDefinition groups under publisher resource

Solicitação de exemplo

Resposta de exemplo

Definições

ConfigurationGroupSchema

ConfigurationGroupSchemaListResult

ConfigurationGroupSchemaPropertiesFormat

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

versionState