WorkspaceApiOperation interface
Interface representing a WorkspaceApiOperation.
Methods
Method Details
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
Creates a new operation in the API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
Deletes the specified operation in the API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
Gets the details of the API Operation specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the API operation specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
Lists a collection of the operations for the specified API.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
Updates the details of the operation in the API specified by its identifier.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- 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.
The options parameters.
Returns
Promise<WorkspaceApiOperationUpdateResponse>