relay

package
v4.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/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
	})
}

```

## Import

Relay Hybrid Connection's can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:relay/hybridConnection:HybridConnection relay1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Relay/namespaces/relay1/hybridConnections/hconn1

```

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.

func (*HybridConnection) ElementType 

func (*HybridConnection) ElementType() reflect.Type

func (*HybridConnection) ToHybridConnectionOutput 

func (i *HybridConnection) ToHybridConnectionOutput() HybridConnectionOutput

func (*HybridConnection) ToHybridConnectionOutputWithContext 

func (i *HybridConnection) ToHybridConnectionOutputWithContext(ctx context.Context) HybridConnectionOutput

func (*HybridConnection) ToHybridConnectionPtrOutput 

func (i *HybridConnection) ToHybridConnectionPtrOutput() HybridConnectionPtrOutput

func (*HybridConnection) ToHybridConnectionPtrOutputWithContext 

func (i *HybridConnection) ToHybridConnectionPtrOutputWithContext(ctx context.Context) HybridConnectionPtrOutput

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 HybridConnectionArray 

type HybridConnectionArray []HybridConnectionInput

func (HybridConnectionArray) ElementType 

func (HybridConnectionArray) ElementType() reflect.Type

func (HybridConnectionArray) ToHybridConnectionArrayOutput 

func (i HybridConnectionArray) ToHybridConnectionArrayOutput() HybridConnectionArrayOutput

func (HybridConnectionArray) ToHybridConnectionArrayOutputWithContext 

func (i HybridConnectionArray) ToHybridConnectionArrayOutputWithContext(ctx context.Context) HybridConnectionArrayOutput

type HybridConnectionArrayInput 

type HybridConnectionArrayInput interface {
	pulumi.Input

	ToHybridConnectionArrayOutput() HybridConnectionArrayOutput
	ToHybridConnectionArrayOutputWithContext(context.Context) HybridConnectionArrayOutput
}

HybridConnectionArrayInput is an input type that accepts HybridConnectionArray and HybridConnectionArrayOutput values. You can construct a concrete instance of `HybridConnectionArrayInput` via: 

HybridConnectionArray{ HybridConnectionArgs{...} }

type HybridConnectionArrayOutput 

type HybridConnectionArrayOutput struct{ *pulumi.OutputState }

func (HybridConnectionArrayOutput) ElementType 

func (HybridConnectionArrayOutput) ElementType() reflect.Type

func (HybridConnectionArrayOutput) Index 

func (o HybridConnectionArrayOutput) Index(i pulumi.IntInput) HybridConnectionOutput

func (HybridConnectionArrayOutput) ToHybridConnectionArrayOutput 

func (o HybridConnectionArrayOutput) ToHybridConnectionArrayOutput() HybridConnectionArrayOutput

func (HybridConnectionArrayOutput) ToHybridConnectionArrayOutputWithContext 

func (o HybridConnectionArrayOutput) ToHybridConnectionArrayOutputWithContext(ctx context.Context) HybridConnectionArrayOutput

type HybridConnectionInput 

type HybridConnectionInput interface {
	pulumi.Input

	ToHybridConnectionOutput() HybridConnectionOutput
	ToHybridConnectionOutputWithContext(ctx context.Context) HybridConnectionOutput
}

type HybridConnectionMap 

type HybridConnectionMap map[string]HybridConnectionInput

func (HybridConnectionMap) ElementType 

func (HybridConnectionMap) ElementType() reflect.Type

func (HybridConnectionMap) ToHybridConnectionMapOutput 

func (i HybridConnectionMap) ToHybridConnectionMapOutput() HybridConnectionMapOutput

func (HybridConnectionMap) ToHybridConnectionMapOutputWithContext 

func (i HybridConnectionMap) ToHybridConnectionMapOutputWithContext(ctx context.Context) HybridConnectionMapOutput

type HybridConnectionMapInput 

type HybridConnectionMapInput interface {
	pulumi.Input

	ToHybridConnectionMapOutput() HybridConnectionMapOutput
	ToHybridConnectionMapOutputWithContext(context.Context) HybridConnectionMapOutput
}

HybridConnectionMapInput is an input type that accepts HybridConnectionMap and HybridConnectionMapOutput values. You can construct a concrete instance of `HybridConnectionMapInput` via: 

HybridConnectionMap{ "key": HybridConnectionArgs{...} }

type HybridConnectionMapOutput 

