Edit

Get-AzAutomationRegistrationInfo

  • Reference
Module:
Az.Automation

Gets registration information for onboarding a DSC node or hybrid worker to Automation.

Syntax

Get-AzAutomationRegistrationInfo
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzAutomationRegistrationInfo cmdlet gets the endpoint and keys required to onboard a Desired State Configuration (DSC) node or hybrid worker into an Azure Automation account.

Examples

Example 1: Get registration information

Get-AzAutomationRegistrationInfo -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01"

This command gets the registration information for the Automation account named AutomationAccount01 in the Resource Group named ResourceGroup01.

Parameters

-AutomationAccountName

Specifies the name of Automation account for which this cmdlet gets registration information.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group. This cmdlet gets registration information for the resource group that this parameter specifies.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

AgentRegistration