Azure Arc Gateway [Microsoft.HybridCompute/gateways]

This module deploys a Azure Arc Gateway.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/arc-gateway/main.bicep.

• Azure Arc Gateway using only the defaults
• Azure Arc Gateway according to WAF

Example 1: Azure Arc Gateway using only the defaults

This instance deploys the module with the minimum set of required parameters.

module gateway './packages/arc-gateway/main.bicep' = {
  name: 'gatewayDeployment'
  params: {
    name: 'hcgmin001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "hcgmin001"
    }
  }
}

using './packages/arc-gateway/main.bicep'

param name = 'hcgmin001'

Example 2: Azure Arc Gateway according to WAF

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module gateway './packages/arc-gateway/main.bicep' = {
  name: 'gatewayDeployment'
  params: {
    name: 'hcgwaf001'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "value": "hcgwaf001"
    }
  }
}

using './packages/arc-gateway/main.bicep'

param name = 'hcgwaf001'

Parameters

Required parameters

Optional parameters

Parameter: name

Name of the resource to create.

• Required: Yes
• Type: string

Parameter: allowedFeatures

Specifies the list of features that are enabled for this Gateway.

• Required: No
• Type: array
• Default:

  [
    '*'
  ]
  

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: gatewayType

The type of the Gateway resource.

• Required: No
• Type: string
• Default: 'Public'
• Allowed:

  [
    'Public'
  ]
  

Parameter: location

Location for all Resources.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: lock.notes

Specify the notes of the lock.

• Required: No
• Type: string

Parameter: tags

Tags of the resource.

• Required: No
• Type: object

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.