ClientGroups class

Package:

@azure/arm-servicemap

Class representing a ClientGroups.

Constructors

ClientGroups(ServicemapManagementClientContext)

Create a ClientGroups.

Methods

get(string, string, string, ClientGroupsGetOptionalParams)	Retrieves the specified client group
get(string, string, string, ClientGroupsGetOptionalParams, ServiceCallback<ClientGroup>)
get(string, string, string, ServiceCallback<ClientGroup>)
getMembersCount(string, string, string, ClientGroupsGetMembersCountOptionalParams)	Returns the approximate number of members in the client group.
getMembersCount(string, string, string, ClientGroupsGetMembersCountOptionalParams, ServiceCallback<ClientGroupMembersCount>)
getMembersCount(string, string, string, ServiceCallback<ClientGroupMembersCount>)
listMembers(string, string, string, ClientGroupsListMembersOptionalParams)	Returns the members of the client group during the specified time interval.
listMembers(string, string, string, ClientGroupsListMembersOptionalParams, ServiceCallback<ClientGroupMembersCollection>)
listMembers(string, string, string, ServiceCallback<ClientGroupMembersCollection>)
listMembersNext(string, RequestOptionsBase)	Returns the members of the client group during the specified time interval.
listMembersNext(string, RequestOptionsBase, ServiceCallback<ClientGroupMembersCollection>)
listMembersNext(string, ServiceCallback<ClientGroupMembersCollection>)

Constructor Details

ClientGroups(ServicemapManagementClientContext)

Create a ClientGroups.

new ClientGroups(client: ServicemapManagementClientContext)

Parameters

client

ServicemapManagementClientContext

Reference to the service client.

Method Details

get(string, string, string, ClientGroupsGetOptionalParams)

Retrieves the specified client group

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

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 optional parameters

Returns

Promise<ClientGroupsGetResponse>

Promise<Models.ClientGroupsGetResponse>

get(string, string, string, ClientGroupsGetOptionalParams, ServiceCallback<ClientGroup>)

function get(resourceGroupName: string, workspaceName: string, clientGroupName: string, options: ClientGroupsGetOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<ClientGroup>

The callback

get(string, string, string, ServiceCallback<ClientGroup>)

function get(resourceGroupName: string, workspaceName: string, clientGroupName: string, callback: ServiceCallback<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.

callback

ServiceCallback<ClientGroup>

The callback

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<ClientGroupsGetMembersCountResponse>

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 optional parameters

Returns

Promise<ClientGroupsGetMembersCountResponse>

Promise<Models.ClientGroupsGetMembersCountResponse>

getMembersCount(string, string, string, ClientGroupsGetMembersCountOptionalParams, ServiceCallback<ClientGroupMembersCount>)

function getMembersCount(resourceGroupName: string, workspaceName: string, clientGroupName: string, options: ClientGroupsGetMembersCountOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<ClientGroupMembersCount>

The callback

getMembersCount(string, string, string, ServiceCallback<ClientGroupMembersCount>)

function getMembersCount(resourceGroupName: string, workspaceName: string, clientGroupName: string, callback: ServiceCallback<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.

callback

ServiceCallback<ClientGroupMembersCount>

The callback

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): Promise<ClientGroupsListMembersResponse>

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 optional parameters

Returns

Promise<ClientGroupsListMembersResponse>

Promise<Models.ClientGroupsListMembersResponse>

listMembers(string, string, string, ClientGroupsListMembersOptionalParams, ServiceCallback<ClientGroupMembersCollection>)

function listMembers(resourceGroupName: string, workspaceName: string, clientGroupName: string, options: ClientGroupsListMembersOptionalParams, callback: ServiceCallback<ClientGroupMembersCollection>)

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 optional parameters

callback

ServiceCallback<ClientGroupMembersCollection>

The callback

listMembers(string, string, string, ServiceCallback<ClientGroupMembersCollection>)

function listMembers(resourceGroupName: string, workspaceName: string, clientGroupName: string, callback: ServiceCallback<ClientGroupMembersCollection>)

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.

callback

ServiceCallback<ClientGroupMembersCollection>

The callback

listMembersNext(string, RequestOptionsBase)

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

function listMembersNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ClientGroupsListMembersNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ClientGroupsListMembersNextResponse>

Promise<Models.ClientGroupsListMembersNextResponse>

listMembersNext(string, RequestOptionsBase, ServiceCallback<ClientGroupMembersCollection>)

function listMembersNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ClientGroupMembersCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ClientGroupMembersCollection>

The callback

listMembersNext(string, ServiceCallback<ClientGroupMembersCollection>)

function listMembersNext(nextPageLink: string, callback: ServiceCallback<ClientGroupMembersCollection>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ClientGroupMembersCollection>

The callback