Register Azure Local with Arc

Prerequisites

Make sure the following prerequisites are met before proceeding:

• You have access to Azure Local machines running release 2505 or later. Prior versions don't support this scenario.
• You have assigned the appropriate permissions to the subscription used for registration. For more information, see Assign required permissions for Azure Local deployment.

Step 1: Review script parameters

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

Review the parameters used in the script:

Versions 2504 and earlier

Review the parameters used in the script:

Step 2: Set parameters

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

Set the parameters required for the registration script.

Here's an example of how you should change these parameters for the Invoke-AzStackHciArcInitialization initialization script. Once the registration is complete, the Azure Local machines are registered in Azure Arc:

#Define the subscription where you want to register your Azure Local machine with Arc.
$Subscription = "YourSubscriptionID"

#Define the resource group where you want to register your Azure Local machine with Arc.
$RG = "YourResourceGroupName"

#Define the region to use to register your server as Arc device
#Do not use spaces or capital letters when defining region
$Region = "eastus"

#Define the proxy address for your Azure Local deployment to access the internet via proxy.
$ProxyServer = "http://proxyaddress:port"

#Define the bypass list for the proxy. Use comma to separate each item from the list.  
# Parameters must be separated with a comma `,`.
# Use "localhost" instead of <local> 
# Use specific IPs such as 127.0.0.1 without mask 
# Use * for subnets allowlisting. 192.168.1.* for /24 exclusions. Use 192.168.*.* for /16 exclusions. 
# Append * for ___domain names exclusions like *.contoso.com 
# DO NOT INCLUDE .svc on the list. The registration script takes care of Environment Variables configuration. 
# At least the IP address of each Azure Local machine.
# At least the IP address of the Azure Local cluster.
# At least the IPs you defined for your infrastructure network. Arc resource bridge, Azure Kubernetes Service (AKS), and future infrastructure services using these IPs require outbound connectivity.
# NetBIOS name of each machine.
# NetBIOS name of the Azure Local cluster.

$ProxyBypassList = "localhost,127.0.0.1,*.contoso.com,machine1,machine2,machine3,machine4,machine5,192.168.*.*,AzureLocal-1"

PS C:\Users\SetupUser> $Subscription = "Subscription ID"
PS C:\Users\SetupUser> $RG = "myashcirg"
PS C:\Users\SetupUser> $Region = "eastus"
PS C:\Users\SetupUser> $ProxyServer = "http://192.168.10.10:8080"
PS C:\Users\SetupUser> $ProxyBypassList = "localhost,127.0.0.1,*.contoso.com,machine1,machine2,machine3,machine4,machine5,192.168.*.*,AzureLocal-1"

Versions 2504 and earlier

1. Set the parameters required for the registration script.

   Here's an example of how you should change these parameters for the Invoke-AzStackHciArcInitialization initialization script. Once the registration is complete, the Azure Local machines are registered in Azure Arc:

   #Define the subscription where you want to register your machine as Arc device
   $Subscription = "YourSubscriptionID"
   
   #Define the resource group where you want to register your machine as Arc device
   $RG = "YourResourceGroupName"
   
   #Define the region to use to register your server as Arc device, do not use spaces or capital letters when defining region
   $Region = "eastus"
   
   #Define the tenant you will use to register your machine as Arc device
   $Tenant = "YourTenantID"
   
   #Define the proxy address if your Azure Local deployment accesses the internet via proxy
   $ProxyServer = "http://proxyaddress:port"
   

   Expand this section to see an example output.

   PS C:\Users\SetupUser> $Subscription = "<Subscription ID>"
   PS C:\Users\SetupUser> $RG = "myashcirg"
   PS C:\Users\SetupUser> $Tenant = "<Tenant ID>"
   PS C:\Users\SetupUser> $Region = "eastus"
   PS C:\Users\SetupUser> $ProxyServer = "<http://proxyserver:tcpPort>"
   

2. Connect to your Azure account and set the subscription. Open a browser on the client that you're using to connect to the machine and open this page: https://microsoft.com/devicelogin and enter the provided code in the Azure CLI output to authenticate. Get the access token and account ID for the registration.

   #Connect to your Azure account and Subscription
   Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
   
   #Get the Access Token for the registration
   $ARMtoken = (Get-AzAccessToken -WarningAction SilentlyContinue).Token
   
   #Get the Account ID for the registration
   $id = (Get-AzContext).Account.Id
   
   

   Expand this section to see an example output.

   PS C:\Users\SetupUser> Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
   WARNING: To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code A44KHK5B5
   to authenticate.
   
   Account               SubscriptionName      TenantId                Environment
   -------               ----------------      --------                ----------- 
   guspinto@contoso.com AzureLocal_Content  <Tenant ID>             AzureCloud
   
   PS C:\Users\SetupUser> $ARMtoken = (Get-AzAccessToken).Token
   PS C:\Users\SetupUser> $id = (Get-AzContext).Account.Id
   
   

Step 3: Run registration script

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

1. Run the Arc registration script. The script takes a few minutes to run.

   #Invoke the registration script. Use a supported region.
   Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -Region $Region -Cloud "AzureCloud" -Proxy $ProxyServer -ProxyBypass $ProxyBypassList 
   

   For a list of supported Azure regions, see Azure requirements.

   Expand this section to see an example output.

   Here's a sample output of a successful registration of your machines:

   PS C:\Users\Administrator> Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -Region $Region -Cloud "AzureCloud" -Proxy $ProxyServer
   >>
   Configuration saved to: C:\Users\ADMINI~1\AppData\Local\Temp\bootstrap.json
   Triggering bootstrap on the device...
   Waiting for bootstrap to complete... Current Status: InProgress
   =========SNIPPED=========SNIPPED=============
   Waiting for bootstrap to complete... Current Status: InProgress
   Waiting for bootstrap to complete... Current Status: Succeeded
   Bootstrap succeeded.
   
   Triggering bootstrap log collection as a best effort.
   Version Response                                                    
   ------- --------                                                    
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   
   
   PS C:\Users\Administrator>
   

2. During the Arc registration process, you must authenticate with your Azure account. The console window displays a code that you must enter in the URL, displayed in the app, in order to authenticate. Follow the instructions to complete the authentication process.

   

Once the registration is complete, the Azure Local machines are registered in Azure Arc.

Versions 2504 and earlier

1. Finally run the Arc registration script. The script takes a few minutes to run.

   #Invoke the registration script. Use a supported region.
   Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -TenantID $Tenant -Region $Region -Cloud "AzureCloud" -ArmAccessToken $ARMtoken -AccountID $id -Proxy $ProxyServer -ProxyBypass $ProxyBypassList
   

   For a list of supported Azure regions, see Azure requirements.

   Expand this section to see an example output.

   PS C:\Users\Administrator> Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -TenantID $Tenant -Region $Region -Cloud "AzureCloud" -ArmAccessToken $ARMtoken -AccountID $id
   >>
   Configuration saved to: C:\Users\ADMINI~1\AppData\Local\Temp\bootstrap.json
   Triggering bootstrap on the device...
   Waiting for bootstrap to complete... Current Status: InProgress
   =========SNIPPED=========SNIPPED=============
   Waiting for bootstrap to complete... Current Status: InProgress
   Waiting for bootstrap to complete... Current Status: Succeeded
   Bootstrap succeeded.
   
   Triggering bootstrap log collection as a best effort.
   Version Response                                                    
   ------- --------                                                    
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   
   PS C:\Users\Administrator>
   
   

Step 4: Verify the setup is successful

After the script completes successfully on all the machines, verify that your machines are registered with Arc.

1. Go to the Azure portal.

2. Go to the resource group associated with the registration. The machines appear within the specified resource group as Machine - Azure Arc type resources.

   

If you plan to deploy a few machines per site, use the Configurator app to register your Azure Local machines with Azure Arc.

Prerequisites

Before you begin, make sure that you complete the following prerequisites:

Azure Local machine prerequisites

• Download the Configurator App for Azure Local on a client machine that is connected to the same network as the Azure Local machines..

• Note down:

  • The serial number for each machine.
  • Local administrator credentials to sign into each machine.

Azure prerequisites

• Make sure you have the required permissions to register Azure Local machines with Azure Arc. For more information, see Assign required permissions for Azure Local deployment.

Step 1: Configure the network and connect to Azure

Follow these steps to configure network settings and connect the machines to Azure. Start this action a few minutes after you turn on the machine.

1. Open the Configurator app. Right-click the Configurator app exe and run as administrator. Wait a few minutes for the app to open up.

   

2. Enter the machine serial number and select Next.

   

3. Sign in to the machine with local administrator credentials.

   

