Keys - List By Automation Account

Retrieve the automation keys for an account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys?api-version=2015-10-31

URI Parameters

Name In Required Type Description
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.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

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 lists of an automation account

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/listKeys?api-version=2015-10-31

Sample Response

{
  "keys": [
    {
      "KeyName": "Primary",
      "Permissions": "Full",
      "Value": "**************************************************************"
    },
    {
      "KeyName": "Secondary",
      "Permissions": "Full",
      "Value": "**************************************************************"
    }
  ]
}

Definitions

AutomationKeyName

Automation key name.

AutomationKeyPermissions

Automation key permissions.

ErrorResponse

Error response of an operation failure

Key

Automation key which is used to register a DSC Node

KeyListResult

AutomationKeyName

Automation key name.

Name Type Description
Primary
  • string
Secondary
  • string

AutomationKeyPermissions

Automation key permissions.

Name Type Description
Full
  • string
Read
  • string

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

Key

Automation key which is used to register a DSC Node

Name Type Description
KeyName

Automation key name.

Permissions

Automation key permissions.

Value
  • string

Value of the Automation Key used for registration.

KeyListResult

Name Type Description
keys

Lists the automation keys.