Configuration Group Schemas - List By Publisher

Service:: Hybrid Network

Version d'API:: 2023-09-01

Obtient des informations sur les schémas de groupe de configuration sous un éditeur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Nom de l’éditeur.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ConfigurationGroupSchemaListResult	La demande réussit. L’opération retourne la ressource de schéma de groupe de configuration résultante.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get networkFunctionDefinition groups under publisher resource

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
ConfigurationGroupSchema	Ressource de schéma de groupe de configuration.
ConfigurationGroupSchemaListResult	Liste des ressources de schéma de groupe de configuration.
ConfigurationGroupSchemaPropertiesFormat	Propriétés du schéma de groupe de configuration.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ProvisioningState	État d’approvisionnement actuel.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
versionState	État de la version du schéma du groupe de configuration.

ConfigurationGroupSchema

Object

Ressource de schéma de groupe de configuration.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties	ConfigurationGroupSchemaPropertiesFormat	Propriétés du schéma de groupe de configuration.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ConfigurationGroupSchemaListResult

Object

Liste des ressources de schéma de groupe de configuration.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir le jeu de résultats suivant.
value	ConfigurationGroupSchema[]	Liste du schéma de groupe de configuration.

ConfigurationGroupSchemaPropertiesFormat

Object

Propriétés du schéma de groupe de configuration.

Nom	Type	Description
description	string	Description de ce que le schéma peut contenir.
provisioningState	ProvisioningState	État d’approvisionnement de la ressource de schéma de groupe de configuration.
schemaDefinition	string	Paires nom et valeur qui définissent la valeur de configuration. Il peut s’agir d’une chaîne JSON bien formée.
versionState	versionState	État de la version du schéma du groupe de configuration.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ProvisioningState

Énumération

État d’approvisionnement actuel.

Valeur	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

versionState

Énumération

État de la version du schéma du groupe de configuration.

Valeur	Description
Unknown
Preview
Active
Deprecated

Partager via

Configuration Group Schemas - List By Publisher

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get networkFunctionDefinition groups under publisher resource

Exemple de requête

Exemple de réponse

Définitions

ConfigurationGroupSchema

ConfigurationGroupSchemaListResult

ConfigurationGroupSchemaPropertiesFormat

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

systemData

versionState