Configuration Group Schemas - List By Publisher

Služba:

Hybrid Network

Verze rozhraní API:

2023-09-01

Získá informace o schématech skupiny konfigurace v rámci vydavatele.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Jméno vydavatele
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ConfigurationGroupSchemaListResult	Požadavek je úspěšný. Operace vrátí výsledný prostředek schématu skupiny konfigurace.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get networkFunctionDefinition groups under publisher resource

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ConfigurationGroupSchema	Prostředek schématu skupiny konfigurace
ConfigurationGroupSchemaListResult	Seznam prostředků schématu skupiny konfigurace
ConfigurationGroupSchemaPropertiesFormat	Vlastnosti schématu skupiny konfigurace
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ProvisioningState	Aktuální stav zřizování.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
versionState	Stav verze schématu skupiny konfigurace.

ConfigurationGroupSchema

Objekt

Prostředek schématu skupiny konfigurace

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties	ConfigurationGroupSchemaPropertiesFormat	Vlastnosti schématu skupiny konfigurace
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ConfigurationGroupSchemaListResult

Objekt

Seznam prostředků schématu skupiny konfigurace

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků.
value	ConfigurationGroupSchema[]	Seznam schématu skupiny konfigurace.

ConfigurationGroupSchemaPropertiesFormat

Objekt

Vlastnosti schématu skupiny konfigurace

Name	Typ	Description
description	string	Popis schématu, které může obsahovat.
provisioningState	ProvisioningState	Stav zřizování prostředku schématu skupiny konfigurace.
schemaDefinition	string	Dvojice názvů a hodnot, které definují konfigurační hodnotu. Může se jednat o dobře formátovaný řetězec JSON s řídicím znakem.
versionState	versionState	Stav verze schématu skupiny konfigurace.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ProvisioningState

Výčet

Aktuální stav zřizování.

Hodnota	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

versionState

Výčet

Stav verze schématu skupiny konfigurace.

Hodnota	Description
Unknown
Preview
Active
Deprecated