Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiOperation

Package version

Interface representing a ApiOperation.

Hierarchy

  • ApiOperation

Implemented by

Index

Methods

Methods

createOrUpdate

  • Creates a new operation in the API or updates an existing one.

    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.

    • operationId: string

      Operation identifier within an API. Must be unique in the current API Management service instance.

    • parameters: OperationContract

      Create parameters.

    • Optional options: ApiOperationCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<ApiOperationCreateOrUpdateResponse>

delete

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

  • Deletes the specified operation in 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.

    • operationId: string

      Operation 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: ApiOperationDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

  • Gets the details of the API Operation 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.

    • operationId: string

      Operation identifier within an API. Must be unique in the current API Management service instance.

    • Optional options: ApiOperationGetOptionalParams

      The options parameters.

    Returns Promise<ApiOperationGetResponse>

getEntityTag

  • Gets the entity state (Etag) version of the API operation 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.

    • operationId: string

      Operation identifier within an API. Must be unique in the current API Management service instance.

    • Optional options: ApiOperationGetEntityTagOptionalParams

      The options parameters.

    Returns Promise<ApiOperationGetEntityTagResponse>

listByApi

  • Lists a collection of the operations for the specified 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.

    • Optional options: ApiOperationListByApiOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<OperationContract>

update

  • Updates the details of the operation in the API 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.

    • operationId: string

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

    • parameters: OperationUpdateContract

      API Operation Update parameters.

    • Optional options: ApiOperationUpdateOptionalParams

      The options parameters.

    Returns Promise<ApiOperationUpdateResponse>

Generated using TypeDoc