Docs
PackagesWe recommend using Azure Native.
azure.relay.HybridConnection
Explore with Pulumi AI
Manages an Azure Relay Hybrid Connection.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleNamespace = new Azure.Relay.Namespace("exampleNamespace", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
SkuName = "Standard",
Tags =
{
{ "source", "managed" },
},
});
var exampleHybridConnection = new Azure.Relay.HybridConnection("exampleHybridConnection", new()
{
ResourceGroupName = exampleResourceGroup.Name,
RelayNamespaceName = exampleNamespace.Name,
RequiresClientAuthorization = false,
UserMetadata = "testmetadata",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/relay"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleNamespace, err := relay.NewNamespace(ctx, "exampleNamespace", &relay.NamespaceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
SkuName: pulumi.String("Standard"),
Tags: pulumi.StringMap{
"source": pulumi.String("managed"),
},
})
if err != nil {
return err
}
_, err = relay.NewHybridConnection(ctx, "exampleHybridConnection", &relay.HybridConnectionArgs{
ResourceGroupName: exampleResourceGroup.Name,
RelayNamespaceName: exampleNamespace.Name,
RequiresClientAuthorization: pulumi.Bool(false),
UserMetadata: pulumi.String("testmetadata"),
})
if err != nil {
return err
}
return nil
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.skuName("Standard")
.tags(Map.of("source", "managed"))
.build());
var exampleHybridConnection = new HybridConnection("exampleHybridConnection", HybridConnectionArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.relayNamespaceName(exampleNamespace.name())
.requiresClientAuthorization(false)
.userMetadata("testmetadata")
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.relay.Namespace("exampleNamespace",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku_name="Standard",
tags={
"source": "managed",
})
example_hybrid_connection = azure.relay.HybridConnection("exampleHybridConnection",
resource_group_name=example_resource_group.name,
relay_namespace_name=example_namespace.name,
requires_client_authorization=False,
user_metadata="testmetadata")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNamespace = new azure.relay.Namespace("exampleNamespace", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
skuName: "Standard",
tags: {
source: "managed",
},
});
const exampleHybridConnection = new azure.relay.HybridConnection("exampleHybridConnection", {
resourceGroupName: exampleResourceGroup.name,
relayNamespaceName: exampleNamespace.name,
requiresClientAuthorization: false,
userMetadata: "testmetadata",
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleNamespace:
type: azure:relay:Namespace
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
skuName: Standard
tags:
source: managed
exampleHybridConnection:
type: azure:relay:HybridConnection
properties:
resourceGroupName: ${exampleResourceGroup.name}
relayNamespaceName: ${exampleNamespace.name}
requiresClientAuthorization: false
userMetadata: testmetadata
Create HybridConnection Resource
new HybridConnection(name: string, args: HybridConnectionArgs, opts?: CustomResourceOptions);@overload
def HybridConnection(resource_name: 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)
@overload
def HybridConnection(resource_name: str,
args: HybridConnectionArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args HybridConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args HybridConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HybridConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HybridConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The HybridConnection resource accepts the following input properties:
- Relay
Namespace stringName 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 stringName 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- User
Metadata 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 stringName 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 stringName 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- User
Metadata 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 StringName 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 StringName 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 String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- user
Metadata 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 stringName 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 stringName 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- user
Metadata 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_ strname 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_ strname 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 str
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. 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.
- relay
Namespace StringName 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 StringName 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 String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- user
Metadata 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) -> HybridConnectionfunc 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)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Relay
Namespace stringName The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- Resource
Group stringName 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 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Relay
Namespace stringName The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- Resource
Group stringName 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 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 String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- relay
Namespace StringName The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- resource
Group StringName 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 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 string
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- relay
Namespace stringName The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- resource
Group stringName 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 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 str
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- relay_
namespace_ strname The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- bool
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- resource_
group_ strname 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 String
Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- relay
Namespace StringName The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
- Boolean
Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created. Defaults to
true.- resource
Group StringName 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 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.