ApiOperationImpl | @azure/arm-apimanagement

Class containing ApiOperation operations.

Hierarchy

ApiOperationImpl

Implements

ApiOperation

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiOperationImpl(client: ApiManagementClientContext): ApiOperationImpl

- Defined in operations/apiOperation.ts:36
Initialize a new instance of the class ApiOperation class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ApiOperationImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

Implementation of ApiOperation.createOrUpdate
- Defined in operations/apiOperation.ts:204
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>

Implementation of ApiOperation.delete
- Defined in operations/apiOperation.ts:273
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

get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

Implementation of ApiOperation.get
- Defined in operations/apiOperation.ts:180
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

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagResponse>

Implementation of ApiOperation.getEntityTag
- Defined in operations/apiOperation.ts:157
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

listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract>

Implementation of ApiOperation.listByApi
- Defined in operations/apiOperation.ts:54
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

update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

Implementation of ApiOperation.update
- Defined in operations/apiOperation.ts:238
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>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiOperationImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

parameters: OperationContract

Optional options: ApiOperationCreateOrUpdateOptionalParams

Returns Promise<ApiOperationCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

ifMatch: string

Optional options: ApiOperationDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

Optional options: ApiOperationGetOptionalParams

Returns Promise<ApiOperationGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

Optional options: ApiOperationGetEntityTagOptionalParams

Returns Promise<ApiOperationGetEntityTagResponse>

listByApi

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiOperationListByApiOptionalParams

Returns PagedAsyncIterableIterator<OperationContract>

update

Parameters

resourceGroupName: string

serviceName: string

apiId: string

operationId: string

ifMatch: string

parameters: OperationUpdateContract

Optional options: ApiOperationUpdateOptionalParams

Returns Promise<ApiOperationUpdateResponse>