Keys - List By Automation Account

Servicio:: Automation

Versión de la API:: 2024-10-23

Recupere las claves de automatización de una cuenta.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	KeyListResult	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get lists of an automation account

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AutomationKeyName	Nombre de clave de automatización.
AutomationKeyPermissions	Permisos de clave de automatización.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Key	Clave de automatización que se usa para registrar un nodo de DSC
KeyListResult

AutomationKeyName

Enumeración

Nombre de clave de automatización.

Valor	Description
Primary	Primary
Secondary	Secundario

AutomationKeyPermissions

Enumeración

Permisos de clave de automatización.

Valor	Description
Read	Lectura
Full	Completo

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Key

Objeto

Clave de automatización que se usa para registrar un nodo de DSC

Nombre	Tipo	Description
KeyName	AutomationKeyName	Nombre de clave de automatización.
Permissions	AutomationKeyPermissions	Permisos de clave de automatización.
Value	string	Valor de la clave de automatización usada para el registro.

KeyListResult

Objeto

Nombre	Tipo	Description
keys	Key[]	Enumera las claves de automatización.