Schemas - Create Or Replace

Služba:: Device Registry

Verze rozhraní API:: 2026-04-01

Vytvoření schématu

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}?api-version=2026-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
schemaName	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Parametr názvu schématu
schemaRegistryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$	Parametr názvu registru schématu
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.format	True	Format	Formát schématu
properties.schemaType	True	SchemaType	Typ schématu.
properties.description		string	Popis schématu čitelný pro člověka.
properties.displayName		string	Zobrazované jméno čitelné pro člověka.
properties.tags		object	Značky schématu

Odpovědi

Name	Typ	Description
200 OK	Schema	Operace aktualizace prostředku "Schéma" byla úspěšná
201 Created	Schema	Operace vytvoření prostředku "Schéma" byla úspěšná
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

CreateOrReplace_Schema

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/schemaRegistries/my-schema-registry/schemas/my-schema?api-version=2026-04-01

{
  "properties": {
    "displayName": "My Schema",
    "description": "This is a sample Schema",
    "format": "JsonSchema/draft-07",
    "schemaType": "MessageSchema",
    "tags": {
      "sampleKey": "sampleValue"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/schemaRegistries/my-schema-registry/schemas/my-schema",
  "name": "my-schema",
  "type": "Microsoft.DeviceRegistry/schemaRegistries/schemas",
  "systemData": {
    "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
    "createdByType": "Application",
    "createdAt": "2022-11-16T00:36:43.2516899Z",
    "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
  },
  "properties": {
    "uuid": "0796f7c1-f2c8-44d7-9f5b-9a6f9522a85d",
    "displayName": "My Schema",
    "description": "This is a sample Schema",
    "format": "JsonSchema/draft-07",
    "schemaType": "MessageSchema",
    "provisioningState": "Succeeded",
    "tags": {
      "sampleKey": "sampleValue"
    }
  }
}

Stavový kód:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DeviceRegistry/schemaRegistries/my-schema-registry/schemas/my-schema",
  "name": "my-schema",
  "type": "Microsoft.DeviceRegistry/schemaRegistries/schemas",
  "systemData": {
    "createdBy": "2ta23112-4596-44ff-b773-19405922bfc1",
    "createdByType": "Application",
    "createdAt": "2022-11-16T00:36:43.2516899Z",
    "lastModifiedBy": "2ta23112-4596-44ff-b773-19405922bfc1",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2022-11-16T01:37:16.0922793Z"
  },
  "properties": {
    "uuid": "0796f7c1-f2c8-44d7-9f5b-9a6f9522a85d",
    "displayName": "My Schema",
    "description": "This is a sample Schema",
    "format": "JsonSchema/draft-07",
    "schemaType": "MessageSchema",
    "provisioningState": "Succeeded",
    "tags": {
      "sampleKey": "sampleValue"
    }
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Format	Definuje formát schématu.
ProvisioningState	Stav zřizování prostředku.
Schema	Definice schématu.
SchemaType	Definuje typ schématu.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

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.

Format

Výčet

Definuje formát schématu.

Hodnota	Description
JsonSchema/draft-07	Formát konceptu verze schématu JSON 7
Delta/1.0	Formát Delta

ProvisioningState

Výčet

Stav zřizování prostředku.

Hodnota	Description
Succeeded	Zdroj byl vytvořen.
Failed	Vytvoření zdroje se nezdařilo.
Canceled	Vytváření zdrojů bylo zrušeno.
Accepted	Zdroj byl serverem přijat.
Deleting	Prostředek se odstraňuje.

Schema

Objekt

Definice schématu.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.description	string	Popis schématu čitelný pro člověka.
properties.displayName	string	Zobrazované jméno čitelné pro člověka.
properties.format	Format	Formát schématu
properties.provisioningState	ProvisioningState	Stav zřizování prostředku
properties.schemaType	SchemaType	Typ schématu.
properties.tags	object	Značky schématu
properties.uuid	string	Globálně jedinečné, neměnné, opakovaně použitelné ID.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

SchemaType

Výčet

Definuje typ schématu.

Hodnota	Description
MessageSchema	Typ schématu schématu zprávy

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.