WorkspaceProduct interface
Interface representing a WorkspaceProduct.
Methods
| create |
Creates or Updates a product. |
| delete(string, string, string, string, string, Workspace |
Delete product. |
| get(string, string, string, string, Workspace |
Gets the details of the product specified by its identifier. |
| get |
Gets the entity state (Etag) version of the product specified by its identifier. |
| list |
Lists a collection of products in the specified workspace in a service instance. |
| update(string, string, string, string, string, Product |
Update existing product details. |
Method Details
createOrUpdate(string, string, string, string, ProductContract, WorkspaceProductCreateOrUpdateOptionalParams)
Creates or Updates a product.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, parameters: ProductContract, options?: WorkspaceProductCreateOrUpdateOptionalParams): Promise<WorkspaceProductCreateOrUpdateResponse>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.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
- parameters
- ProductContract
Create or update parameters.
The options parameters.
Returns
delete(string, string, string, string, string, WorkspaceProductDeleteOptionalParams)
Delete product.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, options?: WorkspaceProductDeleteOptionalParams): 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.
- productId
-
string
Product identifier. 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, WorkspaceProductGetOptionalParams)
Gets the details of the product specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetOptionalParams): Promise<WorkspaceProductGetResponse>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.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceProductGetResponse>
getEntityTag(string, string, string, string, WorkspaceProductGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the product specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetEntityTagOptionalParams): Promise<WorkspaceProductGetEntityTagHeaders>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.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceProductGetEntityTagHeaders>
listByService(string, string, string, WorkspaceProductListByServiceOptionalParams)
Lists a collection of products in the specified workspace in a service instance.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], 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.
The options parameters.
Returns
update(string, string, string, string, string, ProductUpdateParameters, WorkspaceProductUpdateOptionalParams)
Update existing product details.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: WorkspaceProductUpdateOptionalParams): Promise<WorkspaceProductUpdateResponse>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.
- productId
-
string
Product identifier. 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
- ProductUpdateParameters
Update parameters.
The options parameters.
Returns
Promise<WorkspaceProductUpdateResponse>