4. On the Azure Arc agent setup page, select Start.

   

Prerequisites tab

1. On the Prerequisites tab, verify that the minimum requirements are met and then select Next.

   

   If a requirement isn't met, the app displays a warning or errors. You can't proceed if there are errors though warnings are ignored. Resolve the errors before you proceed. For more information, see Troubleshooting registration issues.

   

Basics tab

1. On the Basics tab, configure one network interface that is connected to the internet. Select the Pencil icon to modify network interface settings.

   

2. Provide the interface name, IP allocation as static or DHCP, IP address, subnet, gateway, and preferred DNS servers. Optionally, enter an alternate DNS server.

   

   Important

   Make sure that the IPs you assign are free and not in use.

3. To specify more details, select Enter additional details.

4. On the Additional details page, provide the following inputs and then select Apply.

   

   1. Select ON to enable Remote desktop protocol. Remote desktop protocol is disabled by default.

   2. Select Proxy server as the connectivity method. Provide the proxy URL and the bypass list. The bypass list is required and can be provided in a comma separated format.

      When defining your proxy bypass string, make sure you meet the following conditions:

      • Include at least the IP address of each Azure Local machine.
      • Include at least the IP address of the Azure Local cluster.
      • Include at least the IPs you defined for your infrastructure network. Arc resource bridge, Azure Kubernetes Service (AKS), and future infrastructure services using these IPs require outbound connectivity.
      • Or you can bypass the entire infrastructure subnet.
      • Provide the NetBIOS name of each machine.
      • Provide the NetBIOS name of the Azure Local cluster.
      • Domain name or ___domain name with asterisk * wildcard at the beginning to include any host or subdomain. For example, 192.168.1.* for subnets or *.contoso.com for ___domain names.
      • Parameters must be separated with a comma ,.
      • Classless Inter-Domain Routing (CIDR) notation to bypass subnets isn't supported.
      • The use of <local> strings isn't supported in the proxy bypass list.

   3. Select a time zone.

   4. Specify a preferred and an alternate NTP server to act as a time server or accept the Default. The default is time.windows.com.

   5. Set the hostname for your machine to what you specified during the preparation of Active Directory. Changing the hostname automatically reboots the system.

5. Select Next on the Basics tab.

Arc agent setup tab

1. On the Arc agent setup tab, provide the following inputs:

   

   1. The Cloud type is populated automatically as Azure.

   2. Enter a Subscription ID to register the machine.

   3. Provide a Resource group name. This resource group contains the machine and system resources that you create.

   4. Specify the Region where you want to create the resources. The region should be the same as the region where you want to deploy the Azure Local instance.

      Important

      Specify the region with spaces removed. For example, specify the East US region as EastUS.

   5. Skip the Tenant ID.

   6. Skip the Arc gateway ID.

   Important

   Make sure to verify all the inputs before you proceed. Any incorrect inputs here might result in a setup failure.

2. Select Next.

Review and apply tab

1. On the Review and apply tab, verify machine details. To modify any settings, go back. If satisfied with the current settings, select Finish. If you changed the hostname, your machines boot up automatically at this point and you must sign in again.

   

Step 2: Complete registration of machines to Azure

1. Wait for the configuration to complete. First, machine is configured with the basic details followed by registration of the machines to Azure.

2. During the Arc registration process, you must authenticate with your Azure account. The app displays a code that you must enter in the URL, displayed in the app, in order to authenticate. Follow the instructions to complete the authentication process.

   

3. Once the configuration is complete, status for Arc configuration should display Success (Open in Azure portal).

4. Repeat all steps on the other machines until the Arc configuration succeeds. Select the Open in Azure portal link.

Step 3: Verify machines are connected to Arc

1. In the Azure portal, go to the resource group that you used for bootstrapping.

2. On the resource group used to bootstrap, you should see your Arc-enabled machines. In this example, you see a single machine.

   

Prerequisites

Make sure the following prerequisites are met before proceeding:

• You have access to Azure Local machines running release 2505 or later. Prior versions don't support this scenario.
• You have assigned the appropriate permissions to the subscription used for registration. For more information, see Assign required permissions for Azure Local deployment.

Step 1: Review script parameters

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

Review the parameters used in the script:

Version 2504 and earlier

Review the parameters used in the script:

Step 2: Set parameters

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

Set the parameters.

#Define the subscription where you want to register your machine as Arc device
$Subscription = "YourSubscriptionID"

