Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. ConnectionGateway
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.web.ConnectionGateway

Explore with Pulumi AI

azure-native-v2 logo
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

    The gateway definition Azure REST API version: 2016-06-01. Prior API version in Azure Native 1.x: 2016-06-01.

    Example Usage

    Replace a connection gateway definition

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

return await Deployment.RunAsync(() => 
{
    var connectionGateway = new AzureNative.Web.ConnectionGateway("connectionGateway", new()
    {
        ConnectionGatewayName = "test123",
        Properties = new AzureNative.Web.Inputs.ConnectionGatewayDefinitionPropertiesArgs
        {
            BackendUri = "https://WABI-WEST-US-redirect.analysis.windows.net",
            ConnectionGatewayInstallation = new AzureNative.Web.Inputs.ConnectionGatewayReferenceArgs
            {
                Id = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c",
            },
            ContactInformation = new[]
            {
                "test123@microsoft.com",
            },
            DisplayName = "test123",
            MachineName = "TEST123",
            Status = "Installed",
        },
        ResourceGroupName = "testResourceGroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewConnectionGateway(ctx, "connectionGateway", &web.ConnectionGatewayArgs{
			ConnectionGatewayName: pulumi.String("test123"),
			Properties: &web.ConnectionGatewayDefinitionPropertiesArgs{
				BackendUri: pulumi.String("https://WABI-WEST-US-redirect.analysis.windows.net"),
				ConnectionGatewayInstallation: &web.ConnectionGatewayReferenceArgs{
					Id: pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c"),
				},
				ContactInformation: pulumi.StringArray{
					pulumi.String("test123@microsoft.com"),
				},
				DisplayName: pulumi.String("test123"),
				MachineName: pulumi.String("TEST123"),
				Status:      pulumi.Any("Installed"),
			},
			ResourceGroupName: pulumi.String("testResourceGroup"),
		})
		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.web.ConnectionGateway;
import com.pulumi.azurenative.web.ConnectionGatewayArgs;
import com.pulumi.azurenative.web.inputs.ConnectionGatewayDefinitionPropertiesArgs;
import com.pulumi.azurenative.web.inputs.ConnectionGatewayReferenceArgs;
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 connectionGateway = new ConnectionGateway("connectionGateway", ConnectionGatewayArgs.builder()
            .connectionGatewayName("test123")
            .properties(ConnectionGatewayDefinitionPropertiesArgs.builder()
                .backendUri("https://WABI-WEST-US-redirect.analysis.windows.net")
                .connectionGatewayInstallation(ConnectionGatewayReferenceArgs.builder()
                    .id("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c")
                    .build())
                .contactInformation("test123@microsoft.com")
                .displayName("test123")
                .machineName("TEST123")
                .status("Installed")
                .build())
            .resourceGroupName("testResourceGroup")
            .build());

    }
}

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

const connectionGateway = new azure_native.web.ConnectionGateway("connectionGateway", {
    connectionGatewayName: "test123",
    properties: {
        backendUri: "https://WABI-WEST-US-redirect.analysis.windows.net",
        connectionGatewayInstallation: {
            id: "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c",
        },
        contactInformation: ["test123@microsoft.com"],
        displayName: "test123",
        machineName: "TEST123",
        status: "Installed",
    },
    resourceGroupName: "testResourceGroup",
});

    import pulumi
import pulumi_azure_native as azure_native

connection_gateway = azure_native.web.ConnectionGateway("connectionGateway",
    connection_gateway_name="test123",
    properties={
        "backend_uri": "https://WABI-WEST-US-redirect.analysis.windows.net",
        "connection_gateway_installation": {
            "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c",
        },
        "contact_information": ["test123@microsoft.com"],
        "display_name": "test123",
        "machine_name": "TEST123",
        "status": "Installed",
    },
    resource_group_name="testResourceGroup")

    resources:
  connectionGateway:
    type: azure-native:web:ConnectionGateway
    properties:
      connectionGatewayName: test123
      properties:
        backendUri: https://WABI-WEST-US-redirect.analysis.windows.net
        connectionGatewayInstallation:
          id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus/connectionGatewayInstallations/865dccd1-5d5c-45fe-b5a0-249d4de4134c
        contactInformation:
          - test123@microsoft.com
        displayName: test123
        machineName: TEST123
        status: Installed
      resourceGroupName: testResourceGroup

    Create ConnectionGateway Resource

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

    Constructor syntax

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

