Configuration Group Schemas - List By Publisher

Servicio:: Hybrid Network

Versión de la API:: 2023-09-01

Obtiene información de los esquemas del grupo de configuración en un publicador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	El nombre del editor.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ConfigurationGroupSchemaListResult	La solicitud se realiza correctamente. La operación devuelve el recurso de esquema del grupo de configuración resultante.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get networkFunctionDefinition groups under publisher resource

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

Definiciones

Nombre	Description
ConfigurationGroupSchema	Recurso de esquema del grupo de configuración.
ConfigurationGroupSchemaListResult	Lista de recursos de esquema de grupo de configuración.
ConfigurationGroupSchemaPropertiesFormat	Propiedades de esquema del grupo de configuración.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningState	Estado de aprovisionamiento actual.
systemData	Metadatos relativos a la creación y última modificación del recurso.
versionState	Estado de la versión del esquema del grupo de configuración.

ConfigurationGroupSchema

Object

Recurso de esquema del grupo de configuración.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties	ConfigurationGroupSchemaPropertiesFormat	Propiedades de esquema del grupo de configuración.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ConfigurationGroupSchemaListResult

Object

Lista de recursos de esquema de grupo de configuración.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	ConfigurationGroupSchema[]	Lista de esquemas de grupo de configuración.

ConfigurationGroupSchemaPropertiesFormat

Object

Propiedades de esquema del grupo de configuración.

Nombre	Tipo	Description
description	string	Descripción de qué esquema puede contener.
provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de esquema del grupo de configuración.
schemaDefinition	string	Pares nombre y valor que definen el valor de configuración. Puede ser una cadena JSON con escape bien formada.
versionState	versionState	Estado de la versión del esquema del grupo de configuración.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

versionState

Enumeración

Estado de la versión del esquema del grupo de configuración.

Valor	Description
Unknown
Preview
Active
Deprecated

Compartir a través de

Configuration Group Schemas - List By Publisher

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get networkFunctionDefinition groups under publisher resource

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ConfigurationGroupSchema

ConfigurationGroupSchemaListResult

ConfigurationGroupSchemaPropertiesFormat

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

versionState