Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. relay
  5. HybridConnection

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.relay.HybridConnection

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Azure Relay Hybrid Connection.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleNamespace = new azure.relay.Namespace("example", {
    name: "example-relay",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "Standard",
    tags: {
        source: "managed",
    },
});
const exampleHybridConnection = new azure.relay.HybridConnection("example", {
    name: "acctestrnhc-%d",
    resourceGroupName: example.name,
    relayNamespaceName: exampleNamespace.name,
    requiresClientAuthorization: false,
    userMetadata: "testmetadata",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_namespace = azure.relay.Namespace("example",
    name="example-relay",
    location=example.location,
    resource_group_name=example.name,
    sku_name="Standard",
    tags={
        "source": "managed",
    })
example_hybrid_connection = azure.relay.HybridConnection("example",
    name="acctestrnhc-%d",
    resource_group_name=example.name,
    relay_namespace_name=example_namespace.name,
    requires_client_authorization=False,
    user_metadata="testmetadata")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/relay"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := relay.NewNamespace(ctx, "example", &relay.NamespaceArgs{
			Name:              pulumi.String("example-relay"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("Standard"),
			Tags: pulumi.StringMap{
				"source": pulumi.String("managed"),
			},
		})
		if err != nil {
			return err
		}
		_, err = relay.NewHybridConnection(ctx, "example", &relay.HybridConnectionArgs{
			Name:                        pulumi.String("acctestrnhc-%d"),
			ResourceGroupName:           example.Name,
			RelayNamespaceName:          exampleNamespace.Name,
			RequiresClientAuthorization: pulumi.Bool(false),
			UserMetadata:                pulumi.String("testmetadata"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleNamespace = new Azure.Relay.Namespace("example", new()
    {
        Name = "example-relay",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "Standard",
        Tags = 
        {
            { "source", "managed" },
        },
    });

    var exampleHybridConnection = new Azure.Relay.HybridConnection("example", new()
    {
        Name = "acctestrnhc-%d",
        ResourceGroupName = example.Name,
        RelayNamespaceName = exampleNamespace.Name,
        RequiresClientAuthorization = false,
        UserMetadata = "testmetadata",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.relay.Namespace;
import com.pulumi.azure.relay.NamespaceArgs;
import com.pulumi.azure.relay.HybridConnection;
import com.pulumi.azure.relay.HybridConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
            .name("example-relay")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("Standard")
            .tags(Map.of("source", "managed"))
            .build());

        var exampleHybridConnection = new HybridConnection("exampleHybridConnection", HybridConnectionArgs.builder()
            .name("acctestrnhc-%d")
            .resourceGroupName(example.name())
            .relayNamespaceName(exampleNamespace.name())
            .requiresClientAuthorization(false)
            .userMetadata("testmetadata")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleNamespace:
    type: azure:relay:Namespace
    name: example
    properties:
      name: example-relay
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: Standard
      tags:
        source: managed
  exampleHybridConnection:
    type: azure:relay:HybridConnection
    name: example
    properties:
      name: acctestrnhc-%d
      resourceGroupName: ${example.name}
      relayNamespaceName: ${exampleNamespace.name}
      requiresClientAuthorization: false
      userMetadata: testmetadata
Copy

Create HybridConnection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HybridConnection(name: string, args: HybridConnectionArgs, opts?: CustomResourceOptions);
@overload
def HybridConnection(resource_name: str,
                     args: HybridConnectionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def HybridConnection(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     relay_namespace_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     name: Optional[str] = None,
                     requires_client_authorization: Optional[bool] = None,
                     user_metadata: Optional[str] = None)
func NewHybridConnection(ctx *Context, name string, args HybridConnectionArgs, opts ...ResourceOption) (*HybridConnection, error)
public HybridConnection(string name, HybridConnectionArgs args, CustomResourceOptions? opts = null)
public HybridConnection(String name, HybridConnectionArgs args)
public HybridConnection(String name, HybridConnectionArgs args, CustomResourceOptions options)

type: azure:relay:HybridConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azureHybridConnectionResource = new Azure.Relay.HybridConnection("azureHybridConnectionResource", new()
{
    RelayNamespaceName = "string",
    ResourceGroupName = "string",
    Name = "string",
    RequiresClientAuthorization = false,
    UserMetadata = "string",
});
Copy
example, err := relay.NewHybridConnection(ctx, "azureHybridConnectionResource", &relay.HybridConnectionArgs{
	RelayNamespaceName:          pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	Name:                        pulumi.String("string"),
	RequiresClientAuthorization: pulumi.Bool(false),
	UserMetadata:                pulumi.String("string"),
})
Copy
var azureHybridConnectionResource = new HybridConnection("azureHybridConnectionResource", HybridConnectionArgs.builder()
    .relayNamespaceName("string")
    .resourceGroupName("string")
    .name("string")
    .requiresClientAuthorization(false)
    .userMetadata("string")
    .build());
Copy
azure_hybrid_connection_resource = azure.relay.HybridConnection("azureHybridConnectionResource",
    relay_namespace_name="string",
    resource_group_name="string",
    name="string",
    requires_client_authorization=False,
    user_metadata="string")
Copy
const azureHybridConnectionResource = new azure.relay.HybridConnection("azureHybridConnectionResource", {
    relayNamespaceName: "string",
    resourceGroupName: "string",
    name: "string",
    requiresClientAuthorization: false,
    userMetadata: "string",
});
Copy
type: azure:relay:HybridConnection
properties:
    name: string
    relayNamespaceName: string
    requiresClientAuthorization: false
    resourceGroupName: string
    userMetadata: string
Copy

HybridConnection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HybridConnection resource accepts the following input properties:

RelayNamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RequiresClientAuthorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
RelayNamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RequiresClientAuthorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
relayNamespaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. Boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
relayNamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
userMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
relay_namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requires_client_authorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
user_metadata str
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
relayNamespaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. Boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

Outputs

All input properties are implicitly available as output properties. Additionally, the HybridConnection resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing HybridConnection Resource

Get an existing HybridConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HybridConnectionState, opts?: CustomResourceOptions): HybridConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        relay_namespace_name: Optional[str] = None,
        requires_client_authorization: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        user_metadata: Optional[str] = None) -> HybridConnection
func GetHybridConnection(ctx *Context, name string, id IDInput, state *HybridConnectionState, opts ...ResourceOption) (*HybridConnection, error)
public static HybridConnection Get(string name, Input<string> id, HybridConnectionState? state, CustomResourceOptions? opts = null)
public static HybridConnection get(String name, Output<String> id, HybridConnectionState state, CustomResourceOptions options)
resources:  _:    type: azure:relay:HybridConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RelayNamespaceName Changes to this property will trigger replacement. string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RequiresClientAuthorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
Name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RelayNamespaceName Changes to this property will trigger replacement. string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
RequiresClientAuthorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
UserMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
name Changes to this property will trigger replacement. String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
relayNamespaceName Changes to this property will trigger replacement. String
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. Boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
name Changes to this property will trigger replacement. string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
relayNamespaceName Changes to this property will trigger replacement. string
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
userMetadata string
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
name Changes to this property will trigger replacement. str
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
relay_namespace_name Changes to this property will trigger replacement. str
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requires_client_authorization Changes to this property will trigger replacement. bool
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
user_metadata str
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
name Changes to this property will trigger replacement. String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
relayNamespaceName Changes to this property will trigger replacement. String
The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
requiresClientAuthorization Changes to this property will trigger replacement. Boolean
Specify if client authorization is needed for this hybrid connection. Changing this forces a new resource to be created. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
userMetadata String
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.

Import

Relay Hybrid Connection’s can be imported using the resource id, e.g.

$ pulumi import azure:relay/hybridConnection:HybridConnection relay1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Relay/namespaces/relay1/hybridConnections/hconn1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure