relay

Documentation

Overview

nolint: lll

nolint: lll

Index

• type HybridConnection
  • func GetHybridConnection(ctx *pulumi.Context, name string, id pulumi.IDInput, ...) (*HybridConnection, error)
  • func NewHybridConnection(ctx *pulumi.Context, name string, args *HybridConnectionArgs, ...) (*HybridConnection, error)
• type HybridConnectionArgs
  • func (HybridConnectionArgs) ElementType() reflect.Type
• type HybridConnectionState
  • func (HybridConnectionState) ElementType() reflect.Type
• type Namespace
  • func GetNamespace(ctx *pulumi.Context, name string, id pulumi.IDInput, state *NamespaceState, ...) (*Namespace, error)
  • func NewNamespace(ctx *pulumi.Context, name string, args *NamespaceArgs, ...) (*Namespace, error)
• type NamespaceArgs
  • func (NamespaceArgs) ElementType() reflect.Type
• type NamespaceState
  • func (NamespaceState) ElementType() reflect.Type

Types

type HybridConnection

type HybridConnection struct {
	pulumi.CustomResourceState

	// Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	RelayNamespaceName pulumi.StringOutput `pulumi:"relayNamespaceName"`
	// Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.
	RequiresClientAuthorization pulumi.BoolPtrOutput `pulumi:"requiresClientAuthorization"`
	// The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// 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.
	UserMetadata pulumi.StringPtrOutput `pulumi:"userMetadata"`
}

Manages an Azure Relay Hybrid Connection.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/relay_hybrid_connection.html.markdown.

func GetHybridConnection

func GetHybridConnection(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HybridConnectionState, opts ...pulumi.ResourceOption) (*HybridConnection, error)

GetHybridConnection gets an existing HybridConnection resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewHybridConnection

func NewHybridConnection(ctx *pulumi.Context,
	name string, args *HybridConnectionArgs, opts ...pulumi.ResourceOption) (*HybridConnection, error)

NewHybridConnection registers a new resource with the given unique name, arguments, and options.

type HybridConnectionArgs

type HybridConnectionArgs struct {
	// Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	RelayNamespaceName pulumi.StringInput
	// Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.
	RequiresClientAuthorization pulumi.BoolPtrInput
	// The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// 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.
	UserMetadata pulumi.StringPtrInput
}

The set of arguments for constructing a HybridConnection resource.

func (HybridConnectionArgs) ElementType

func (HybridConnectionArgs) ElementType() reflect.Type

type HybridConnectionState

type HybridConnectionState struct {
	// Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	RelayNamespaceName pulumi.StringPtrInput
	// Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.
	RequiresClientAuthorization pulumi.BoolPtrInput
	// The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// 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.
	UserMetadata pulumi.StringPtrInput
}

func (HybridConnectionState) ElementType

func (HybridConnectionState) ElementType() reflect.Type

type Namespace

type Namespace struct {
	pulumi.CustomResourceState

	// Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The Identifier for Azure Insights metrics.
	MetricId pulumi.StringOutput `pulumi:"metricId"`
	// Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The primary connection string for the authorization rule `RootManageSharedAccessKey`.
	PrimaryConnectionString pulumi.StringOutput `pulumi:"primaryConnectionString"`
	// The primary access key for the authorization rule `RootManageSharedAccessKey`.
	PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"`
	// The name of the resource group in which to create the Azure Relay Namespace.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The secondary connection string for the authorization rule `RootManageSharedAccessKey`.
	SecondaryConnectionString pulumi.StringOutput `pulumi:"secondaryConnectionString"`
	// The secondary access key for the authorization rule `RootManageSharedAccessKey`.
	SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"`
	// The name of the SKU to use. At this time the only supported value is `Standard`.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages an Azure Relay Namespace.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/relay_namespace.html.markdown.

func GetNamespace

func GetNamespace(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *NamespaceState, opts ...pulumi.ResourceOption) (*Namespace, error)

GetNamespace gets an existing Namespace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNamespace

func NewNamespace(ctx *pulumi.Context,
	name string, args *NamespaceArgs, opts ...pulumi.ResourceOption) (*Namespace, error)

NewNamespace registers a new resource with the given unique name, arguments, and options.

type NamespaceArgs

type NamespaceArgs struct {
	// Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the resource group in which to create the Azure Relay Namespace.
	ResourceGroupName pulumi.StringInput
	// The name of the SKU to use. At this time the only supported value is `Standard`.
	SkuName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Namespace resource.

func (NamespaceArgs) ElementType

func (NamespaceArgs) ElementType() reflect.Type

type NamespaceState

type NamespaceState struct {
	// Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The Identifier for Azure Insights metrics.
	MetricId pulumi.StringPtrInput
	// Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The primary connection string for the authorization rule `RootManageSharedAccessKey`.
	PrimaryConnectionString pulumi.StringPtrInput
	// The primary access key for the authorization rule `RootManageSharedAccessKey`.
	PrimaryKey pulumi.StringPtrInput
	// The name of the resource group in which to create the Azure Relay Namespace.
	ResourceGroupName pulumi.StringPtrInput
	// The secondary connection string for the authorization rule `RootManageSharedAccessKey`.
	SecondaryConnectionString pulumi.StringPtrInput
	// The secondary access key for the authorization rule `RootManageSharedAccessKey`.
	SecondaryKey pulumi.StringPtrInput
	// The name of the SKU to use. At this time the only supported value is `Standard`.
	SkuName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (NamespaceState) ElementType

func (NamespaceState) ElementType() reflect.Type