Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. relay
  5. HybridConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.relay.HybridConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Description of hybrid connection resource. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2017-04-01.

Other available API versions: 2024-01-01.

Example Usage

RelayHybridConnectionCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var hybridConnection = new AzureNative.Relay.HybridConnection("hybridConnection", new()
    {
        HybridConnectionName = "example-Relay-Hybrid-01",
        NamespaceName = "example-RelayNamespace-01",
        RequiresClientAuthorization = true,
        ResourceGroupName = "resourcegroup",
    });

});
Copy
package main

import (
	relay "github.com/pulumi/pulumi-azure-native-sdk/relay/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := relay.NewHybridConnection(ctx, "hybridConnection", &relay.HybridConnectionArgs{
			HybridConnectionName:        pulumi.String("example-Relay-Hybrid-01"),
			NamespaceName:               pulumi.String("example-RelayNamespace-01"),
			RequiresClientAuthorization: pulumi.Bool(true),
			ResourceGroupName:           pulumi.String("resourcegroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.relay.HybridConnection;
import com.pulumi.azurenative.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 hybridConnection = new HybridConnection("hybridConnection", HybridConnectionArgs.builder()
            .hybridConnectionName("example-Relay-Hybrid-01")
            .namespaceName("example-RelayNamespace-01")
            .requiresClientAuthorization(true)
            .resourceGroupName("resourcegroup")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const hybridConnection = new azure_native.relay.HybridConnection("hybridConnection", {
    hybridConnectionName: "example-Relay-Hybrid-01",
    namespaceName: "example-RelayNamespace-01",
    requiresClientAuthorization: true,
    resourceGroupName: "resourcegroup",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

hybrid_connection = azure_native.relay.HybridConnection("hybridConnection",
    hybrid_connection_name="example-Relay-Hybrid-01",
    namespace_name="example-RelayNamespace-01",
    requires_client_authorization=True,
    resource_group_name="resourcegroup")
Copy
resources:
  hybridConnection:
    type: azure-native:relay:HybridConnection
    properties:
      hybridConnectionName: example-Relay-Hybrid-01
      namespaceName: example-RelayNamespace-01
      requiresClientAuthorization: true
      resourceGroupName: resourcegroup
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,
                     namespace_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     hybrid_connection_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-native: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 hybridConnectionResource = new AzureNative.Relay.HybridConnection("hybridConnectionResource", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    HybridConnectionName = "string",
    RequiresClientAuthorization = false,
    UserMetadata = "string",
});
Copy
example, err := relay.NewHybridConnection(ctx, "hybridConnectionResource", &relay.HybridConnectionArgs{
	NamespaceName:               "string",
	ResourceGroupName:           "string",
	HybridConnectionName:        "string",
	RequiresClientAuthorization: false,
	UserMetadata:                "string",
})
Copy
var hybridConnectionResource = new HybridConnection("hybridConnectionResource", HybridConnectionArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .hybridConnectionName("string")
    .requiresClientAuthorization(false)
    .userMetadata("string")
    .build());
Copy
hybrid_connection_resource = azure_native.relay.HybridConnection("hybridConnectionResource",
    namespace_name=string,
    resource_group_name=string,
    hybrid_connection_name=string,
    requires_client_authorization=False,
    user_metadata=string)
Copy
const hybridConnectionResource = new azure_native.relay.HybridConnection("hybridConnectionResource", {
    namespaceName: "string",
    resourceGroupName: "string",
    hybridConnectionName: "string",
    requiresClientAuthorization: false,
    userMetadata: "string",
});
Copy
type: azure-native:relay:HybridConnection
properties:
    hybridConnectionName: string
    namespaceName: 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:

NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
HybridConnectionName Changes to this property will trigger replacement. string
The hybrid connection name.
RequiresClientAuthorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
HybridConnectionName Changes to this property will trigger replacement. string
The hybrid connection name.
RequiresClientAuthorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
hybridConnectionName Changes to this property will trigger replacement. String
The hybrid connection name.
requiresClientAuthorization Boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
hybridConnectionName Changes to this property will trigger replacement. string
The hybrid connection name.
requiresClientAuthorization boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
hybrid_connection_name Changes to this property will trigger replacement. str
The hybrid connection name.
requires_client_authorization bool
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
hybridConnectionName Changes to this property will trigger replacement. String
The hybrid connection name.
requiresClientAuthorization Boolean
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
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:

CreatedAt string
The time the hybrid connection was created.
Id string
The provider-assigned unique ID for this managed resource.
ListenerCount int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string
The time the namespace was updated.
CreatedAt string
The time the hybrid connection was created.
Id string
The provider-assigned unique ID for this managed resource.
ListenerCount int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string
The time the namespace was updated.
createdAt String
The time the hybrid connection was created.
id String
The provider-assigned unique ID for this managed resource.
listenerCount Integer
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location String
The geo-location where the resource lives
name String
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String
The time the namespace was updated.
createdAt string
The time the hybrid connection was created.
id string
The provider-assigned unique ID for this managed resource.
listenerCount number
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location string
The geo-location where the resource lives
name string
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt string
The time the namespace was updated.
created_at str
The time the hybrid connection was created.
id str
The provider-assigned unique ID for this managed resource.
listener_count int
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location str
The geo-location where the resource lives
name str
The name of the resource
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updated_at str
The time the namespace was updated.
createdAt String
The time the hybrid connection was created.
id String
The provider-assigned unique ID for this managed resource.
listenerCount Number
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
location String
The geo-location where the resource lives
name String
The name of the resource
systemData Property Map
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String
The time the namespace was updated.

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:relay:HybridConnection example-Relay-Hybrid-01 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native