Sdílet prostřednictvím

SchemaContract interface

  • Reference
Balíček:
@azure/arm-apimanagement

Podrobnosti o kontraktu schématu rozhraní API

Extends
ProxyResource

Vlastnosti

components

Definice typů. Používá se pouze pro schémata Swagger/OpenAPI v2/v3, jinak null.
contentType

Musí být platným typem média použitým v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu (např. application/json, application/xml).
- SwaggerSchéma použít application/vnd.ms-azure-apim.swagger.definitions+jsonWSDL
- Použití - application/vnd.ms-azure-apim.xsd+xmlOpenApi
schématu Použití schématu
- application/vnd.oai.openapi.components+jsonWADL Schema použít .application/vnd.ms-azure-apim.wadl.grammars+xml
definitions

Definice typů. Používá se pouze pro schémata Swagger/OpenAPI v1, jinak null.
value

Řetězec s řídicím objektem JSON definující dokument představující schéma. Používá se pro jiná schémata než Swagger/OpenAPI.

Zděděné vlastnosti

id

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
type

Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts" POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

Podrobnosti vlastnosti

components

Definice typů. Používá se pouze pro schémata Swagger/OpenAPI v2/v3, jinak null.

components?: Record<string, unknown>

Hodnota vlastnosti

Record<string, unknown>

contentType

Musí být platným typem média použitým v hlavičce Content-Type, jak je definováno v dokumentu RFC 2616. Typ média dokumentu schématu (např. application/json, application/xml).
- SwaggerSchéma použít application/vnd.ms-azure-apim.swagger.definitions+jsonWSDL
- Použití - application/vnd.ms-azure-apim.xsd+xmlOpenApi
schématu Použití schématu
- application/vnd.oai.openapi.components+jsonWADL Schema použít .application/vnd.ms-azure-apim.wadl.grammars+xml

contentType?: string

Hodnota vlastnosti

string

definitions

Definice typů. Používá se pouze pro schémata Swagger/OpenAPI v1, jinak null.

definitions?: Record<string, unknown>

Hodnota vlastnosti

Record<string, unknown>

value

Řetězec s řídicím objektem JSON definující dokument představující schéma. Používá se pro jiná schémata než Swagger/OpenAPI.

value?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

id

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

id?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

name?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.name

type

Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts" POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

type?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.type