Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. relay
  5. WCFRelay
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.relay.WCFRelay

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Description of the WCF relay resource. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2017-04-01.

    Other available API versions: 2016-07-01, 2024-01-01.

    Example Usage

    RelayCreate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var wcfRelay = new AzureNative.Relay.WCFRelay("wcfRelay", new()
    {
        NamespaceName = "example-RelayNamespace-9953",
        RelayName = "example-Relay-Wcf-1194",
        RelayType = AzureNative.Relay.Relaytype.NetTcp,
        RequiresClientAuthorization = true,
        RequiresTransportSecurity = true,
        ResourceGroupName = "resourcegroup",
    });

});

    package main

import (
	relay "github.com/pulumi/pulumi-azure-native-sdk/relay/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := relay.NewWCFRelay(ctx, "wcfRelay", &relay.WCFRelayArgs{
			NamespaceName:               pulumi.String("example-RelayNamespace-9953"),
			RelayName:                   pulumi.String("example-Relay-Wcf-1194"),
			RelayType:                   relay.RelaytypeNetTcp,
			RequiresClientAuthorization: pulumi.Bool(true),
			RequiresTransportSecurity:   pulumi.Bool(true),
			ResourceGroupName:           pulumi.String("resourcegroup"),
		})
		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.azurenative.relay.WCFRelay;
