Share via


Microsoft.HybridConnectivity endpoints

Bicep resource definition

The endpoints 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.HybridConnectivity/endpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridConnectivity/endpoints@2024-12-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    resourceId: 'string'
    type: 'string'
  }
}

Property Values

Microsoft.HybridConnectivity/endpoints

Name Description Value
name The resource name string (required)
properties The endpoint properties. EndpointProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

EndpointProperties

Name Description Value
resourceId The resource Id of the connectivity endpoint (optional). string
type The type of endpoint. 'custom'
'default' (required)

ARM template resource definition

The endpoints 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.HybridConnectivity/endpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridConnectivity/endpoints",
  "apiVersion": "2024-12-01",
  "name": "string",
  "properties": {
    "resourceId": "string",
    "type": "string"
  }
}

Property Values

Microsoft.HybridConnectivity/endpoints

Name Description Value
apiVersion The api version '2024-12-01'
name The resource name string (required)
properties The endpoint properties. EndpointProperties
type The resource type 'Microsoft.HybridConnectivity/endpoints'

EndpointProperties

Name Description Value
resourceId The resource Id of the connectivity endpoint (optional). string
type The type of endpoint. 'custom'
'default' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The endpoints 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.HybridConnectivity/endpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridConnectivity/endpoints@2024-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      resourceId = "string"
      type = "string"
    }
  }
}

Property Values

Microsoft.HybridConnectivity/endpoints

Name Description Value
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The endpoint properties. EndpointProperties
type The resource type "Microsoft.HybridConnectivity/endpoints@2024-12-01"

EndpointProperties

Name Description Value
resourceId The resource Id of the connectivity endpoint (optional). string
type The type of endpoint. 'custom'
'default' (required)