ClientGroups interface

Package:

@azure/arm-servicemap

Interface representing a ClientGroups.

Methods

get(string, string, string, ClientGroupsGetOptionalParams)	Retrieves the specified client group
getMembersCount(string, string, string, ClientGroupsGetMembersCountOptionalParams)	Returns the approximate number of members in the client group.
listMembers(string, string, string, ClientGroupsListMembersOptionalParams)	Returns the members of the client group during the specified time interval.

Method Details

get(string, string, string, ClientGroupsGetOptionalParams)

Retrieves the specified client group

function get(resourceGroupName: string, workspaceName: string, clientGroupName: string, options?: ClientGroupsGetOptionalParams): Promise<ClientGroup>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

clientGroupName

string

Client Group resource name.

options

ClientGroupsGetOptionalParams

The options parameters.

Returns

Promise<ClientGroup>

getMembersCount(string, string, string, ClientGroupsGetMembersCountOptionalParams)

Returns the approximate number of members in the client group.

function getMembersCount(resourceGroupName: string, workspaceName: string, clientGroupName: string, options?: ClientGroupsGetMembersCountOptionalParams): Promise<ClientGroupMembersCount>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

clientGroupName

string

Client Group resource name.

options

ClientGroupsGetMembersCountOptionalParams

The options parameters.

Returns

Promise<ClientGroupMembersCount>

listMembers(string, string, string, ClientGroupsListMembersOptionalParams)

Returns the members of the client group during the specified time interval.

function listMembers(resourceGroupName: string, workspaceName: string, clientGroupName: string, options?: ClientGroupsListMembersOptionalParams): PagedAsyncIterableIterator<ClientGroupMember, ClientGroupMember[], PageSettings>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

clientGroupName

string

Client Group resource name.

options

ClientGroupsListMembersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClientGroupMember, ClientGroupMember[], PageSettings>