ApiOperation interface
Interface representing a ApiOperation.
Methods
| create |
Creates a new operation in the API or updates an existing one. |
| delete(string, string, string, string, string, Api |
Deletes the specified operation in the API. |
| get(string, string, string, string, Api |
Gets the details of the API Operation specified by its identifier. |
| get |
Gets the entity state (Etag) version of the API operation specified by its identifier. |
| list |
Lists a collection of the operations for the specified API. |
| update(string, string, string, string, string, Operation |
Updates the details of the operation in the API specified by its identifier. |
Method Details
createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)
Creates a new operation in the API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>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.
- operationId
-
string
Operation identifier within an API. Must be unique in the current API Management service instance.
- parameters
- OperationContract
Create parameters.
The options parameters.
Returns
Promise<ApiOperationCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)
Deletes the specified operation in the API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): 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.
- 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.
- options
- ApiOperationDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApiOperationGetOptionalParams)
Gets the details of the API Operation specified by its identifier.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>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.
- operationId
-
string
Operation identifier within an API. Must be unique in the current API Management service instance.
- options
- ApiOperationGetOptionalParams
The options parameters.
Returns
Promise<ApiOperationGetResponse>
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the API operation specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>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.
- operationId
-
string
Operation identifier within an API. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<ApiOperationGetEntityTagHeaders>
listByApi(string, string, string, ApiOperationListByApiOptionalParams)
Lists a collection of the operations for the specified API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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.
The options parameters.
Returns
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)
Updates the details of the operation in the API specified by its identifier.
function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>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.
- 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.
- options
- ApiOperationUpdateOptionalParams
The options parameters.
Returns
Promise<ApiOperationUpdateResponse>