Client Groups - Get Members Count

Reference

Service:: Service Map

API Version:: 2015-11-01-preview

Returns the approximate number of members in the client group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount?api-version=2015-11-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}/membersCount?api-version=2015-11-01-preview&startTime={startTime}&endTime={endTime}

URI Parameters

Name	In	Required	Type	Description
clientGroupName	path	True	string	Client Group resource name.
resourceGroupName	path	True	string	Resource group name within the specified subscriptionId. Regex pattern: `[a-zA-Z0-9_-]+`
subscriptionId	path	True	string	Azure subscription identifier.
workspaceName	path	True	string	OMS workspace containing the resources of interest. Regex pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]`
api-version	query	True	string	API version.
endTime	query		string date-time	UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
startTime	query		string date-time	UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m

Responses

Name	Type	Description
200 OK	ClientGroupMembersCount	The operation completed successfully.
Other Status Codes	ErrorResponse	An error occurred while processing the request. See the error.code parameter to identify the specific error.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

SMClientGroupsGetMembersCountGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/features/serviceMap/clientGroups/m!m-12bc33c3-31ad-42e0-a08b-bd1c2531776b!b!b-c0a8010a_8000/membersCount?api-version=2015-11-01-preview&startTime=2018-01-08T21:51:48.301Z&endTime=2018-01-08T21:52:03.301Z

Sample Response

Status code:: 200

{
  "startTime": "2018-01-08T21:51:48.301Z",
  "endTime": "2018-01-08T21:52:03.301Z",
  "groupId": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/clientGroups/m!m-12bc33c3-31ad-42e0-a08b-bd1c2531776b!b!b-c0a8010a_8000",
  "count": 25,
  "accuracy": "actual"
}

Definitions

Name	Description
Accuracy	Specifies the accuracy of a computation.
ClientGroupMembersCount	Specifies the number of members in a client group.
Error	Error details.
ErrorResponse	An error response from the API.

Accuracy

Specifies the accuracy of a computation.

Name	Type	Description
actual	string
estimated	string

ClientGroupMembersCount

Specifies the number of members in a client group.

Name	Type	Description
accuracy	Accuracy	Accuracy of the reported count.
count	integer	Number of members in the client group. Use this value together with the value of `accuracy`. If accuracy is `exact` then the value represents the actual number of members in the cloud. When accuracy is `estimated`, the actual number of members is larger than the value of `count`.
endTime	string	Membership interval start time.
groupId	string	Client Group URI.
startTime	string	Membership interval start time.

Error

Error details.

Name	Type	Description
code	string	Error code identifying the specific error.
message	string	Error message in the caller's locale.

ErrorResponse

An error response from the API.

Name	Type	Description
error	Error	Error information.