Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Keys - List By Automation Account

Service:: Automation

API Version:: 2024-10-23

Retrieve the automation keys for an account.

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

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	KeyListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

HTTP
Go

POST https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/listKeys?api-version=2024-10-23

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: 2024-10-23/listAutomationAccountKeys.json
func ExampleKeysClient_ListByAutomationAccount() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKeysClient().ListByAutomationAccount(ctx, "rg", "MyAutomationAccount", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armautomation.KeysClientListByAutomationAccountResponse{
	// 	KeyListResult: armautomation.KeyListResult{
	// 		Keys: []*armautomation.Key{
	// 			{
	// 				KeyName: to.Ptr(armautomation.AutomationKeyNamePrimary),
	// 				Permissions: to.Ptr(armautomation.AutomationKeyPermissionsFull),
	// 				Value: to.Ptr("**************************************************************"),
	// 			},
	// 			{
	// 				KeyName: to.Ptr(armautomation.AutomationKeyNameSecondary),
	// 				Permissions: to.Ptr(armautomation.AutomationKeyPermissionsFull),
	// 				Value: to.Ptr("**************************************************************"),
	// 			},
	// 		},
	// 	},
	// }
}

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

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

Definitions

Name	Description
AutomationKeyName	Automation key name.
AutomationKeyPermissions	Automation key permissions.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Key	Automation key which is used to register a DSC Node
KeyListResult

AutomationKeyName

Enumeration

Automation key name.

Value	Description
Primary	Primary
Secondary	Secondary

AutomationKeyPermissions

Enumeration

Automation key permissions.

Value	Description
Read	Read
Full	Full

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Key

Object

Automation key which is used to register a DSC Node

Name	Type	Description
KeyName	AutomationKeyName	Automation key name.
Permissions	AutomationKeyPermissions	Automation key permissions.
Value	string	Value of the Automation Key used for registration.

KeyListResult

Object

Name	Type	Description
keys	Key[]	Lists the automation keys.

URL: https://learn.microsoft.com/en-us/rest/api/automation/keys/list-by-automation-account?view=rest-automation-2024-10-23