WorkspaceGroup interface
Interface representing a WorkspaceGroup.
Methods
| create |
Creates or Updates a group. |
| delete(string, string, string, string, string, Workspace |
Deletes specific group of the workspace in an API Management service instance. |
| get(string, string, string, string, Workspace |
Gets the details of the group specified by its identifier. |
| get |
Gets the entity state (Etag) version of the group specified by its identifier. |
| list |
Lists a collection of groups defined within a workspace in a service instance. |
| update(string, string, string, string, string, Group |
Updates the details of the group specified by its identifier. |
Method Details
createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)
Creates or Updates a group.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>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.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
- parameters
- GroupCreateParameters
Create parameters.
The options parameters.
Returns
Promise<WorkspaceGroupCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)
Deletes specific group of the workspace in an API Management service instance.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, options?: WorkspaceGroupDeleteOptionalParams): 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.
- groupId
-
string
Group 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, WorkspaceGroupGetOptionalParams)
Gets the details of the group specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>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.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
- options
- WorkspaceGroupGetOptionalParams
The options parameters.
Returns
Promise<WorkspaceGroupGetResponse>
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the group specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>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.
- groupId
-
string
Group identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceGroupGetEntityTagHeaders>
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)
Lists a collection of groups defined within a workspace in a service instance.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], 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, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)
Updates the details of the group specified by its identifier.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>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.
- groupId
-
string
Group 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
- GroupUpdateParameters
Update parameters.
The options parameters.
Returns
Promise<WorkspaceGroupUpdateResponse>