1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. FunctionAppHybridConnection

We recommend using Azure Native.

Azure Classic v5.71.0 published on Tuesday, Apr 9, 2024 by Pulumi

azure.appservice.FunctionAppHybridConnection

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.71.0 published on Tuesday, Apr 9, 2024 by Pulumi

    Manages a Function App Hybrid Connection.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "West Europe",
    });
    const exampleServicePlan = new azure.appservice.ServicePlan("example", {
        name: "example-plan",
        location: example.location,
        resourceGroupName: example.name,
        osType: "Windows",
        skuName: "S1",
    });
    const exampleNamespace = new azure.relay.Namespace("example", {
        name: "example-relay",
        location: example.location,
        resourceGroupName: example.name,
        skuName: "Standard",
    });
    const exampleHybridConnection = new azure.relay.HybridConnection("example", {
        name: "examplerhc1",
        resourceGroupName: example.name,
        relayNamespaceName: exampleNamespace.name,
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "storageaccountname",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "GRS",
    });
    const exampleWindowsWebApp = new azure.appservice.WindowsWebApp("example", {
        name: "example",
        location: example.location,
        resourceGroupName: example.name,
        servicePlanId: exampleServicePlan.id,
        siteConfig: {},
    });
    const exampleWindowsFunctionApp = new azure.appservice.WindowsFunctionApp("example", {
        name: "example-function-app",
        location: example.location,
        resourceGroupName: example.name,
        servicePlanId: exampleServicePlan.id,
        storageAccountName: exampleAccount.name,
        storageAccountAccessKey: exampleAccount.primaryAccessKey,
        siteConfig: {},
    });
    const exampleFunctionAppHybridConnection = new azure.appservice.FunctionAppHybridConnection("example", {
        functionAppId: exampleWindowsWebApp.id,
        relayId: exampleHybridConnection.id,
        hostname: "myhostname.example",
        port: 8081,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="West Europe")
    example_service_plan = azure.appservice.ServicePlan("example",
        name="example-plan",
        location=example.location,
        resource_group_name=example.name,
        os_type="Windows",
        sku_name="S1")
    example_namespace = azure.relay.Namespace("example",
        name="example-relay",
        location=example.location,
        resource_group_name=example.name,
        sku_name="Standard")
    example_hybrid_connection = azure.relay.HybridConnection("example",
        name="examplerhc1",
        resource_group_name=example.name,
        relay_namespace_name=example_namespace.name)
    example_account = azure.storage.Account("example",
        name="storageaccountname",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="GRS")
    example_windows_web_app = azure.appservice.WindowsWebApp("example",
        name="example",
        location=example.location,
        resource_group_name=example.name,
        service_plan_id=example_service_plan.id,
        site_config=azure.appservice.WindowsWebAppSiteConfigArgs())
    example_windows_function_app = azure.appservice.WindowsFunctionApp("example",
        name="example-function-app",
        location=example.location,
        resource_group_name=example.name,
        service_plan_id=example_service_plan.id,
        storage_account_name=example_account.name,
        storage_account_access_key=example_account.primary_access_key,
        site_config=azure.appservice.WindowsFunctionAppSiteConfigArgs())
    example_function_app_hybrid_connection = azure.appservice.FunctionAppHybridConnection("example",
        function_app_id=example_windows_web_app.id,
        relay_id=example_hybrid_connection.id,
        hostname="myhostname.example",
        port=8081)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appservice"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/relay"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleServicePlan, err := appservice.NewServicePlan(ctx, "example", &appservice.ServicePlanArgs{
    			Name:              pulumi.String("example-plan"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			OsType:            pulumi.String("Windows"),
    			SkuName:           pulumi.String("S1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNamespace, err := relay.NewNamespace(ctx, "example", &relay.NamespaceArgs{
    			Name:              pulumi.String("example-relay"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleHybridConnection, err := relay.NewHybridConnection(ctx, "example", &relay.HybridConnectionArgs{
    			Name:               pulumi.String("examplerhc1"),
    			ResourceGroupName:  example.Name,
    			RelayNamespaceName: exampleNamespace.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("storageaccountname"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("GRS"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWindowsWebApp, err := appservice.NewWindowsWebApp(ctx, "example", &appservice.WindowsWebAppArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			ServicePlanId:     exampleServicePlan.ID(),
    			SiteConfig:        nil,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appservice.NewWindowsFunctionApp(ctx, "example", &appservice.WindowsFunctionAppArgs{
    			Name:                    pulumi.String("example-function-app"),
    			Location:                example.Location,
    			ResourceGroupName:       example.Name,
    			ServicePlanId:           exampleServicePlan.ID(),
    			StorageAccountName:      exampleAccount.Name,
    			StorageAccountAccessKey: exampleAccount.PrimaryAccessKey,
    			SiteConfig:              nil,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appservice.NewFunctionAppHybridConnection(ctx, "example", &appservice.FunctionAppHybridConnectionArgs{
    			FunctionAppId: exampleWindowsWebApp.ID(),
    			RelayId:       exampleHybridConnection.ID(),
    			Hostname:      pulumi.String("myhostname.example"),
    			Port:          pulumi.Int(8081),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-rg",
            Location = "West Europe",
        });
    
        var exampleServicePlan = new Azure.AppService.ServicePlan("example", new()
        {
            Name = "example-plan",
            Location = example.Location,
            ResourceGroupName = example.Name,
            OsType = "Windows",
            SkuName = "S1",
        });
    
        var exampleNamespace = new Azure.Relay.Namespace("example", new()
        {
            Name = "example-relay",
            Location = example.Location,
            ResourceGroupName = example.Name,
            SkuName = "Standard",
        });
    
        var exampleHybridConnection = new Azure.Relay.HybridConnection("example", new()
        {
            Name = "examplerhc1",
            ResourceGroupName = example.Name,
            RelayNamespaceName = exampleNamespace.Name,
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "storageaccountname",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "GRS",
        });
    
        var exampleWindowsWebApp = new Azure.AppService.WindowsWebApp("example", new()
        {
            Name = "example",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ServicePlanId = exampleServicePlan.Id,
            SiteConfig = null,
        });
    
        var exampleWindowsFunctionApp = new Azure.AppService.WindowsFunctionApp("example", new()
        {
            Name = "example-function-app",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ServicePlanId = exampleServicePlan.Id,
            StorageAccountName = exampleAccount.Name,
            StorageAccountAccessKey = exampleAccount.PrimaryAccessKey,
            SiteConfig = null,
        });
    
        var exampleFunctionAppHybridConnection = new Azure.AppService.FunctionAppHybridConnection("example", new()
        {
            FunctionAppId = exampleWindowsWebApp.Id,
            RelayId = exampleHybridConnection.Id,
            Hostname = "myhostname.example",
            Port = 8081,
        });
    
    });
    
    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.appservice.ServicePlan;
    import com.pulumi.azure.appservice.ServicePlanArgs;
    import com.pulumi.azure.relay.Namespace;
    import com.pulumi.azure.relay.NamespaceArgs;
    import com.pulumi.azure.relay.HybridConnection;
    import com.pulumi.azure.relay.HybridConnectionArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.appservice.WindowsWebApp;
    import com.pulumi.azure.appservice.WindowsWebAppArgs;
    import com.pulumi.azure.appservice.inputs.WindowsWebAppSiteConfigArgs;
    import com.pulumi.azure.appservice.WindowsFunctionApp;
    import com.pulumi.azure.appservice.WindowsFunctionAppArgs;
    import com.pulumi.azure.appservice.inputs.WindowsFunctionAppSiteConfigArgs;
    import com.pulumi.azure.appservice.FunctionAppHybridConnection;
    import com.pulumi.azure.appservice.FunctionAppHybridConnectionArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-rg")
                .location("West Europe")
                .build());
    
            var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()        
                .name("example-plan")
                .location(example.location())
                .resourceGroupName(example.name())
                .osType("Windows")
                .skuName("S1")
                .build());
    
            var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
                .name("example-relay")
                .location(example.location())
                .resourceGroupName(example.name())
                .skuName("Standard")
                .build());
    
            var exampleHybridConnection = new HybridConnection("exampleHybridConnection", HybridConnectionArgs.builder()        
                .name("examplerhc1")
                .resourceGroupName(example.name())
                .relayNamespaceName(exampleNamespace.name())
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .name("storageaccountname")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("GRS")
                .build());
    
            var exampleWindowsWebApp = new WindowsWebApp("exampleWindowsWebApp", WindowsWebAppArgs.builder()        
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .servicePlanId(exampleServicePlan.id())
                .siteConfig()
                .build());
    
            var exampleWindowsFunctionApp = new WindowsFunctionApp("exampleWindowsFunctionApp", WindowsFunctionAppArgs.builder()        
                .name("example-function-app")
                .location(example.location())
                .resourceGroupName(example.name())
                .servicePlanId(exampleServicePlan.id())
                .storageAccountName(exampleAccount.name())
                .storageAccountAccessKey(exampleAccount.primaryAccessKey())
                .siteConfig()
                .build());
    
            var exampleFunctionAppHybridConnection = new FunctionAppHybridConnection("exampleFunctionAppHybridConnection", FunctionAppHybridConnectionArgs.builder()        
                .functionAppId(exampleWindowsWebApp.id())
                .relayId(exampleHybridConnection.id())
                .hostname("myhostname.example")
                .port(8081)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: West Europe
      exampleServicePlan:
        type: azure:appservice:ServicePlan
        name: example
        properties:
          name: example-plan
          location: ${example.location}
          resourceGroupName: ${example.name}
          osType: Windows
          skuName: S1
      exampleNamespace:
        type: azure:relay:Namespace
        name: example
        properties:
          name: example-relay
          location: ${example.location}
          resourceGroupName: ${example.name}
          skuName: Standard
      exampleHybridConnection:
        type: azure:relay:HybridConnection
        name: example
        properties:
          name: examplerhc1
          resourceGroupName: ${example.name}
          relayNamespaceName: ${exampleNamespace.name}
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: storageaccountname
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: GRS
      exampleWindowsWebApp:
        type: azure:appservice:WindowsWebApp
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
          servicePlanId: ${exampleServicePlan.id}
          siteConfig: {}
      exampleWindowsFunctionApp:
        type: azure:appservice:WindowsFunctionApp
        name: example
        properties:
          name: example-function-app
          location: ${example.location}
          resourceGroupName: ${example.name}
          servicePlanId: ${exampleServicePlan.id}
          storageAccountName: ${exampleAccount.name}
          storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
          siteConfig: {}
      exampleFunctionAppHybridConnection:
        type: azure:appservice:FunctionAppHybridConnection
        name: example
        properties:
          functionAppId: ${exampleWindowsWebApp.id}
          relayId: ${exampleHybridConnection.id}
          hostname: myhostname.example
          port: 8081
    

    Create FunctionAppHybridConnection Resource

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

    Constructor syntax

    new FunctionAppHybridConnection(name: string, args: FunctionAppHybridConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def FunctionAppHybridConnection(resource_name: str,
                                    args: FunctionAppHybridConnectionArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def FunctionAppHybridConnection(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    function_app_id: Optional[str] = None,
                                    hostname: Optional[str] = None,
                                    port: Optional[int] = None,
                                    relay_id: Optional[str] = None,
                                    send_key_name: Optional[str] = None)
    func NewFunctionAppHybridConnection(ctx *Context, name string, args FunctionAppHybridConnectionArgs, opts ...ResourceOption) (*FunctionAppHybridConnection, error)
    public FunctionAppHybridConnection(string name, FunctionAppHybridConnectionArgs args, CustomResourceOptions? opts = null)
    public FunctionAppHybridConnection(String name, FunctionAppHybridConnectionArgs args)
    public FunctionAppHybridConnection(String name, FunctionAppHybridConnectionArgs args, CustomResourceOptions options)
    
    type: azure:appservice:FunctionAppHybridConnection
    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 FunctionAppHybridConnectionArgs
    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 FunctionAppHybridConnectionArgs
    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 FunctionAppHybridConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FunctionAppHybridConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FunctionAppHybridConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var functionAppHybridConnectionResource = new Azure.AppService.FunctionAppHybridConnection("functionAppHybridConnectionResource", new()
    {
        FunctionAppId = "string",
        Hostname = "string",
        Port = 0,
        RelayId = "string",
        SendKeyName = "string",
    });
    
    example, err := appservice.NewFunctionAppHybridConnection(ctx, "functionAppHybridConnectionResource", &appservice.FunctionAppHybridConnectionArgs{
    	FunctionAppId: pulumi.String("string"),
    	Hostname:      pulumi.String("string"),
    	Port:          pulumi.Int(0),
    	RelayId:       pulumi.String("string"),
    	SendKeyName:   pulumi.String("string"),
    })
    
    var functionAppHybridConnectionResource = new FunctionAppHybridConnection("functionAppHybridConnectionResource", FunctionAppHybridConnectionArgs.builder()        
        .functionAppId("string")
        .hostname("string")
        .port(0)
        .relayId("string")
        .sendKeyName("string")
        .build());
    
    function_app_hybrid_connection_resource = azure.appservice.FunctionAppHybridConnection("functionAppHybridConnectionResource",
        function_app_id="string",
        hostname="string",
        port=0,
        relay_id="string",
        send_key_name="string")
    
    const functionAppHybridConnectionResource = new azure.appservice.FunctionAppHybridConnection("functionAppHybridConnectionResource", {
        functionAppId: "string",
        hostname: "string",
        port: 0,
        relayId: "string",
        sendKeyName: "string",
    });
    
    type: azure:appservice:FunctionAppHybridConnection
    properties:
        functionAppId: string
        hostname: string
        port: 0
        relayId: string
        sendKeyName: string
    

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

    FunctionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    Hostname string
    The hostname of the endpoint.
    Port int
    The port to use for the endpoint
    RelayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    SendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    FunctionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    Hostname string
    The hostname of the endpoint.
    Port int
    The port to use for the endpoint
    RelayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    SendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    functionAppId String
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname String
    The hostname of the endpoint.
    port Integer
    The port to use for the endpoint
    relayId String
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    sendKeyName String
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    functionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname string
    The hostname of the endpoint.
    port number
    The port to use for the endpoint
    relayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    sendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    function_app_id str
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname str
    The hostname of the endpoint.
    port int
    The port to use for the endpoint
    relay_id str
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    send_key_name str
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    functionAppId String
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname String
    The hostname of the endpoint.
    port Number
    The port to use for the endpoint
    relayId String
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    sendKeyName String
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    NamespaceName string
    The name of the Relay Namespace.
    RelayName string
    The name of the Relay in use.
    SendKeyValue string
    The Primary Access Key for the send_key_name
    ServiceBusNamespace string
    The Service Bus Namespace.
    ServiceBusSuffix string
    The suffix for the endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    NamespaceName string
    The name of the Relay Namespace.
    RelayName string
    The name of the Relay in use.
    SendKeyValue string
    The Primary Access Key for the send_key_name
    ServiceBusNamespace string
    The Service Bus Namespace.
    ServiceBusSuffix string
    The suffix for the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    namespaceName String
    The name of the Relay Namespace.
    relayName String
    The name of the Relay in use.
    sendKeyValue String
    The Primary Access Key for the send_key_name
    serviceBusNamespace String
    The Service Bus Namespace.
    serviceBusSuffix String
    The suffix for the endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    namespaceName string
    The name of the Relay Namespace.
    relayName string
    The name of the Relay in use.
    sendKeyValue string
    The Primary Access Key for the send_key_name
    serviceBusNamespace string
    The Service Bus Namespace.
    serviceBusSuffix string
    The suffix for the endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    namespace_name str
    The name of the Relay Namespace.
    relay_name str
    The name of the Relay in use.
    send_key_value str
    The Primary Access Key for the send_key_name
    service_bus_namespace str
    The Service Bus Namespace.
    service_bus_suffix str
    The suffix for the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    namespaceName String
    The name of the Relay Namespace.
    relayName String
    The name of the Relay in use.
    sendKeyValue String
    The Primary Access Key for the send_key_name
    serviceBusNamespace String
    The Service Bus Namespace.
    serviceBusSuffix String
    The suffix for the endpoint.

    Look up Existing FunctionAppHybridConnection Resource

    Get an existing FunctionAppHybridConnection 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?: FunctionAppHybridConnectionState, opts?: CustomResourceOptions): FunctionAppHybridConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            function_app_id: Optional[str] = None,
            hostname: Optional[str] = None,
            namespace_name: Optional[str] = None,
            port: Optional[int] = None,
            relay_id: Optional[str] = None,
            relay_name: Optional[str] = None,
            send_key_name: Optional[str] = None,
            send_key_value: Optional[str] = None,
            service_bus_namespace: Optional[str] = None,
            service_bus_suffix: Optional[str] = None) -> FunctionAppHybridConnection
    func GetFunctionAppHybridConnection(ctx *Context, name string, id IDInput, state *FunctionAppHybridConnectionState, opts ...ResourceOption) (*FunctionAppHybridConnection, error)
    public static FunctionAppHybridConnection Get(string name, Input<string> id, FunctionAppHybridConnectionState? state, CustomResourceOptions? opts = null)
    public static FunctionAppHybridConnection get(String name, Output<String> id, FunctionAppHybridConnectionState 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:
    FunctionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    Hostname string
    The hostname of the endpoint.
    NamespaceName string
    The name of the Relay Namespace.
    Port int
    The port to use for the endpoint
    RelayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    RelayName string
    The name of the Relay in use.
    SendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    SendKeyValue string
    The Primary Access Key for the send_key_name
    ServiceBusNamespace string
    The Service Bus Namespace.
    ServiceBusSuffix string
    The suffix for the endpoint.
    FunctionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    Hostname string
    The hostname of the endpoint.
    NamespaceName string
    The name of the Relay Namespace.
    Port int
    The port to use for the endpoint
    RelayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    RelayName string
    The name of the Relay in use.
    SendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    SendKeyValue string
    The Primary Access Key for the send_key_name
    ServiceBusNamespace string
    The Service Bus Namespace.
    ServiceBusSuffix string
    The suffix for the endpoint.
    functionAppId String
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname String
    The hostname of the endpoint.
    namespaceName String
    The name of the Relay Namespace.
    port Integer
    The port to use for the endpoint
    relayId String
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    relayName String
    The name of the Relay in use.
    sendKeyName String
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    sendKeyValue String
    The Primary Access Key for the send_key_name
    serviceBusNamespace String
    The Service Bus Namespace.
    serviceBusSuffix String
    The suffix for the endpoint.
    functionAppId string
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname string
    The hostname of the endpoint.
    namespaceName string
    The name of the Relay Namespace.
    port number
    The port to use for the endpoint
    relayId string
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    relayName string
    The name of the Relay in use.
    sendKeyName string
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    sendKeyValue string
    The Primary Access Key for the send_key_name
    serviceBusNamespace string
    The Service Bus Namespace.
    serviceBusSuffix string
    The suffix for the endpoint.
    function_app_id str
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname str
    The hostname of the endpoint.
    namespace_name str
    The name of the Relay Namespace.
    port int
    The port to use for the endpoint
    relay_id str
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    relay_name str
    The name of the Relay in use.
    send_key_name str
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    send_key_value str
    The Primary Access Key for the send_key_name
    service_bus_namespace str
    The Service Bus Namespace.
    service_bus_suffix str
    The suffix for the endpoint.
    functionAppId String
    The ID of the Function App for this Hybrid Connection. Changing this forces a new resource to be created.
    hostname String
    The hostname of the endpoint.
    namespaceName String
    The name of the Relay Namespace.
    port Number
    The port to use for the endpoint
    relayId String
    The ID of the Relay Hybrid Connection to use. Changing this forces a new resource to be created.
    relayName String
    The name of the Relay in use.
    sendKeyName String
    The name of the Relay key with Send permission to use. Defaults to RootManageSharedAccessKey
    sendKeyValue String
    The Primary Access Key for the send_key_name
    serviceBusNamespace String
    The Service Bus Namespace.
    serviceBusSuffix String
    The suffix for the endpoint.

    Import

    a Function App Hybrid Connection can be imported using the resource id, e.g.

    $ pulumi import azure:appservice/functionAppHybridConnection:FunctionAppHybridConnection example "/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Web/sites/site1/hybridConnectionNamespaces/hybridConnectionNamespace1/relays/relay1"
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.71.0 published on Tuesday, Apr 9, 2024 by Pulumi