Skip to main content

Task 08: Arc Gateway

Runbook Azure

DOCUMENT CATEGORY: Runbook
SCOPE: Arc Gateway deployment
PURPOSE: Create Arc Gateway for hybrid server connectivity
MASTER REFERENCE: Microsoft Learn - Arc Gateway

Status: Active

Overview​

This task deploys an Azure Arc Gateway resource. The Arc Gateway provides a centralized network endpoint that Arc-enabled servers use to communicate with Azure services, reducing the number of required firewall rules for on-premises infrastructure.

Task Classification

Execution Target: Azure-Only (control-plane API operation) Tab Profile: 3 tabs — Azure Portal · PowerShell · Azure CLI

Decide before you deploy the cluster

The Arc gateway can only be enabled during deployment of a new Azure Local instance (software version 2506 or later). It cannot be enabled after deployment. Decide whether to use it, and create the gateway resource in the subscription that will host the instance, before you register the machines.

If your environment inspects or terminates TLS, Arc gateway is not recommended and does not support TLS-terminating proxies. Skip TLS inspection for the gateway endpoint (<your URL prefix>.gw.arc.azure.com).

Source: Overview of Azure Arc gateway for Azure Local and Azure Arc gateway limitations.

Azure API Resource

The Arc Gateway uses the Microsoft.HybridCompute/gateways resource type. As of this writing, it requires the AzAPI provider in Terraform (not yet in azurerm).

Terraform Reference

Module: azurelocal-toolkit File: arcgw.tf Mode: Cluster

Components Created​

ResourceName PatternPurpose
Arc Gatewayarcgw-{instance}{env}{location}-{env}-{region}-01Centralized Arc connectivity

Arc Gateway Configuration​

SettingValueSource
NamePer naming conventionnetworking.outbound.arc_gateway.name
Resource GroupCluster RGnetworking.outbound.arc_gateway.resource_group
Gateway TypePublicOnly valid value currently
Allowed FeaturesAll (*)Default

Prerequisites​

  • Microsoft.HybridCompute resource provider registered
  • Resource group for Arc Gateway exists
  • Contributor role on target resource group

Values from infrastructure.yml​

The script reads these keys from infrastructure.yml (schema 5). Each key, with its type, default and example, is in the variables reference.

azure.tenant_id, azure.subscription_id, azure.location, azure.resource_group, tags
scenario.outbound_path
networking.outbound.arc_gateway.name, .resource_group

Single Subscription Model​

Landing Zone Placement​

FieldValueConfig Path
SubscriptionCustomer subscriptionlanding_zone.subscriptions[].id
Resource Grouprg-{cluster}-{env}-{region}-01networking.outbound.arc_gateway.resource_group
Arc Gateway NamePer confignetworking.outbound.arc_gateway.name

Execution Options​

Azure Portal​

When to use: Learning Azure Local, single deployment, prefer visual interface

Procedure​

  1. Register Resource Provider (if not already):
  • Subscription → Resource providers → Search Microsoft.HybridCompute → Register
  1. Create Arc Gateway:
  • Search for Arc Gateways (or Azure Arc → Arc Gateways)
  • Click + Create
    FieldValueSource
    NamePer confignetworking.outbound.arc_gateway.name
    SubscriptionTarget subscriptionlanding_zone.subscriptions[].id
    Resource GroupCluster RGnetworking.outbound.arc_gateway.resource_group
    RegionYour regionazure.location
    Gateway TypePublicOnly option
  1. Review + create: Verify → Click Create → Record the Gateway Endpoint URL

  2. Note the Gateway ID: Copy the full resource ID — it will be needed during Azure Local cluster deployment:

/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.HybridCompute/gateways/{name}

Validation​

  • Arc Gateway provisioning state: Succeeded
  • Gateway endpoint URL recorded
  • Resource ID saved in infrastructure.yml at networking.outbound.arc_gateway.name

Validation​

  • Arc Gateway provisioning state: Succeeded
  • Gateway endpoint URL available
  • Resource ID recorded for cluster deployment

CAF/WAF Landing Zone Model​

In the CAF/WAF model, the Arc Gateway is typically deployed in the Management or Identity subscription, depending on governance structure.

Landing Zone Placement​

FieldValueConfig Path
SubscriptionManagement subscriptionlanding_zone.subscriptions[].id
Resource GroupPer confignetworking.outbound.arc_gateway.resource_group
Arc Gateway NamePer confignetworking.outbound.arc_gateway.name

Execution Options​

Azure Portal​

Follow the same procedure as Single Subscription → Azure Portal, targeting the Management subscription.

Validation​

  • Arc Gateway in Management subscription
  • Gateway endpoint URL accessible from on-premises network

Validation​

  • Arc Gateway in correct subscription
  • Endpoint reachable for cluster registration

Troubleshooting​

IssueRoot CauseRemediation
Resource provider not registeredMicrosoft.HybridCompute not enabledRegister via Subscription → Resource providers
403 Forbidden on REST APIInsufficient permissionsNeed Contributor on resource group
Gateway endpoint not availableDeployment still propagatingWait 5 minutes and query again
Arc agent cannot reach gatewayFirewall blocking gateway endpointAllow *.gw.arc.azure.net on port 443


Alternatives​

The procedures in this task use the methods shown in the tabs above. The toolkit is PowerShell 7 only and has no Bash scripts. A few tasks that act on Azure also have an Azure CLI script written in PowerShell. The script status page of the toolkit lists which task has which script.

PreviousUpNext
Task 07: NAT GatewayManual Deployment IndexTask 09: Log Analytics Workspace

Version Control

  • Created: 2025-09-15 by Hybrid Cloud Solutions
  • Last Updated: 2026-03-03 by Hybrid Cloud Solutions
  • Version: 4.0.0
  • Tags: azure-local, arc-gateway, hybrid, connectivity
  • Keywords: Arc Gateway, Azure Arc, hybrid compute, gateway endpoint, Arc-enabled servers
  • Author: Hybrid Cloud Solutions

Version Control​

VersionDateAuthorChanges
1.0.02025-03-25Azure Local CloudInitial release