1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. relay

Module relay

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource HybridConnection

class HybridConnection extends CustomResource

Manages an Azure Relay Hybrid Connection.

Example Usage

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",
});

constructor

new HybridConnection(name: string, args: HybridConnectionArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HybridConnectionState, opts?: pulumi.CustomResourceOptions): HybridConnection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is HybridConnection

Returns true if the given object is an instance of HybridConnection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

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

property relayNamespaceName

public relayNamespaceName: pulumi.Output<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.

property requiresClientAuthorization

public requiresClientAuthorization: pulumi.Output<boolean | undefined>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userMetadata

public userMetadata: pulumi.Output<string | undefined>;

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.

Resource Namespace

class Namespace extends CustomResource

Manages an Azure Relay Namespace.

Example Usage

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: "example",
    },
});

constructor

new Namespace(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

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

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Namespace

Returns true if the given object is an instance of Namespace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

property metricId

public metricId: pulumi.Output<string>;

The Identifier for Azure Insights metrics.

property name

public name: pulumi.Output<string>;

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

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property primaryKey

public primaryKey: pulumi.Output<string>;

The primary access key for the authorization rule RootManageSharedAccessKey.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the Azure Relay Namespace.

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The secondary access key for the authorization rule RootManageSharedAccessKey.

property skuName

public skuName: pulumi.Output<string>;

The name of the SKU to use. At this time the only supported value is Standard.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface HybridConnectionArgs

interface HybridConnectionArgs

The set of arguments for constructing a HybridConnection resource.

property name

name?: pulumi.Input<string>;

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

property relayNamespaceName

relayNamespaceName: pulumi.Input<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.

property requiresClientAuthorization

requiresClientAuthorization?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<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.

property userMetadata

userMetadata?: pulumi.Input<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.

interface HybridConnectionState

interface HybridConnectionState

Input properties used for looking up and filtering HybridConnection resources.

property name

name?: pulumi.Input<string>;

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

property relayNamespaceName

relayNamespaceName?: pulumi.Input<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.

property requiresClientAuthorization

requiresClientAuthorization?: pulumi.Input<boolean>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<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.

property userMetadata

userMetadata?: pulumi.Input<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.

interface NamespaceArgs

interface NamespaceArgs

The set of arguments for constructing a Namespace resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the Azure Relay Namespace.

property skuName

skuName: pulumi.Input<string>;

The name of the SKU to use. At this time the only supported value is Standard.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface NamespaceState

interface NamespaceState

Input properties used for looking up and filtering Namespace resources.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

property metricId

metricId?: pulumi.Input<string>;

The Identifier for Azure Insights metrics.

property name

name?: pulumi.Input<string>;

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

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property primaryKey

primaryKey?: pulumi.Input<string>;

The primary access key for the authorization rule RootManageSharedAccessKey.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the Azure Relay Namespace.

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The secondary access key for the authorization rule RootManageSharedAccessKey.

property skuName

skuName?: pulumi.Input<string>;

The name of the SKU to use. At this time the only supported value is Standard.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.