Statistics - List By Automation Account

Reference

Service:: Automation

API Version:: 2021-06-22

Retrieve the statistics for the account.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics?api-version=2021-06-22

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics?$filter={$filter}&api-version=2021-06-22

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
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.
$filter	query		string	The filter to apply on the operation.

Responses

Name	Type	Description
200 OK	StatisticsListResult	OK
Other Status Codes	ErrorResponse	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 statistics of an automation account

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics?api-version=2021-06-22

import com.azure.core.util.Context;

/** Samples for StatisticsOperation ListByAutomationAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getStatisticsOfAutomationAccount.json
     */
    /**
     * Sample code: Get statistics of an automation account.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void getStatisticsOfAnAutomationAccount(
        com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.statisticsOperations().listByAutomationAccount("rg", "myAutomationAccount11", null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getStatisticsOfAutomationAccount.json
func ExampleStatisticsClient_NewListByAutomationAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewStatisticsClient().NewListByAutomationAccountPager("rg", "myAutomationAccount11", &armautomation.StatisticsClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.StatisticsListResult = armautomation.StatisticsListResult{
		// 	Value: []*armautomation.Statistics{
		// 		{
		// 			CounterProperty: to.Ptr("New"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/New"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Activating"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Activating"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Running"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Running"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Completed"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Completed"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Failed"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Failed"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Stopped"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Stopped"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Blocked"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Blocked"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Suspended"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Suspended"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Disconnected"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Disconnected"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Suspending"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Suspending"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Stopping"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Stopping"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Resuming"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Resuming"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 		},
		// 		{
		// 			CounterProperty: to.Ptr("Removing"),
		// 			CounterValue: to.Ptr[int64](0),
		// 			EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-26T02:11:49.9879197+00:00"); return t}()),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Removing"),
		// 			StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-19T02:11:49.9879197+00:00"); return t}()),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieve the statistics for the account.
 *
 * @summary Retrieve the statistics for the account.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getStatisticsOfAutomationAccount.json
 */
async function getStatisticsOfAnAutomationAccount() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "myAutomationAccount11";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.statisticsOperations.listByAutomationAccount(
    resourceGroupName,
    automationAccountName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/examples/getStatisticsOfAutomationAccount.json
// this example is just showing the usage of "Statistics_ListByAutomationAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AutomationAccountResource created on azure
// for more information of creating AutomationAccountResource, please refer to the document of AutomationAccountResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
string automationAccountName = "myAutomationAccount11";
ResourceIdentifier automationAccountResourceId = AutomationAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName);
AutomationAccountResource automationAccount = client.GetAutomationAccountResource(automationAccountResourceId);

// invoke the operation and iterate over the result
await foreach (AutomationAccountStatistics item in automationAccount.GetStatisticsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/New",
      "counterProperty": "New",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Activating",
      "counterProperty": "Activating",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Running",
      "counterProperty": "Running",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Completed",
      "counterProperty": "Completed",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Failed",
      "counterProperty": "Failed",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Stopped",
      "counterProperty": "Stopped",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Blocked",
      "counterProperty": "Blocked",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Suspended",
      "counterProperty": "Suspended",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Disconnected",
      "counterProperty": "Disconnected",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Suspending",
      "counterProperty": "Suspending",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Stopping",
      "counterProperty": "Stopping",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Resuming",
      "counterProperty": "Resuming",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount11/statistics/Removing",
      "counterProperty": "Removing",
      "counterValue": 0,
      "startTime": "2017-03-19T02:11:49.9879197+00:00",
      "endTime": "2017-03-26T02:11:49.9879197+00:00"
    }
  ]
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
Statistics	Definition of the statistic.
StatisticsListResult	The response model for the list statistics operation.

ErrorResponse

Error response of an operation failure

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

Statistics

Definition of the statistic.

Name	Type	Description
counterProperty	string	Gets the property value of the statistic.
counterValue	integer	Gets the value of the statistic.
endTime	string	Gets the endTime of the statistic.
id	string	Gets the id.
startTime	string	Gets the startTime of the statistic.

StatisticsListResult

The response model for the list statistics operation.

Name	Type	Description
value	Statistics[]	Gets or sets a list of statistics.

Statistics - List By Automation Account

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get statistics of an automation account

Sample Request

Sample Response

Definitions

ErrorResponse

Statistics

StatisticsListResult

Additional resources