Class HybridConnection

Manages an Azure Relay Hybrid Connection.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "West Europe",
    });
    var exampleNamespace = new Azure.Relay.Namespace("exampleNamespace", new Azure.Relay.NamespaceArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        SkuName = "Standard",
        Tags = 
        {
            { "source", "managed" },
        },
    });
    var exampleHybridConnection = new Azure.Relay.HybridConnection("exampleHybridConnection", new Azure.Relay.HybridConnectionArgs
    {
        ResourceGroupName = exampleResourceGroup.Name,
        RelayNamespaceName = exampleNamespace.Name,
        RequiresClientAuthorization = false,
        UserMetadata = "testmetadata",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

HybridConnection

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Relay

Assembly: Pulumi.Azure.dll

Syntax

public class HybridConnection : CustomResource

Constructors

HybridConnection(String, HybridConnectionArgs, CustomResourceOptions)

Create a HybridConnection resource with the given unique name, arguments, and options.

Declaration

public HybridConnection(string name, HybridConnectionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
HybridConnectionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Name

Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RelayNamespaceName

The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

Declaration

public Output<string> RelayNamespaceName { get; }

Property Value

Type	Description
Output<System.String>

RequiresClientAuthorization

Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.

Declaration

public Output<bool?> RequiresClientAuthorization { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ResourceGroupName

The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

UserMetadata

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.

Declaration

public Output<string> UserMetadata { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, HybridConnectionState, CustomResourceOptions)

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

Declaration

public static HybridConnection Get(string name, Input<string> id, HybridConnectionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
HybridConnectionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
HybridConnection