WorkspaceProductGroupLink interface
Interface representing a WorkspaceProductGroupLink.
Methods
| create |
Adds a group to the specified product via link. |
| delete(string, string, string, string, string, Workspace |
Deletes the specified group from the specified product. |
| get(string, string, string, string, string, Workspace |
Gets the group link for the product. |
| list |
Lists a collection of the group links associated with a product. |
Method Details
createOrUpdate(string, string, string, string, string, ProductGroupLinkContract, WorkspaceProductGroupLinkCreateOrUpdateOptionalParams)
Adds a group to the specified product via link.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, groupLinkId: string, parameters: ProductGroupLinkContract, options?: WorkspaceProductGroupLinkCreateOrUpdateOptionalParams): Promise<ProductGroupLinkContract>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.
- groupLinkId
-
string
Product-Group link identifier. Must be unique in the current API Management service instance.
- parameters
- ProductGroupLinkContract
Create or update parameters.
The options parameters.
Returns
Promise<ProductGroupLinkContract>
delete(string, string, string, string, string, WorkspaceProductGroupLinkDeleteOptionalParams)
Deletes the specified group from the specified product.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, groupLinkId: string, options?: WorkspaceProductGroupLinkDeleteOptionalParams): 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.
- groupLinkId
-
string
Product-Group link identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, WorkspaceProductGroupLinkGetOptionalParams)
Gets the group link for the product.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, groupLinkId: string, options?: WorkspaceProductGroupLinkGetOptionalParams): Promise<WorkspaceProductGroupLinkGetResponse>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.
- groupLinkId
-
string
Product-Group link identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceProductGroupLinkGetResponse>
listByProduct(string, string, string, string, WorkspaceProductGroupLinkListByProductOptionalParams)
Lists a collection of the group links associated with a product.
function listByProduct(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGroupLinkListByProductOptionalParams): PagedAsyncIterableIterator<ProductGroupLinkContract, ProductGroupLinkContract[], 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.
- productId
-
string
Product identifier. Must be unique in the current API Management service instance.
The options parameters.