Share via

Microsoft.HybridCompute gateways

  • Article

Bicep resource definition

The gateways resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridCompute/gateways resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridCompute/gateways@2025-02-19-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    allowedFeatures: [
      'string'
    ]
    gatewayType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

GatewayProperties

Name Description Value
allowedFeatures Specifies the list of features that are enabled for this Gateway. string[]
gatewayType The type of the Gateway resource. 'Public'

Microsoft.HybridCompute/gateways

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Hybrid Compute Gateway properties GatewayProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Hybrid Compute Gateway AVM Resource Module for Hybrid Compute Gateway

ARM template resource definition

The gateways resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridCompute/gateways resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridCompute/gateways",
  "apiVersion": "2025-02-19-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "allowedFeatures": [ "string" ],
    "gatewayType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

GatewayProperties

Name Description Value
allowedFeatures Specifies the list of features that are enabled for this Gateway. string[]
gatewayType The type of the Gateway resource. 'Public'

Microsoft.HybridCompute/gateways

Name Description Value
apiVersion The api version '2025-02-19-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Hybrid Compute Gateway properties GatewayProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HybridCompute/gateways'

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The gateways resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridCompute/gateways resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridCompute/gateways@2025-02-19-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      allowedFeatures = [
        "string"
      ]
      gatewayType = "string"
    }
  }
}

Property Values

GatewayProperties

Name Description Value
allowedFeatures Specifies the list of features that are enabled for this Gateway. string[]
gatewayType The type of the Gateway resource. 'Public'

Microsoft.HybridCompute/gateways

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Hybrid Compute Gateway properties GatewayProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HybridCompute/gateways@2025-02-19-preview"

TrackedResourceTags

Name Description Value