1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. relay
  5. Namespace
azure logo
Azure Classic v5.37.0, Mar 15 23

azure.relay.Namespace

Manages an Azure Relay Namespace.

Example Usage

using System.Collections.Generic;
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", "example" },
        },
    });

});

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
		}
		_, 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
	})
}

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

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

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: example

Create Namespace Resource

new Namespace(name: string, args: NamespaceArgs, opts?: CustomResourceOptions);
@overload
def Namespace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              location: Optional[str] = None,
              name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              sku_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def Namespace(resource_name: str,
              args: NamespaceArgs,
              opts: Optional[ResourceOptions] = None)
func NewNamespace(ctx *Context, name string, args NamespaceArgs, opts ...ResourceOption) (*Namespace, error)
public Namespace(string name, NamespaceArgs args, CustomResourceOptions? opts = null)
public Namespace(String name, NamespaceArgs args)
public Namespace(String name, NamespaceArgs args, CustomResourceOptions options)

type: azure:relay:Namespace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NamespaceArgs
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 NamespaceArgs
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 NamespaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NamespaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args NamespaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Namespace 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 Namespace resource accepts the following input properties:

ResourceGroupName string

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

SkuName string

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

Location string

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

Name string

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

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

ResourceGroupName string

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

SkuName string

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

Location string

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

Name string

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

Tags map[string]string

A mapping of tags to assign to the resource.

resourceGroupName String

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

skuName String

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

location String

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

name String

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

tags Map<String,String>

A mapping of tags to assign to the resource.

resourceGroupName string

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

skuName string

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

location string

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

name string

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

tags {[key: string]: string}

A mapping of tags to assign to the resource.

resource_group_name str

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

sku_name str

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

location str

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

name str

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

tags Mapping[str, str]

A mapping of tags to assign to the resource.

resourceGroupName String

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

skuName String

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

location String

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

name String

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

tags Map<String>

A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Namespace resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

MetricId string

The Identifier for Azure Insights metrics.

PrimaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

PrimaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

SecondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

SecondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

Id string

The provider-assigned unique ID for this managed resource.

MetricId string

The Identifier for Azure Insights metrics.

PrimaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

PrimaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

SecondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

SecondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

id String

The provider-assigned unique ID for this managed resource.

metricId String

The Identifier for Azure Insights metrics.

primaryConnectionString String

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey String

The primary access key for the authorization rule RootManageSharedAccessKey.

secondaryConnectionString String

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey String

The secondary access key for the authorization rule RootManageSharedAccessKey.

id string

The provider-assigned unique ID for this managed resource.

metricId string

The Identifier for Azure Insights metrics.

primaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

secondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

id str

The provider-assigned unique ID for this managed resource.

metric_id str

The Identifier for Azure Insights metrics.

primary_connection_string str

The primary connection string for the authorization rule RootManageSharedAccessKey.

primary_key str

The primary access key for the authorization rule RootManageSharedAccessKey.

secondary_connection_string str

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondary_key str

The secondary access key for the authorization rule RootManageSharedAccessKey.

id String

The provider-assigned unique ID for this managed resource.

metricId String

The Identifier for Azure Insights metrics.

primaryConnectionString String

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey String

The primary access key for the authorization rule RootManageSharedAccessKey.

secondaryConnectionString String

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey String

The secondary access key for the authorization rule RootManageSharedAccessKey.

Look up Existing Namespace Resource

Get an existing Namespace 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?: NamespaceState, opts?: CustomResourceOptions): Namespace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        metric_id: Optional[str] = None,
        name: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        primary_key: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        secondary_key: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Namespace
func GetNamespace(ctx *Context, name string, id IDInput, state *NamespaceState, opts ...ResourceOption) (*Namespace, error)
public static Namespace Get(string name, Input<string> id, NamespaceState? state, CustomResourceOptions? opts = null)
public static Namespace get(String name, Output<String> id, NamespaceState 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.
The following state arguments are supported:
Location string

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

MetricId string

The Identifier for Azure Insights metrics.

Name string

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

PrimaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

PrimaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

ResourceGroupName string

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

SecondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

SecondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

SkuName string

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

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

Location string

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

MetricId string

The Identifier for Azure Insights metrics.

Name string

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

PrimaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

PrimaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

ResourceGroupName string

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

SecondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

SecondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

SkuName string

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

Tags map[string]string

A mapping of tags to assign to the resource.

location String

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

metricId String

The Identifier for Azure Insights metrics.

name String

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

primaryConnectionString String

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey String

The primary access key for the authorization rule RootManageSharedAccessKey.

resourceGroupName String

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

secondaryConnectionString String

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey String

The secondary access key for the authorization rule RootManageSharedAccessKey.

skuName String

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

tags Map<String,String>

A mapping of tags to assign to the resource.

location string

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

metricId string

The Identifier for Azure Insights metrics.

name string

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

primaryConnectionString string

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey string

The primary access key for the authorization rule RootManageSharedAccessKey.

resourceGroupName string

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

secondaryConnectionString string

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey string

The secondary access key for the authorization rule RootManageSharedAccessKey.

skuName string

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

tags {[key: string]: string}

A mapping of tags to assign to the resource.

location str

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

metric_id str

The Identifier for Azure Insights metrics.

name str

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

primary_connection_string str

The primary connection string for the authorization rule RootManageSharedAccessKey.

primary_key str

The primary access key for the authorization rule RootManageSharedAccessKey.

resource_group_name str

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

secondary_connection_string str

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondary_key str

The secondary access key for the authorization rule RootManageSharedAccessKey.

sku_name str

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

tags Mapping[str, str]

A mapping of tags to assign to the resource.

location String

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

metricId String

The Identifier for Azure Insights metrics.

name String

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

primaryConnectionString String

The primary connection string for the authorization rule RootManageSharedAccessKey.

primaryKey String

The primary access key for the authorization rule RootManageSharedAccessKey.

resourceGroupName String

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

secondaryConnectionString String

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondaryKey String

The secondary access key for the authorization rule RootManageSharedAccessKey.

skuName String

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

tags Map<String>

A mapping of tags to assign to the resource.

Import

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

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.