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.

relay

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.relay.HybridConnection(resource_name, opts=None, name=None, relay_namespace_name=None, requires_client_authorization=None, resource_group_name=None, user_metadata=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Relay Hybrid Connection.

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": "managed",
    })
example_hybrid_connection = azure.relay.HybridConnection("exampleHybridConnection",
    resource_group_name=example_resource_group.name,
    relay_namespace_name=example_namespace.name,
    requires_client_authorization=False,
    user_metadata="testmetadata")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • relay_namespace_name (pulumi.Input[str]) – The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • requires_client_authorization (pulumi.Input[bool]) – Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • user_metadata (pulumi.Input[str]) – 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.

name: pulumi.Output[str] = None

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

relay_namespace_name: pulumi.Output[str] = None

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

requires_client_authorization: pulumi.Output[bool] = None

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

resource_group_name: pulumi.Output[str] = None

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

user_metadata: pulumi.Output[str] = None

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.

static get(resource_name, id, opts=None, name=None, relay_namespace_name=None, requires_client_authorization=None, resource_group_name=None, user_metadata=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – Specifies the name of the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • relay_namespace_name (pulumi.Input[str]) – The name of the Azure Relay in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • requires_client_authorization (pulumi.Input[bool]) – Specify if client authorization is needed for this hybrid connection. True by default. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure Relay Hybrid Connection. Changing this forces a new resource to be created.

  • user_metadata (pulumi.Input[str]) – 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.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.relay.Namespace(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Relay Namespace.

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",
    })
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure Relay Namespace.

  • sku_name (pulumi.Input[str]) – The name of the SKU to use. At this time the only supported value is Standard.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

location: pulumi.Output[str] = None

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

metric_id: pulumi.Output[str] = None

The Identifier for Azure Insights metrics.

name: pulumi.Output[str] = None

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

primary_connection_string: pulumi.Output[str] = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

primary_key: pulumi.Output[str] = None

The primary access key for the authorization rule RootManageSharedAccessKey.

resource_group_name: pulumi.Output[str] = None

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

secondary_connection_string: pulumi.Output[str] = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

secondary_key: pulumi.Output[str] = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

sku_name: pulumi.Output[str] = None

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

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, location=None, metric_id=None, name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, sku_name=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.

  • metric_id (pulumi.Input[str]) – The Identifier for Azure Insights metrics.

  • name (pulumi.Input[str]) – Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The primary connection string for the authorization rule RootManageSharedAccessKey.

  • primary_key (pulumi.Input[str]) – The primary access key for the authorization rule RootManageSharedAccessKey.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Azure Relay Namespace.

  • secondary_connection_string (pulumi.Input[str]) – The secondary connection string for the authorization rule RootManageSharedAccessKey.

  • secondary_key (pulumi.Input[str]) – The secondary access key for the authorization rule RootManageSharedAccessKey.

  • sku_name (pulumi.Input[str]) – The name of the SKU to use. At this time the only supported value is Standard.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str