ClientGroups interface
Interface representing a ClientGroups.
Methods
| begin |
Create or update a client group with the specified parameters. |
| begin |
Create or update a client group with the specified parameters. |
| begin |
Delete an existing client group. |
| begin |
Delete an existing client group. |
| get(string, string, string, Client |
Get properties of a client group. |
| list |
Get all the client groups under a namespace. |
Method Details
beginCreateOrUpdate(string, string, string, ClientGroup, ClientGroupsCreateOrUpdateOptionalParams)
Create or update a client group with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, clientGroupName: string, clientGroupInfo: ClientGroup, options?: ClientGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClientGroup>, ClientGroup>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
- clientGroupName
-
string
The client group name.
- clientGroupInfo
- ClientGroup
Client group information.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ClientGroup>, ClientGroup>>
beginCreateOrUpdateAndWait(string, string, string, ClientGroup, ClientGroupsCreateOrUpdateOptionalParams)
Create or update a client group with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, clientGroupName: string, clientGroupInfo: ClientGroup, options?: ClientGroupsCreateOrUpdateOptionalParams): Promise<ClientGroup>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
- clientGroupName
-
string
The client group name.
- clientGroupInfo
- ClientGroup
Client group information.
The options parameters.
Returns
Promise<ClientGroup>
beginDelete(string, string, string, ClientGroupsDeleteOptionalParams)
Delete an existing client group.
function beginDelete(resourceGroupName: string, namespaceName: string, clientGroupName: string, options?: ClientGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
- clientGroupName
-
string
Name of the client group.
- options
- ClientGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ClientGroupsDeleteOptionalParams)
Delete an existing client group.
function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, clientGroupName: string, options?: ClientGroupsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
- clientGroupName
-
string
Name of the client group.
- options
- ClientGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ClientGroupsGetOptionalParams)
Get properties of a client group.
function get(resourceGroupName: string, namespaceName: string, clientGroupName: string, options?: ClientGroupsGetOptionalParams): Promise<ClientGroup>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
- clientGroupName
-
string
Name of the client group.
- options
- ClientGroupsGetOptionalParams
The options parameters.
Returns
Promise<ClientGroup>
listByNamespace(string, string, ClientGroupsListByNamespaceOptionalParams)
Get all the client groups under a namespace.
function listByNamespace(resourceGroupName: string, namespaceName: string, options?: ClientGroupsListByNamespaceOptionalParams): PagedAsyncIterableIterator<ClientGroup, ClientGroup[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- namespaceName
-
string
Name of the namespace.
The options parameters.