type HybridConnectionMapOutput struct{ *pulumi.OutputState }

func (HybridConnectionMapOutput) ElementType 

func (HybridConnectionMapOutput) ElementType() reflect.Type

func (HybridConnectionMapOutput) MapIndex 

func (o HybridConnectionMapOutput) MapIndex(k pulumi.StringInput) HybridConnectionOutput

func (HybridConnectionMapOutput) ToHybridConnectionMapOutput 

func (o HybridConnectionMapOutput) ToHybridConnectionMapOutput() HybridConnectionMapOutput

func (HybridConnectionMapOutput) ToHybridConnectionMapOutputWithContext 

func (o HybridConnectionMapOutput) ToHybridConnectionMapOutputWithContext(ctx context.Context) HybridConnectionMapOutput

type HybridConnectionOutput 

type HybridConnectionOutput struct {
	*pulumi.OutputState
}

func (HybridConnectionOutput) ElementType 

func (HybridConnectionOutput) ElementType() reflect.Type

func (HybridConnectionOutput) ToHybridConnectionOutput 

func (o HybridConnectionOutput) ToHybridConnectionOutput() HybridConnectionOutput

func (HybridConnectionOutput) ToHybridConnectionOutputWithContext 

func (o HybridConnectionOutput) ToHybridConnectionOutputWithContext(ctx context.Context) HybridConnectionOutput

func (HybridConnectionOutput) ToHybridConnectionPtrOutput 

func (o HybridConnectionOutput) ToHybridConnectionPtrOutput() HybridConnectionPtrOutput

func (HybridConnectionOutput) ToHybridConnectionPtrOutputWithContext 

func (o HybridConnectionOutput) ToHybridConnectionPtrOutputWithContext(ctx context.Context) HybridConnectionPtrOutput

type HybridConnectionPtrInput 

type HybridConnectionPtrInput interface {
	pulumi.Input

	ToHybridConnectionPtrOutput() HybridConnectionPtrOutput
	ToHybridConnectionPtrOutputWithContext(ctx context.Context) HybridConnectionPtrOutput
}

type HybridConnectionPtrOutput 

type HybridConnectionPtrOutput struct {
	*pulumi.OutputState
}

func (HybridConnectionPtrOutput) ElementType 

func (HybridConnectionPtrOutput) ElementType() reflect.Type

func (HybridConnectionPtrOutput) ToHybridConnectionPtrOutput 

func (o HybridConnectionPtrOutput) ToHybridConnectionPtrOutput() HybridConnectionPtrOutput

func (HybridConnectionPtrOutput) ToHybridConnectionPtrOutputWithContext 

