Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiSchema

Package version

Interface representing a ApiSchema.

Hierarchy

  • ApiSchema

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

  • Creates or updates schema configuration for the API.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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 identifier within an API. Must be unique in the current API Management service instance.

    • parameters: SchemaContract

      The schema contents to apply.

    • Optional options: ApiSchemaCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<PollerLike<PollOperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

  • Creates or updates schema configuration for the API.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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 identifier within an API. Must be unique in the current API Management service instance.

    • parameters: SchemaContract

      The schema contents to apply.

    • Optional options: ApiSchemaCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<ApiSchemaCreateOrUpdateResponse>

delete

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

  • Deletes the schema configuration at the Api.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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 identifier within an API. 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.

    • Optional options: ApiSchemaDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • Get the schema configuration at the API level.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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 identifier within an API. Must be unique in the current API Management service instance.

    • Optional options: ApiSchemaGetOptionalParams

      The options parameters.

    Returns Promise<ApiSchemaGetResponse>

getEntityTag

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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 identifier within an API. Must be unique in the current API Management service instance.

    • Optional options: ApiSchemaGetEntityTagOptionalParams

      The options parameters.

    Returns Promise<ApiSchemaGetEntityTagResponse>

listByApi

  • Get the schema configuration at the API level.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: ApiSchemaListByApiOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<SchemaContract>

Generated using TypeDoc