1. Packages
  2. Azure Native
  3. API Docs
  4. hybridcompute
  5. Gateway
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

azure-native.hybridcompute.Gateway

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi

    Describes an Arc Gateway. Azure REST API version: 2024-03-31-preview.

    Other available API versions: 2024-05-20-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

    The Gateway resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AllowedFeatures List<string>
    Specifies the list of features that are enabled for this Gateway.
    GatewayName string
    The name of the Gateway.
    GatewayType string | Pulumi.AzureNative.HybridCompute.GatewayType
    The type of the Gateway resource.
    Location string
    The geo-location where the resource lives
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AllowedFeatures []string
    Specifies the list of features that are enabled for this Gateway.
    GatewayName string
    The name of the Gateway.
    GatewayType string | GatewayType
    The type of the Gateway resource.
    Location string
    The geo-location where the resource lives
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    allowedFeatures List<String>
    Specifies the list of features that are enabled for this Gateway.
    gatewayName String
    The name of the Gateway.
    gatewayType String | GatewayType
    The type of the Gateway resource.
    location String
    The geo-location where the resource lives
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    allowedFeatures string[]
    Specifies the list of features that are enabled for this Gateway.
    gatewayName string
    The name of the Gateway.
    gatewayType string | GatewayType
    The type of the Gateway resource.
    location string
    The geo-location where the resource lives
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    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
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    allowedFeatures List<String>
    Specifies the list of features that are enabled for this Gateway.
    gatewayName String
    The name of the Gateway.
    gatewayType String | "Public"
    The type of the Gateway resource.
    location String
    The geo-location where the resource lives
    tags Map<String>
    Resource tags.

    Outputs

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

    GatewayEndpoint string
    The endpoint fqdn for the Gateway.
    GatewayId 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
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData Pulumi.AzureNative.HybridCompute.Outputs.SystemDataResponse
    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"
    GatewayEndpoint string
    The endpoint fqdn for the Gateway.
    GatewayId 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
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData SystemDataResponse
    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"
    gatewayEndpoint String
    The endpoint fqdn for the Gateway.
    gatewayId 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
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    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"
    gatewayEndpoint string
    The endpoint fqdn for the Gateway.
    gatewayId 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
    provisioningState string
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    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 SystemDataResponse
    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"
    gatewayEndpoint String
    The endpoint fqdn for the Gateway.
    gatewayId 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
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData 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
    GatewayTypePublic
    Public
    Public
    Public
    Public
    Public
    PUBLIC
    Public
    "Public"
    Public

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.0 published on Monday, Jul 15, 2024 by Pulumi