import com.pulumi.azurenative.relay.WCFRelayArgs;
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 wcfRelay = new WCFRelay("wcfRelay", WCFRelayArgs.builder()
            .namespaceName("example-RelayNamespace-9953")
            .relayName("example-Relay-Wcf-1194")
            .relayType("NetTcp")
            .requiresClientAuthorization(true)
            .requiresTransportSecurity(true)
            .resourceGroupName("resourcegroup")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

wcf_relay = azure_native.relay.WCFRelay("wcfRelay",
    namespace_name="example-RelayNamespace-9953",
    relay_name="example-Relay-Wcf-1194",
    relay_type=azure_native.relay.Relaytype.NET_TCP,
    requires_client_authorization=True,
    requires_transport_security=True,
    resource_group_name="resourcegroup")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const wcfRelay = new azure_native.relay.WCFRelay("wcfRelay", {
    namespaceName: "example-RelayNamespace-9953",
    relayName: "example-Relay-Wcf-1194",
    relayType: azure_native.relay.Relaytype.NetTcp,
    requiresClientAuthorization: true,
    requiresTransportSecurity: true,
    resourceGroupName: "resourcegroup",
});

    resources:
  wcfRelay:
    type: azure-native:relay:WCFRelay
    properties:
      namespaceName: example-RelayNamespace-9953
      relayName: example-Relay-Wcf-1194
      relayType: NetTcp
      requiresClientAuthorization: true
      requiresTransportSecurity: true
      resourceGroupName: resourcegroup

    Create WCFRelay Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WCFRelay(name: string, args: WCFRelayArgs, opts?: CustomResourceOptions);
    @overload
def WCFRelay(resource_name: str,
             args: WCFRelayArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def WCFRelay(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             namespace_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             relay_name: Optional[str] = None,
             relay_type: Optional[Relaytype] = None,
             requires_client_authorization: Optional[bool] = None,
             requires_transport_security: Optional[bool] = None,
             user_metadata: Optional[str] = None)
    func NewWCFRelay(ctx *Context, name string, args WCFRelayArgs, opts ...ResourceOption) (*WCFRelay, error)
    public WCFRelay(string name, WCFRelayArgs args, CustomResourceOptions? opts = null)
    public WCFRelay(String name, WCFRelayArgs args)
public WCFRelay(String name, WCFRelayArgs args, CustomResourceOptions options)

    type: azure-native:relay:WCFRelay
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WCFRelayArgs
    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 WCFRelayArgs
    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 WCFRelayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WCFRelayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WCFRelayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var wcfrelayResource = new AzureNative.Relay.WCFRelay("wcfrelayResource", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    RelayName = "string",
    RelayType = AzureNative.Relay.Relaytype.NetTcp,
    RequiresClientAuthorization = false,
    RequiresTransportSecurity = false,
    UserMetadata = "string",
});

    example, err := relay.NewWCFRelay(ctx, "wcfrelayResource", &relay.WCFRelayArgs{
	NamespaceName:               pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	RelayName:                   pulumi.String("string"),
	RelayType:                   relay.RelaytypeNetTcp,
	RequiresClientAuthorization: pulumi.Bool(false),
	RequiresTransportSecurity:   pulumi.Bool(false),
	UserMetadata:                pulumi.String("string"),
})

    var wcfrelayResource = new WCFRelay("wcfrelayResource", WCFRelayArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .relayName("string")
    .relayType("NetTcp")
    .requiresClientAuthorization(false)
    .requiresTransportSecurity(false)
    .userMetadata("string")
    .build());

    wcfrelay_resource = azure_native.relay.WCFRelay("wcfrelayResource",
    namespace_name="string",
    resource_group_name="string",
    relay_name="string",
    relay_type=azure_native.relay.Relaytype.NET_TCP,
    requires_client_authorization=False,
    requires_transport_security=False,
    user_metadata="string")

    const wcfrelayResource = new azure_native.relay.WCFRelay("wcfrelayResource", {
    namespaceName: "string",
    resourceGroupName: "string",
    relayName: "string",
    relayType: azure_native.relay.Relaytype.NetTcp,
    requiresClientAuthorization: false,
    requiresTransportSecurity: false,
    userMetadata: "string",
});

    type: azure-native:relay:WCFRelay
properties:
    namespaceName: string
    relayName: string
    relayType: NetTcp
    requiresClientAuthorization: false
    requiresTransportSecurity: false
    resourceGroupName: string
    userMetadata: string

    WCFRelay Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WCFRelay resource accepts the following input properties:

    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    RelayName string
    The relay name.
    RelayType Pulumi.AzureNative.Relay.Relaytype
    WCF relay type.
    RequiresClientAuthorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    RequiresTransportSecurity bool
    Returns true if transport security is needed for this relay; otherwise, false.
    UserMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    RelayName string
    The relay name.
    RelayType Relaytype
    WCF relay type.
    RequiresClientAuthorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    RequiresTransportSecurity bool
    Returns true if transport security is needed for this relay; otherwise, false.
    UserMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    relayName String
    The relay name.
    relayType Relaytype
    WCF relay type.
    requiresClientAuthorization Boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity Boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata String
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    namespaceName string
    The namespace name
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    relayName string
    The relay name.
    relayType Relaytype
    WCF relay type.
    requiresClientAuthorization boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    namespace_name str
    The namespace name
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    relay_name str
    The relay name.
    relay_type Relaytype
    WCF relay type.
    requires_client_authorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    requires_transport_security bool
    Returns true if transport security is needed for this relay; otherwise, false.
    user_metadata str
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    relayName String
    The relay name.
    relayType "NetTcp" | "Http"
    WCF relay type.
    requiresClientAuthorization Boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity Boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata String
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

    Outputs

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

    CreatedAt string
    The time the WCF relay was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    ListenerCount int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    UpdatedAt string
    The time the namespace was updated.
    CreatedAt string
    The time the WCF relay was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    ListenerCount int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    UpdatedAt string
    The time the namespace was updated.
    createdAt String
    The time the WCF relay was created.
    id String
    The provider-assigned unique ID for this managed resource.
    isDynamic Boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount Integer
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt String
    The time the namespace was updated.
    createdAt string
    The time the WCF relay was created.
    id string
    The provider-assigned unique ID for this managed resource.
    isDynamic boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount number
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt string
    The time the namespace was updated.
    created_at str
    The time the WCF relay was created.
    id str
    The provider-assigned unique ID for this managed resource.
    is_dynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    listener_count int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updated_at str
    The time the namespace was updated.
    createdAt String
    The time the WCF relay was created.
    id String
    The provider-assigned unique ID for this managed resource.
    isDynamic Boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount Number
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt String
    The time the namespace was updated.

    Supporting Types

    Relaytype, RelaytypeArgs

    NetTcp
    NetTcp
    Http
    Http
    RelaytypeNetTcp
    NetTcp
    RelaytypeHttp
    Http
    NetTcp
    NetTcp
    Http
    Http
    NetTcp
    NetTcp
    Http
    Http
    NET_TCP
    NetTcp
    HTTP
    Http
    "NetTcp"
    NetTcp
    "Http"
    Http

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:relay:WCFRelay example-Relay-Wcf-1194 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native