azure-native.hybridcompute.Gateway
Explore with Pulumi AI
Describes an Arc Gateway. Azure REST API version: 2024-03-31-preview.
Other available API versions: 2024-05-20-preview, 2024-07-31-preview, 2024-09-10-preview, 2024-11-10-preview.
Example Usage
Create or Update a Gateway
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var gateway = new AzureNative.HybridCompute.Gateway("gateway", new()
{
AllowedFeatures = new[]
{
"*",
},
GatewayName = "{gatewayName}",
GatewayType = AzureNative.HybridCompute.GatewayType.Public,
Location = "eastus2euap",
ResourceGroupName = "myResourceGroup",
});
});
package main
import (
hybridcompute "github.com/pulumi/pulumi-azure-native-sdk/hybridcompute/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := hybridcompute.NewGateway(ctx, "gateway", &hybridcompute.GatewayArgs{
AllowedFeatures: pulumi.StringArray{
pulumi.String("*"),
},
GatewayName: pulumi.String("{gatewayName}"),
GatewayType: pulumi.String(hybridcompute.GatewayTypePublic),
Location: pulumi.String("eastus2euap"),
ResourceGroupName: pulumi.String("myResourceGroup"),
})
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.hybridcompute.Gateway;
import com.pulumi.azurenative.hybridcompute.GatewayArgs;
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 gateway = new Gateway("gateway", GatewayArgs.builder()
.allowedFeatures("*")
.gatewayName("{gatewayName}")
.gatewayType("Public")
.location("eastus2euap")
.resourceGroupName("myResourceGroup")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
gateway = azure_native.hybridcompute.Gateway("gateway",
allowed_features=["*"],
gateway_name="{gatewayName}",
gateway_type=azure_native.hybridcompute.GatewayType.PUBLIC,
location="eastus2euap",
resource_group_name="myResourceGroup")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const gateway = new azure_native.hybridcompute.Gateway("gateway", {
allowedFeatures: ["*"],
gatewayName: "{gatewayName}",
gatewayType: azure_native.hybridcompute.GatewayType.Public,
location: "eastus2euap",
resourceGroupName: "myResourceGroup",
});
resources:
gateway:
type: azure-native:hybridcompute:Gateway
properties:
allowedFeatures:
- '*'
gatewayName: '{gatewayName}'
gatewayType: Public
location: eastus2euap
resourceGroupName: myResourceGroup
Create Gateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
args: GatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Gateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
allowed_features: Optional[Sequence[str]] = None,
gateway_name: Optional[str] = None,
gateway_type: Optional[Union[str, GatewayType]] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: azure-native:hybridcompute:Gateway
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 GatewayArgs
- 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 GatewayArgs
- 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 GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayArgs
- 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 examplegatewayResourceResourceFromHybridcompute = new AzureNative.HybridCompute.Gateway("examplegatewayResourceResourceFromHybridcompute", new()
{
ResourceGroupName = "string",
AllowedFeatures = new[]
{
"string",
},
GatewayName = "string",
GatewayType = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := hybridcompute.NewGateway(ctx, "examplegatewayResourceResourceFromHybridcompute", &hybridcompute.GatewayArgs{
ResourceGroupName: pulumi.String("string"),
AllowedFeatures: pulumi.StringArray{
pulumi.String("string"),
},
GatewayName: pulumi.String("string"),
GatewayType: pulumi.String("string"),
Location: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var examplegatewayResourceResourceFromHybridcompute = new Gateway("examplegatewayResourceResourceFromHybridcompute", GatewayArgs.builder()
.resourceGroupName("string")
.allowedFeatures("string")
.gatewayName("string")
.gatewayType("string")
.location("string")
.tags(Map.of("string", "string"))
.build());
examplegateway_resource_resource_from_hybridcompute = azure_native.hybridcompute.Gateway("examplegatewayResourceResourceFromHybridcompute",
resource_group_name="string",
allowed_features=["string"],
gateway_name="string",
gateway_type="string",
location="string",
tags={
"string": "string",
})
const examplegatewayResourceResourceFromHybridcompute = new azure_native.hybridcompute.Gateway("examplegatewayResourceResourceFromHybridcompute", {
resourceGroupName: "string",
allowedFeatures: ["string"],
gatewayName: "string",
gatewayType: "string",
location: "string",
tags: {
string: "string",
},
});
type: azure-native:hybridcompute:Gateway
properties:
allowedFeatures:
- string
gatewayName: string
gatewayType: string
location: string
resourceGroupName: string
tags:
string: string
Gateway 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 Gateway resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Allowed
Features List<string> - Specifies the list of features that are enabled for this Gateway.
- Gateway
Name string - The name of the Gateway.
- Gateway
Type string | Pulumi.Azure Native. Hybrid Compute. Gateway Type - The type of the Gateway resource.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Allowed
Features []string - Specifies the list of features that are enabled for this Gateway.
- Gateway
Name string - The name of the Gateway.
- Gateway
Type string | GatewayType - The type of the Gateway resource.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- allowed
Features List<String> - Specifies the list of features that are enabled for this Gateway.
- gateway
Name String - The name of the Gateway.
- gateway
Type String | GatewayType - The type of the Gateway resource.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- allowed
Features string[] - Specifies the list of features that are enabled for this Gateway.
- gateway
Name string - The name of the Gateway.
- gateway
Type string | GatewayType - The type of the Gateway resource.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- allowed_
features Sequence[str] - Specifies the list of features that are enabled for this Gateway.
- gateway_
name str - The name of the Gateway.
- gateway_
type str | GatewayType - The type of the Gateway resource.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- allowed
Features List<String> - Specifies the list of features that are enabled for this Gateway.
- gateway
Name String - The name of the Gateway.
- gateway
Type String | "Public" - The type of the Gateway resource.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Gateway
Endpoint string - The endpoint fqdn for the Gateway.
- Gateway
Id string - A unique, immutable, identifier for the Gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data Pulumi.Azure Native. Hybrid Compute. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Gateway
Endpoint string - The endpoint fqdn for the Gateway.
- Gateway
Id string - A unique, immutable, identifier for the Gateway.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- gateway
Endpoint String - The endpoint fqdn for the Gateway.
- gateway
Id String - A unique, immutable, identifier for the Gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- gateway
Endpoint string - The endpoint fqdn for the Gateway.
- gateway
Id string - A unique, immutable, identifier for the Gateway.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- gateway_
endpoint str - The endpoint fqdn for the Gateway.
- gateway_
id str - A unique, immutable, identifier for the Gateway.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - The provisioning state, which only appears in the response.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- gateway
Endpoint String - The endpoint fqdn for the Gateway.
- gateway
Id String - A unique, immutable, identifier for the Gateway.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
GatewayType, GatewayTypeArgs
- Public
- Public
- Gateway
Type Public - Public
- Public
- Public
- Public
- Public
- PUBLIC
- Public
- "Public"
- Public
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:hybridcompute:Gateway {gatewayName} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0