ApiSchema interface

Interface representing a ApiSchema.

Methods

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Creates or updates schema configuration for the API.

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Creates or updates schema configuration for the API.

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Deletes the schema configuration at the Api.

get(string, string, string, string, ApiSchemaGetOptionalParams)

Get the schema configuration at the API level.

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the schema specified by its identifier.

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Get the schema configuration at the API level.

Method Details

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Creates or updates schema configuration for the API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId

string

Schema id identifier. Must be unique in the current API Management service instance.

parameters
SchemaContract

The schema contents to apply.

options
ApiSchemaCreateOrUpdateOptionalParams

The options parameters.

Returns

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Creates or updates schema configuration for the API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId

string

Schema id identifier. Must be unique in the current API Management service instance.

parameters
SchemaContract

The schema contents to apply.

options
ApiSchemaCreateOrUpdateOptionalParams

The options parameters.

Returns

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Deletes the schema configuration at the Api.

function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId

string

Schema id identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
ApiSchemaDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ApiSchemaGetOptionalParams)

Get the schema configuration at the API level.

function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId

string

Schema id identifier. Must be unique in the current API Management service instance.

options
ApiSchemaGetOptionalParams

The options parameters.

Returns

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the schema specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId

string

Schema id identifier. Must be unique in the current API Management service instance.

options
ApiSchemaGetEntityTagOptionalParams

The options parameters.

Returns

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Get the schema configuration at the API level.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ApiSchemaListByApiOptionalParams

The options parameters.

Returns