Node Count Information - Get

Service:

Automation

API Version:

2019-06-01

Retrieve counts for Dsc Nodes.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType}?api-version=2019-06-01

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
countType	path	True	CountType	The type of counts to retrieve
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	NodeCounts	OK
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

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

Get node's node configuration counts

Get node's status counts

Get node's node configuration counts

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodecounts/nodeconfiguration?api-version=2019-06-01

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "client.localhost",
      "properties": {
        "count": 24
      }
    },
    {
      "name": "server.localhost",
      "properties": {
        "count": 3
      }
    }
  ],
  "totalCount": 16
}

Get node's status counts

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodecounts/status?api-version=2019-06-01

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "Compliant",
      "properties": {
        "count": 10
      }
    },
    {
      "name": "Failed",
      "properties": {
        "count": 1
      }
    },
    {
      "name": "InProgress",
      "properties": {
        "count": 1
      }
    },
    {
      "name": "NotCompliant",
      "properties": {
        "count": 3
      }
    },
    {
      "name": "Pending",
      "properties": {
        "count": 0
      }
    },
    {
      "name": "Unresponsive",
      "properties": {
        "count": 4
      }
    }
  ],
  "totalCount": 6
}

Definitions

Name	Description
CountType	The type of counts to retrieve
ErrorResponse	Error response of an operation failure
NodeCount	Number of nodes based on the Filter
NodeCountProperties
NodeCounts	Gets the count of nodes by count type

CountType

The type of counts to retrieve

Name	Type	Description
nodeconfiguration	string
status	string

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

NodeCount

Number of nodes based on the Filter

Name	Type	Description
name	string	Gets the name of a count type
properties	NodeCountProperties

NodeCountProperties

Name	Type	Description
count	integer	Gets the count for the name

NodeCounts

Gets the count of nodes by count type

Name	Type	Description
totalCount	integer	Gets the total number of records matching countType criteria.
value	NodeCount[]	Gets an array of counts