func (o HybridConnectionPtrOutput) ToHybridConnectionPtrOutputWithContext(ctx context.Context) HybridConnectionPtrOutput

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.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/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
		}
		_, err = relay.NewNamespace(ctx, "exampleNamespace", &relay.NamespaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SkuName:           pulumi.String("Standard"),
			Tags: pulumi.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Azure Relay Namespace's can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:relay/namespace:Namespace relay1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Relay/namespaces/relay1

```

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.

func (*Namespace) ElementType 

func (*Namespace) ElementType() reflect.Type

func (*Namespace) ToNamespaceOutput 

func (i *Namespace) ToNamespaceOutput() NamespaceOutput

func (*Namespace) ToNamespaceOutputWithContext 

func (i *Namespace) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput

func (*Namespace) ToNamespacePtrOutput 

func (i *Namespace) ToNamespacePtrOutput() NamespacePtrOutput

func (*Namespace) ToNamespacePtrOutputWithContext 

func (i *Namespace) ToNamespacePtrOutputWithContext(ctx context.Context) NamespacePtrOutput

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 NamespaceArray 

type NamespaceArray []NamespaceInput

func (NamespaceArray) ElementType 

func (NamespaceArray) ElementType() reflect.Type

func (NamespaceArray) ToNamespaceArrayOutput 

func (i NamespaceArray) ToNamespaceArrayOutput() NamespaceArrayOutput

func (NamespaceArray) ToNamespaceArrayOutputWithContext 

func (i NamespaceArray) ToNamespaceArrayOutputWithContext(ctx context.Context) NamespaceArrayOutput

type NamespaceArrayInput 

type NamespaceArrayInput interface {
	pulumi.Input

	ToNamespaceArrayOutput() NamespaceArrayOutput
	ToNamespaceArrayOutputWithContext(context.Context) NamespaceArrayOutput
}

NamespaceArrayInput is an input type that accepts NamespaceArray and NamespaceArrayOutput values. You can construct a concrete instance of `NamespaceArrayInput` via: 

NamespaceArray{ NamespaceArgs{...} }

type NamespaceArrayOutput 

type NamespaceArrayOutput struct{ *pulumi.OutputState }

func (NamespaceArrayOutput) ElementType 

func (NamespaceArrayOutput) ElementType() reflect.Type

func (NamespaceArrayOutput) Index 

func (o NamespaceArrayOutput) Index(i pulumi.IntInput) NamespaceOutput

func (NamespaceArrayOutput) ToNamespaceArrayOutput 

func (o NamespaceArrayOutput) ToNamespaceArrayOutput() NamespaceArrayOutput

func (NamespaceArrayOutput) ToNamespaceArrayOutputWithContext 

func (o NamespaceArrayOutput) ToNamespaceArrayOutputWithContext(ctx context.Context) NamespaceArrayOutput

type NamespaceInput 

type NamespaceInput interface {
	pulumi.Input

	ToNamespaceOutput() NamespaceOutput
	ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput
}

type NamespaceMap 

type NamespaceMap map[string]NamespaceInput

func (NamespaceMap) ElementType 

func (NamespaceMap) ElementType() reflect.Type

func (NamespaceMap) ToNamespaceMapOutput 

func (i NamespaceMap) ToNamespaceMapOutput() NamespaceMapOutput

func (NamespaceMap) ToNamespaceMapOutputWithContext 

func (i NamespaceMap) ToNamespaceMapOutputWithContext(ctx context.Context) NamespaceMapOutput

type NamespaceMapInput 

type NamespaceMapInput interface {
	pulumi.Input

	ToNamespaceMapOutput() NamespaceMapOutput
	ToNamespaceMapOutputWithContext(context.Context) NamespaceMapOutput
}

NamespaceMapInput is an input type that accepts NamespaceMap and NamespaceMapOutput values. You can construct a concrete instance of `NamespaceMapInput` via: 

NamespaceMap{ "key": NamespaceArgs{...} }

type NamespaceMapOutput 

type NamespaceMapOutput struct{ *pulumi.OutputState }

func (NamespaceMapOutput) ElementType 

func (NamespaceMapOutput) ElementType() reflect.Type

func (NamespaceMapOutput) MapIndex 

func (o NamespaceMapOutput) MapIndex(k pulumi.StringInput) NamespaceOutput

func (NamespaceMapOutput) ToNamespaceMapOutput 

func (o NamespaceMapOutput) ToNamespaceMapOutput() NamespaceMapOutput

func (NamespaceMapOutput) ToNamespaceMapOutputWithContext 

func (o NamespaceMapOutput) ToNamespaceMapOutputWithContext(ctx context.Context) NamespaceMapOutput

type NamespaceOutput 

type NamespaceOutput struct {
	*pulumi.OutputState
}

func (NamespaceOutput) ElementType 

func (NamespaceOutput) ElementType() reflect.Type

func (NamespaceOutput) ToNamespaceOutput 

func (o NamespaceOutput) ToNamespaceOutput() NamespaceOutput

func (NamespaceOutput) ToNamespaceOutputWithContext 

func (o NamespaceOutput) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput

func (NamespaceOutput) ToNamespacePtrOutput 

func (o NamespaceOutput) ToNamespacePtrOutput() NamespacePtrOutput

func (NamespaceOutput) ToNamespacePtrOutputWithContext 

func (o NamespaceOutput) ToNamespacePtrOutputWithContext(ctx context.Context) NamespacePtrOutput

type NamespacePtrInput 

type NamespacePtrInput interface {
	pulumi.Input

	ToNamespacePtrOutput() NamespacePtrOutput
	ToNamespacePtrOutputWithContext(ctx context.Context) NamespacePtrOutput
}

type NamespacePtrOutput 

type NamespacePtrOutput struct {
	*pulumi.OutputState
}

func (NamespacePtrOutput) ElementType 

func (NamespacePtrOutput) ElementType() reflect.Type

func (NamespacePtrOutput) ToNamespacePtrOutput 

func (o NamespacePtrOutput) ToNamespacePtrOutput() NamespacePtrOutput

func (NamespacePtrOutput) ToNamespacePtrOutputWithContext 

func (o NamespacePtrOutput) ToNamespacePtrOutputWithContext(ctx context.Context) NamespacePtrOutput

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.