@overload
def ConnectionGateway(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      connection_gateway_name: Optional[str] = None,
                      location: Optional[str] = None,
                      properties: Optional[ConnectionGatewayDefinitionPropertiesArgs] = None,
                      subscription_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewConnectionGateway(ctx *Context, name string, args ConnectionGatewayArgs, opts ...ResourceOption) (*ConnectionGateway, error)
    public ConnectionGateway(string name, ConnectionGatewayArgs args, CustomResourceOptions? opts = null)
    public ConnectionGateway(String name, ConnectionGatewayArgs args)
public ConnectionGateway(String name, ConnectionGatewayArgs args, CustomResourceOptions options)

    type: azure-native:web:ConnectionGateway
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 ConnectionGatewayArgs
    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 ConnectionGatewayArgs
    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 ConnectionGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionGatewayArgs
    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 connectionGatewayResource = new AzureNative.Web.ConnectionGateway("connectionGatewayResource", new()
{
    ResourceGroupName = "string",
    ConnectionGatewayName = "string",
    Location = "string",
    Properties = 
    {
        { "backendUri", "string" },
        { "connectionGatewayInstallation", 
        {
            { "id", "string" },
            { "location", "string" },
            { "name", "string" },
            { "type", "string" },
        } },
        { "contactInformation", new[]
        {
            "string",
        } },
        { "description", "string" },
        { "displayName", "string" },
        { "machineName", "string" },
        { "status", "any" },
    },
    SubscriptionId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := web.NewConnectionGateway(ctx, "connectionGatewayResource", &web.ConnectionGatewayArgs{
	ResourceGroupName:     "string",
	ConnectionGatewayName: "string",
	Location:              "string",
	Properties: map[string]interface{}{
		"backendUri": "string",
		"connectionGatewayInstallation": map[string]interface{}{
			"id":       "string",
			"location": "string",
			"name":     "string",
			"type":     "string",
		},
		"contactInformation": []string{
			"string",
		},
		"description": "string",
		"displayName": "string",
		"machineName": "string",
		"status":      "any",
	},
	SubscriptionId: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var connectionGatewayResource = new ConnectionGateway("connectionGatewayResource", ConnectionGatewayArgs.builder()
    .resourceGroupName("string")
    .connectionGatewayName("string")
    .location("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .subscriptionId("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    connection_gateway_resource = azure_native.web.ConnectionGateway("connectionGatewayResource",
    resource_group_name=string,
    connection_gateway_name=string,
    location=string,
    properties={
        backendUri: string,
        connectionGatewayInstallation: {
            id: string,
            location: string,
            name: string,
            type: string,
        },
        contactInformation: [string],
        description: string,
        displayName: string,
        machineName: string,
        status: any,
    },
    subscription_id=string,
    tags={
        string: string,
    })

    const connectionGatewayResource = new azure_native.web.ConnectionGateway("connectionGatewayResource", {
    resourceGroupName: "string",
    connectionGatewayName: "string",
    location: "string",
    properties: {
        backendUri: "string",
        connectionGatewayInstallation: {
            id: "string",
            location: "string",
            name: "string",
            type: "string",
        },
        contactInformation: ["string"],
        description: "string",
        displayName: "string",
        machineName: "string",
        status: "any",
    },
    subscriptionId: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:web:ConnectionGateway
properties:
    connectionGatewayName: string
    location: string
    properties:
        backendUri: string
        connectionGatewayInstallation:
            id: string
            location: string
            name: string
            type: string
        contactInformation:
            - string
        description: string
        displayName: string
        machineName: string
        status: any
    resourceGroupName: string
    subscriptionId: string
    tags:
        string: string

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

    ResourceGroupName string
    The resource group
    ConnectionGatewayName string
    The connection gateway name
    Location string
    Resource location
    Properties Pulumi.AzureNative.Web.Inputs.ConnectionGatewayDefinitionProperties
    SubscriptionId string
    Subscription Id
    Tags Dictionary<string, string>
    Resource tags
    ResourceGroupName string
    The resource group
    ConnectionGatewayName string
    The connection gateway name
    Location string
    Resource location
    Properties ConnectionGatewayDefinitionPropertiesArgs
    SubscriptionId string
    Subscription Id
    Tags map[string]string
    Resource tags
    resourceGroupName String
    The resource group
    connectionGatewayName String
    The connection gateway name
    location String
    Resource location
    properties ConnectionGatewayDefinitionProperties
    subscriptionId String
    Subscription Id
    tags Map<String,String>
    Resource tags
    resourceGroupName string
    The resource group
    connectionGatewayName string
    The connection gateway name
    location string
    Resource location
    properties ConnectionGatewayDefinitionProperties
    subscriptionId string
    Subscription Id
    tags {[key: string]: string}
    Resource tags
    resource_group_name str
    The resource group
    connection_gateway_name str
    The connection gateway name
    location str
    Resource location
    properties ConnectionGatewayDefinitionPropertiesArgs
    subscription_id str
    Subscription Id
    tags Mapping[str, str]
    Resource tags
    resourceGroupName String
    The resource group
    connectionGatewayName String
    The connection gateway name
    location String
    Resource location
    properties Property Map
    subscriptionId String
    Subscription Id
    tags Map<String>
    Resource tags

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    Etag string
    Resource ETag
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    Etag string
    Resource ETag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    etag String
    Resource ETag
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    type string
    Resource type
    etag string
    Resource ETag
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    type str
    Resource type
    etag str
    Resource ETag
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    etag String
    Resource ETag

    Supporting Types

    ConnectionGatewayDefinitionProperties, ConnectionGatewayDefinitionPropertiesArgs

    BackendUri string
    The URI of the backend
    ConnectionGatewayInstallation Pulumi.AzureNative.Web.Inputs.ConnectionGatewayReference
    The gateway installation reference
    ContactInformation List<string>
    The gateway admin
    Description string
    The gateway description
    DisplayName string
    The gateway display name
    MachineName string
    The machine name of the gateway
    Status object
    The gateway status
    BackendUri string
    The URI of the backend
    ConnectionGatewayInstallation ConnectionGatewayReference
    The gateway installation reference
    ContactInformation []string
    The gateway admin
    Description string
    The gateway description
    DisplayName string
    The gateway display name
    MachineName string
    The machine name of the gateway
    Status interface{}
    The gateway status
    backendUri String
    The URI of the backend
    connectionGatewayInstallation ConnectionGatewayReference
    The gateway installation reference
    contactInformation List<String>
    The gateway admin
    description String
    The gateway description
    displayName String
    The gateway display name
    machineName String
    The machine name of the gateway
    status Object
    The gateway status
    backendUri string
    The URI of the backend
    connectionGatewayInstallation ConnectionGatewayReference
    The gateway installation reference
    contactInformation string[]
    The gateway admin
    description string
    The gateway description
    displayName string
    The gateway display name
    machineName string
    The machine name of the gateway
    status any
    The gateway status
    backend_uri str
    The URI of the backend
    connection_gateway_installation ConnectionGatewayReference
    The gateway installation reference
    contact_information Sequence[str]
    The gateway admin
    description str
    The gateway description
    display_name str
    The gateway display name
    machine_name str
    The machine name of the gateway
    status Any
    The gateway status
    backendUri String
    The URI of the backend
    connectionGatewayInstallation Property Map
    The gateway installation reference
    contactInformation List<String>
    The gateway admin
    description String
    The gateway description
    displayName String
    The gateway display name
    machineName String
    The machine name of the gateway
    status Any
    The gateway status

    ConnectionGatewayDefinitionResponseProperties, ConnectionGatewayDefinitionResponsePropertiesArgs

    BackendUri string
    The URI of the backend
    ConnectionGatewayInstallation Pulumi.AzureNative.Web.Inputs.ConnectionGatewayReferenceResponse
    The gateway installation reference
    ContactInformation List<string>
    The gateway admin
    Description string
    The gateway description
    DisplayName string
    The gateway display name
    MachineName string
    The machine name of the gateway
    Status object
    The gateway status
    BackendUri string
    The URI of the backend
    ConnectionGatewayInstallation ConnectionGatewayReferenceResponse
    The gateway installation reference
    ContactInformation []string
    The gateway admin
    Description string
    The gateway description
    DisplayName string
    The gateway display name
    MachineName string
    The machine name of the gateway
    Status interface{}
    The gateway status
    backendUri String
    The URI of the backend
    connectionGatewayInstallation ConnectionGatewayReferenceResponse
    The gateway installation reference
    contactInformation List<String>
    The gateway admin
    description String
    The gateway description
    displayName String
    The gateway display name
    machineName String
    The machine name of the gateway
    status Object
    The gateway status
    backendUri string
    The URI of the backend
    connectionGatewayInstallation ConnectionGatewayReferenceResponse
    The gateway installation reference
    contactInformation string[]
    The gateway admin
    description string
    The gateway description
    displayName string
    The gateway display name
    machineName string
    The machine name of the gateway
    status any
    The gateway status
    backend_uri str
    The URI of the backend
    connection_gateway_installation ConnectionGatewayReferenceResponse
    The gateway installation reference
    contact_information Sequence[str]
    The gateway admin
    description str
    The gateway description
    display_name str
    The gateway display name
    machine_name str
    The machine name of the gateway
    status Any
    The gateway status
    backendUri String
    The URI of the backend
    connectionGatewayInstallation Property Map
    The gateway installation reference
    contactInformation List<String>
    The gateway admin
    description String
    The gateway description
    displayName String
    The gateway display name
    machineName String
    The machine name of the gateway
    status Any
    The gateway status

    ConnectionGatewayReference, ConnectionGatewayReferenceArgs

    Id string
    Resource reference id
    Location string
    Resource reference location
    Name string
    Resource reference name
    Type string
    Resource reference type
    Id string
    Resource reference id
    Location string
    Resource reference location
    Name string
    Resource reference name
    Type string
    Resource reference type
    id String
    Resource reference id
    location String
    Resource reference location
    name String
    Resource reference name
    type String
    Resource reference type
    id string
    Resource reference id
    location string
    Resource reference location
    name string
    Resource reference name
    type string
    Resource reference type
    id str
    Resource reference id
    location str
    Resource reference location
    name str
    Resource reference name
    type str
    Resource reference type
    id String
    Resource reference id
    location String
    Resource reference location
    name String
    Resource reference name
    type String
    Resource reference type

    ConnectionGatewayReferenceResponse, ConnectionGatewayReferenceResponseArgs

    Id string
    Resource reference id
    Location string
    Resource reference location
    Name string
    Resource reference name
    Type string
    Resource reference type
    Id string
    Resource reference id
    Location string
    Resource reference location
    Name string
    Resource reference name
    Type string
    Resource reference type
    id String
    Resource reference id
    location String
    Resource reference location
    name String
    Resource reference name
    type String
    Resource reference type
    id string
    Resource reference id
    location string
    Resource reference location
    name string
    Resource reference name
    type string
    Resource reference type
    id str
    Resource reference id
    location str
    Resource reference location
    name str
    Resource reference name
    type str
    Resource reference type
    id String
    Resource reference id
    location String
    Resource reference location
    name String
    Resource reference name
    type String
    Resource reference type

    Import

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

    $ pulumi import azure-native:web:ConnectionGateway test123 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}

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

    Package Details

    Repository
    azure-native-v2 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v2 logo
    These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
    Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-azure-native