#Define the resource group where you want to register your machine as Arc device
$RG = "YourResourceGroupName"

#Define the region to use to register your server as Arc device
#Do not use spaces or capital letters when defining region
$Region = "eastus"

PS C:\Users\SetupUser> $Subscription = "Subscription ID"
PS C:\Users\SetupUser> $RG = "myashcirg"
PS C:\Users\SetupUser> $Region = "eastus"

Version 2504 and earlier

1. Set the parameters.

   #Define the subscription where you want to register your machine as Arc device
   $Subscription = "YourSubscriptionID"
   
   #Define the resource group where you want to register your machine as Arc device
   $RG = "YourResourceGroupName"
   
   #Define the region to use to register your server as Arc device, do not use spaces or capital letters when defining region
   $Region = "eastus"
   
   #Define the tenant you will use to register your machine as Arc device
   $Tenant = "YourTenantID"
   

   Expand this section to see an example output.

   PS C:\Users\SetupUser> $Subscription = "<Subscription ID>"
   PS C:\Users\SetupUser> $RG = "myashcirg"
   PS C:\Users\SetupUser> $Tenant = "<Tenant ID>"
   PS C:\Users\SetupUser> $Region = "eastus"
   

2. Connect to your Azure account and set the subscription. Open a browser on the client that you're using to connect to the machine and open this page: https://microsoft.com/devicelogin and enter the provided code in the Azure CLI output to authenticate. Get the access token and account ID for the registration.

   #Connect to your Azure account and Subscription
   Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
   
   #Get the Access Token for the registration
   $ARMtoken = (Get-AzAccessToken -WarningAction SilentlyContinue).Token
   
   #Get the Account ID for the registration
   $id = (Get-AzContext).Account.Id
   
   

   Expand this section to see an example output.

   PS C:\Users\SetupUser> Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
   WARNING: To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code A44KHK5B5
   to authenticate.
   
   Account               SubscriptionName      TenantId                Environment
   -------               ----------------      --------                ----------- 
   guspinto@contoso.com AzureStackHCI_Content  <Tenant ID>             AzureCloud
   
   PS C:\Users\SetupUser> $ARMtoken = (Get-AzAccessToken).Token
   PS C:\Users\SetupUser> $id = (Get-AzContext).Account.Id
   
   

Step 3: Run registration script

The steps are different depending on the solution version of Azure Local you're using.

Versions 2505 and later

1. Run the Arc registration script. The script takes a few minutes to run.

   #Invoke the registration script. Use a supported region.
   Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -Region $Region -Cloud "AzureCloud"
   

   For a list of supported Azure regions, see Azure requirements.

   Expand this section to see an example output.

   PS C:\Users\Administrator> Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -Region $Region -Cloud "AzureCloud"
   >>
   Configuration saved to: C:\Users\ADMINI~1\AppData\Local\Temp\bootstrap.json
   Triggering bootstrap on the device...
   Waiting for bootstrap to complete... Current Status: InProgress
   =========SNIPPED=========SNIPPED=============
   Waiting for bootstrap to complete... Current Status: InProgress
   Waiting for bootstrap to complete... Current Status: Succeeded
   Bootstrap succeeded.
   
   Triggering bootstrap log collection as a best effort.
   Version Response                                                    
   ------- --------                                                    
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
   
   
   PS C:\Users\Administrator>
   

2. During the Arc registration process, you must authenticate with your Azure account. The console window displays a code that you must enter in the URL, displayed in the app, in order to authenticate. Follow the instructions to complete the authentication process.

   

Version 2504 and earlier

Finally run the Arc registration script. The script takes a few minutes to run.

#Invoke the registration script. Use a supported region.
Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -TenantID $Tenant -Region $Region -Cloud "AzureCloud" -ArmAccessToken $ARMtoken -AccountID $id

For a list of supported Azure regions, see Azure requirements.

PS C:\Users\Administrator> Invoke-AzStackHciArcInitialization -SubscriptionID $Subscription -ResourceGroup $RG -TenantID $Tenant -Region $Region -Cloud "AzureCloud" -ArmAccessToken $ARMtoken -AccountID $id
>>
Configuration saved to: C:\Users\ADMINI~1\AppData\Local\Temp\bootstrap.json
Triggering bootstrap on the device...
Waiting for bootstrap to complete... Current Status: InProgress
=========SNIPPED=========SNIPPED=============
Waiting for bootstrap to complete... Current Status: InProgress
Waiting for bootstrap to complete... Current Status: Succeeded
Bootstrap succeeded.

