azure-native.web.ConnectionGateway
Explore with Pulumi AI
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 = new AzureNative.Web.Inputs.ConnectionGatewayDefinitionPropertiesArgs
    {
        BackendUri = "string",
        ConnectionGatewayInstallation = new AzureNative.Web.Inputs.ConnectionGatewayReferenceArgs
        {
            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:     pulumi.String("string"),
	ConnectionGatewayName: pulumi.String("string"),
	Location:              pulumi.String("string"),
	Properties: &web.ConnectionGatewayDefinitionPropertiesArgs{
		BackendUri: pulumi.String("string"),
		ConnectionGatewayInstallation: &web.ConnectionGatewayReferenceArgs{
			Id:       pulumi.String("string"),
			Location: pulumi.String("string"),
			Name:     pulumi.String("string"),
			Type:     pulumi.String("string"),
		},
		ContactInformation: pulumi.StringArray{
			pulumi.String("string"),
		},
		Description: pulumi.String("string"),
		DisplayName: pulumi.String("string"),
		MachineName: pulumi.String("string"),
		Status:      pulumi.Any("any"),
	},
	SubscriptionId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var connectionGatewayResource = new ConnectionGateway("connectionGatewayResource", ConnectionGatewayArgs.builder()
    .resourceGroupName("string")
    .connectionGatewayName("string")
    .location("string")
    .properties(ConnectionGatewayDefinitionPropertiesArgs.builder()
        .backendUri("string")
        .connectionGatewayInstallation(ConnectionGatewayReferenceArgs.builder()
            .id("string")
            .location("string")
            .name("string")
            .type("string")
            .build())
        .contactInformation("string")
        .description("string")
        .displayName("string")
        .machineName("string")
        .status("any")
        .build())
    .subscriptionId("string")
    .tags(Map.of("string", "string"))
    .build());
connection_gateway_resource = azure_native.web.ConnectionGateway("connectionGatewayResource",
    resource_group_name="string",
    connection_gateway_name="string",
    location="string",
    properties={
        "backend_uri": "string",
        "connection_gateway_installation": {
            "id": "string",
            "location": "string",
            "name": "string",
            "type": "string",
        },
        "contact_information": ["string"],
        "description": "string",
        "display_name": "string",
        "machine_name": "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:
- ResourceGroup stringName 
- The resource group
- ConnectionGateway stringName 
- The connection gateway name
- Location string
- Resource location
- Properties
Pulumi.Azure Native. Web. Inputs. Connection Gateway Definition Properties 
- SubscriptionId string
- Subscription Id
- Dictionary<string, string>
- Resource tags
- ResourceGroup stringName 
- The resource group
- ConnectionGateway stringName 
- The connection gateway name
- Location string
- Resource location
- Properties
ConnectionGateway Definition Properties Args 
- SubscriptionId string
- Subscription Id
- map[string]string
- Resource tags
- resourceGroup StringName 
- The resource group
- connectionGateway StringName 
- The connection gateway name
- location String
- Resource location
- properties
ConnectionGateway Definition Properties 
- subscriptionId String
- Subscription Id
- Map<String,String>
- Resource tags
- resourceGroup stringName 
- The resource group
- connectionGateway stringName 
- The connection gateway name
- location string
- Resource location
- properties
ConnectionGateway Definition Properties 
- subscriptionId string
- Subscription Id
- {[key: string]: string}
- Resource tags
- resource_group_ strname 
- The resource group
- connection_gateway_ strname 
- The connection gateway name
- location str
- Resource location
- properties
ConnectionGateway Definition Properties Args 
- subscription_id str
- Subscription Id
- Mapping[str, str]
- Resource tags
- resourceGroup StringName 
- The resource group
- connectionGateway StringName 
- The connection gateway name
- location String
- Resource location
- properties Property Map
- subscriptionId String
- Subscription Id
- Map<String>
- Resource tags
Outputs
All input properties are implicitly available as output properties. Additionally, the ConnectionGateway resource produces the following output properties:
Supporting Types
ConnectionGatewayDefinitionProperties, ConnectionGatewayDefinitionPropertiesArgs        
- BackendUri string
- The URI of the backend
- ConnectionGateway Pulumi.Installation Azure Native. Web. Inputs. Connection Gateway Reference 
- 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
- ConnectionGateway ConnectionInstallation Gateway Reference 
- 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
- connectionGateway ConnectionInstallation Gateway Reference 
- 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
- connectionGateway ConnectionInstallation Gateway Reference 
- 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_ Connectioninstallation Gateway Reference 
- 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
- connectionGateway Property MapInstallation 
- 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
- ConnectionGateway Pulumi.Installation Azure Native. Web. Inputs. Connection Gateway Reference Response 
- 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
- ConnectionGateway ConnectionInstallation Gateway Reference Response 
- 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
- connectionGateway ConnectionInstallation Gateway Reference Response 
- 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
- connectionGateway ConnectionInstallation Gateway Reference Response 
- 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_ Connectioninstallation Gateway Reference Response 
- 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
- connectionGateway Property MapInstallation 
- 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      
ConnectionGatewayReferenceResponse, ConnectionGatewayReferenceResponseArgs        
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 pulumi/pulumi-azure-native
- License
- Apache-2.0