Configuration Group Schemas - List By Publisher

Tjänst:

Hybrid Network

API-version:

2023-09-01

Hämtar information om konfigurationsgruppens scheman under en utgivare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Utgivarens namn.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ConfigurationGroupSchemaListResult	Begäran har slutförts. Åtgärden returnerar den resulterande schemaresursen för konfigurationsgrupper.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get networkFunctionDefinition groups under publisher resource

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ConfigurationGroupSchema	Schemaresurs för konfigurationsgrupp.
ConfigurationGroupSchemaListResult	En lista över schemaresurser för konfigurationsgrupper.
ConfigurationGroupSchemaPropertiesFormat	Schemaegenskaper för konfigurationsgrupp.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ProvisioningState	Det aktuella etableringstillståndet.
systemData	Metadata som rör skapande och senaste ändring av resursen.
versionState	Konfigurationsgruppens schemaversionstillstånd.

ConfigurationGroupSchema

Objekt

Schemaresurs för konfigurationsgrupp.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	ConfigurationGroupSchemaPropertiesFormat	Schemaegenskaper för konfigurationsgrupp.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ConfigurationGroupSchemaListResult

Objekt

En lista över schemaresurser för konfigurationsgrupper.

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	ConfigurationGroupSchema[]	En lista över konfigurationsgruppschema.

ConfigurationGroupSchemaPropertiesFormat

Objekt

Schemaegenskaper för konfigurationsgrupp.

Name	Typ	Description
description	string	Beskrivning av vilket schema som kan innehålla.
provisioningState	ProvisioningState	Etableringstillståndet för schemaresursen Konfigurationsgrupp.
schemaDefinition	string	Namn- och värdepar som definierar konfigurationsvärdet. Det kan vara en välformulerad undantagen JSON-sträng.
versionState	versionState	Konfigurationsgruppens schemaversionstillstånd.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

versionState

Uppräkning

Konfigurationsgruppens schemaversionstillstånd.

Värde	Description
Unknown
Preview
Active
Deprecated