Configuration Group Schemas - List By Publisher

Dienst:

Hybrid Network

API-Version:

2023-09-01

Ruft Informationen zu den Konfigurationsgruppenschemas unter einem Herausgeber ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Der Name des Herausgebers.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ConfigurationGroupSchemaListResult	Die Anforderung ist erfolgreich. Der Vorgang gibt die resultierende Konfigurationsgruppenschemaressource zurück.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get networkFunctionDefinition groups under publisher resource

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
ConfigurationGroupSchema	Konfigurationsgruppenschemaressource.
ConfigurationGroupSchemaListResult	Eine Liste der Konfigurationsgruppenschemaressourcen.
ConfigurationGroupSchemaPropertiesFormat	Eigenschaften des Konfigurationsgruppenschemas.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ProvisioningState	Der aktuelle Bereitstellungsstatus.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
versionState	Der Versionsstatus der Konfigurationsgruppenschemaversion.

ConfigurationGroupSchema

Objekt

Konfigurationsgruppenschemaressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties	ConfigurationGroupSchemaPropertiesFormat	Eigenschaften des Konfigurationsgruppenschemas.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ConfigurationGroupSchemaListResult

Objekt

Eine Liste der Konfigurationsgruppenschemaressourcen.

Name	Typ	Beschreibung
nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	ConfigurationGroupSchema[]	Eine Liste des Konfigurationsgruppenschemas.

ConfigurationGroupSchemaPropertiesFormat

Objekt

Eigenschaften des Konfigurationsgruppenschemas.

Name	Typ	Beschreibung
description	string	Beschreibung, welches Schema enthalten kann.
provisioningState	ProvisioningState	Der Bereitstellungsstatus der Konfigurationsgruppenschemaressource.
schemaDefinition	string	Name- und Wertpaare, die den Konfigurationswert definieren. Es kann eine wohlgeformte JSON-Zeichenfolge mit Escapezeichen sein.
versionState	versionState	Der Versionsstatus der Konfigurationsgruppenschemaversion.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Accepted
Canceled
Converging
Deleted
Deleting
Failed
Succeeded
Unknown

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

versionState

Enumeration

Der Versionsstatus der Konfigurationsgruppenschemaversion.

Wert	Beschreibung
Active
Deprecated
Preview
Unknown