azure-native-v2.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.
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
This property is required. string - The unique name of the resource.
- args
This property is required. ConnectionGatewayArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ConnectionGatewayArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ConnectionGatewayArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group
- Connection
Gateway Name Changes to this property will trigger replacement.
- The connection gateway name
- Location string
- Resource location
- Properties
Pulumi.
Azure Native. Web. Inputs. Connection Gateway Definition Properties - Subscription
Id Changes to this property will trigger replacement.
- Subscription Id
- Dictionary<string, string>
- Resource tags
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group
- Connection
Gateway Name Changes to this property will trigger replacement.
- The connection gateway name
- Location string
- Resource location
- Properties
Connection
Gateway Definition Properties Args - Subscription
Id Changes to this property will trigger replacement.
- Subscription Id
- map[string]string
- Resource tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group
- connection
Gateway Name Changes to this property will trigger replacement.
- The connection gateway name
- location String
- Resource location
- properties
Connection
Gateway Definition Properties - subscription
Id Changes to this property will trigger replacement.
- Subscription Id
- Map<String,String>
- Resource tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group
- connection
Gateway Name Changes to this property will trigger replacement.
- The connection gateway name
- location string
- Resource location
- properties
Connection
Gateway Definition Properties - subscription
Id Changes to this property will trigger replacement.
- Subscription Id
- {[key: string]: string}
- Resource tags
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The resource group
- connection_
gateway_ name Changes to this property will trigger replacement.
- The connection gateway name
- location str
- Resource location
- properties
Connection
Gateway Definition Properties Args - subscription_
id Changes to this property will trigger replacement.
- Subscription Id
- Mapping[str, str]
- Resource tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group
- connection
Gateway Name Changes to this property will trigger replacement.
- The connection gateway name
- location String
- Resource location
- properties Property Map
- subscription
Id Changes to this property will trigger replacement.
- 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
- Backend
Uri string - The URI of the backend
- Connection
Gateway Pulumi.Installation Azure Native. Web. Inputs. Connection Gateway Reference - The gateway installation reference
- Contact
Information List<string> - The gateway admin
- Description string
- The gateway description
- Display
Name string - The gateway display name
- Machine
Name string - The machine name of the gateway
- Status object
- The gateway status
- Backend
Uri string - The URI of the backend
- Connection
Gateway ConnectionInstallation Gateway Reference - The gateway installation reference
- Contact
Information []string - The gateway admin
- Description string
- The gateway description
- Display
Name string - The gateway display name
- Machine
Name string - The machine name of the gateway
- Status interface{}
- The gateway status
- backend
Uri String - The URI of the backend
- connection
Gateway ConnectionInstallation Gateway Reference - The gateway installation reference
- contact
Information List<String> - The gateway admin
- description String
- The gateway description
- display
Name String - The gateway display name
- machine
Name String - The machine name of the gateway
- status Object
- The gateway status
- backend
Uri string - The URI of the backend
- connection
Gateway ConnectionInstallation Gateway Reference - The gateway installation reference
- contact
Information string[] - The gateway admin
- description string
- The gateway description
- display
Name string - The gateway display name
- machine
Name 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
- backend
Uri String - The URI of the backend
- connection
Gateway Property MapInstallation - The gateway installation reference
- contact
Information List<String> - The gateway admin
- description String
- The gateway description
- display
Name String - The gateway display name
- machine
Name String - The machine name of the gateway
- status Any
- The gateway status
ConnectionGatewayDefinitionResponseProperties, ConnectionGatewayDefinitionResponsePropertiesArgs
- Backend
Uri string - The URI of the backend
- Connection
Gateway Pulumi.Installation Azure Native. Web. Inputs. Connection Gateway Reference Response - The gateway installation reference
- Contact
Information List<string> - The gateway admin
- Description string
- The gateway description
- Display
Name string - The gateway display name
- Machine
Name string - The machine name of the gateway
- Status object
- The gateway status
- Backend
Uri string - The URI of the backend
- Connection
Gateway ConnectionInstallation Gateway Reference Response - The gateway installation reference
- Contact
Information []string - The gateway admin
- Description string
- The gateway description
- Display
Name string - The gateway display name
- Machine
Name string - The machine name of the gateway
- Status interface{}
- The gateway status
- backend
Uri String - The URI of the backend
- connection
Gateway ConnectionInstallation Gateway Reference Response - The gateway installation reference
- contact
Information List<String> - The gateway admin
- description String
- The gateway description
- display
Name String - The gateway display name
- machine
Name String - The machine name of the gateway
- status Object
- The gateway status
- backend
Uri string - The URI of the backend
- connection
Gateway ConnectionInstallation Gateway Reference Response - The gateway installation reference
- contact
Information string[] - The gateway admin
- description string
- The gateway description
- display
Name string - The gateway display name
- machine
Name 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
- backend
Uri String - The URI of the backend
- connection
Gateway Property MapInstallation - The gateway installation reference
- contact
Information List<String> - The gateway admin
- description String
- The gateway description
- display
Name String - The gateway display name
- machine
Name 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-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0