Triggering bootstrap log collection as a best effort.
Version Response                                                    
------- --------                                                    
V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response
V1      Microsoft.Azure.Edge.Bootstrap.ServiceContract.Data.Response

PS C:\Users\Administrator>

Step 4: Verify the setup is successful

1. Go to the Azure portal.

2. Go to the resource group associated with the registration. The machines appear within the specified resource group as Machine - Azure Arc type resources.

   

If you plan to deploy a few machines per site, use the Configurator app to register your Azure Local machines with Azure Arc.

Prerequisites

Before you begin, make sure that you complete the following prerequisites:

Azure Local machine prerequisites

• Download the Configurator App for Azure Local on a client machine that is connected to the same network as the Azure Local machines..

• Note down:

  • The serial number for each machine.
  • Local administrator credentials to sign into each machine.

Azure prerequisites

• Make sure you have the required permissions to register Azure Local machines with Azure Arc. For more information, see Assign required permissions for Azure Local deployment.

Step 1: Configure the network and connect to Azure

Follow these steps to configure network settings and connect the machines to Azure. Start this action a few minutes after you turn on the machine.

1. Open the Configurator app. Right-click the Configurator app exe and run as administrator. Wait a few minutes for the app to open up.

   

2. Enter the machine serial number and select Next.

   

3. Sign in to the machine with local administrator credentials.

   

4. On the Azure Arc agent setup page, select Start.

   

Prerequisites tab

1. On the Prerequisites tab, verify that the minimum requirements are met and then select Next.

   

   If a requirement isn't met, the app displays a warning or errors. You can't proceed if there are errors though warnings are ignored. Resolve the errors before you proceed. For more information, see Troubleshooting registration issues.

   

Basics tab

1. On the Basics tab, configure one network interface that is connected to the internet. Select the Pencil icon to modify network interface settings.

   

2. Provide the interface name, IP allocation as static or DHCP, IP address, subnet, gateway, and preferred DNS servers. Optionally, enter an alternate DNS server.

   

   Important

   Make sure that the IPs you assign are free and not in use.

3. To specify more details, select Enter additional details.

4. On the Additional details page, provide the following inputs and then select Apply.

   

   1. Select ON to enable Remote desktop protocol. Remote desktop protocol is disabled by default.

   2. Select Public endpoint as the connectivity method.

   3. Select a time zone.

   4. Specify a preferred and an alternate NTP server to act as a time server or accept the Default. The default is time.windows.com.

   5. Set the hostname for your machine to what you specified during the preparation of Active Directory. Changing the hostname automatically reboots the system.

5. Select Next on the Basics tab.

Arc agent setup tab

1. On the Arc agent setup tab, provide the following inputs:

   

   1. The Cloud type is populated automatically as Azure.

   2. Enter a Subscription ID to register the machine.

   3. Provide a Resource group name. This resource group contains the machine and system resources that you create.

   4. Specify the Region where you want to create the resources. The region should be the same as the region where you want to deploy the Azure Local instance.

      Important

      Specify the region with spaces removed. For example, specify the East US region as EastUS.

   5. Skip the Tenant ID.

   6. Skip the Arc gateway ID.

   Important

   Make sure to verify all the inputs before you proceed. Any incorrect inputs here might result in a setup failure.

2. Select Next.

Review and apply tab

1. On the Review and apply tab, verify machine details. To modify any settings, go back. If satisfied with the current settings, select Finish. If you changed the hostname, your machines boot up automatically at this point and you must sign in again.

   

Step 2: Complete registration of machines to Azure

1. Wait for the configuration to complete. First, machine is configured with the basic details followed by registration of the machines to Azure.

2. During the Arc registration process, you must authenticate with your Azure account. The app displays a code that you must enter in the URL, displayed in the app, in order to authenticate. Follow the instructions to complete the authentication process.

   

3. Once the configuration is complete, status for Arc configuration should display Success (Open in Azure portal).

4. Repeat all steps on the other machines until the Arc configuration succeeds. Select the Open in Azure portal link.

Step 3: Verify machines are connected to Arc

1. In the Azure portal, go to the resource group that you used for bootstrapping.

2. On the resource group used to bootstrap, you should see your Arc-enabled machines. In this example, you see a single machine.