GlobalSchemaContract interface

Package:

@azure/arm-apimanagement

Global Schema Contract details.

Extends

ProxyResource

Properties

description	Free-form schema entity description.
document	Global Schema document object for json-based schema formats(e.g. json schema).
schemaType	Schema Type. Immutable.
value	Json-encoded string for non json-based schema.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

Free-form schema entity description.

description?: string

Property Value

string

document

Global Schema document object for json-based schema formats(e.g. json schema).

document?: Record<string, unknown>

Property Value

Record<string, unknown>

schemaType

Schema Type. Immutable.

schemaType?: string

Property Value

string

value

Json-encoded string for non json-based schema.

value?: any

Property Value

any

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type