1. Packages
  2. Azure Native
  3. API Docs
  4. programmableconnectivity
  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.72.0 published on Wednesday, Nov 13, 2024 by Pulumi

azure-native.programmableconnectivity.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.72.0 published on Wednesday, Nov 13, 2024 by Pulumi

    A Programmable Connectivity Gateway resource Azure REST API version: 2024-01-15-preview.

    Example Usage

    Gateways_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var gateway = new AzureNative.ProgrammableConnectivity.Gateway("gateway", new()
        {
            GatewayName = "pgzk",
            Location = "oryhozfmeohscezl",
            ResourceGroupName = "rgopenapi",
            Tags = 
            {
                { "key2642", "ykmlftvwwpvcmriffxqh" },
            },
        });
    
    });
    
    package main
    
    import (
    	programmableconnectivity "github.com/pulumi/pulumi-azure-native-sdk/programmableconnectivity/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := programmableconnectivity.NewGateway(ctx, "gateway", &programmableconnectivity.GatewayArgs{
    			GatewayName:       pulumi.String("pgzk"),
    			Location:          pulumi.String("oryhozfmeohscezl"),
    			ResourceGroupName: pulumi.String("rgopenapi"),
    			Tags: pulumi.StringMap{
    				"key2642": pulumi.String("ykmlftvwwpvcmriffxqh"),
    			},
    		})
    		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.programmableconnectivity.Gateway;
    import com.pulumi.azurenative.programmableconnectivity.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()
                .gatewayName("pgzk")
                .location("oryhozfmeohscezl")
                .resourceGroupName("rgopenapi")
                .tags(Map.of("key2642", "ykmlftvwwpvcmriffxqh"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    gateway = azure_native.programmableconnectivity.Gateway("gateway",
        gateway_name="pgzk",
        location="oryhozfmeohscezl",
        resource_group_name="rgopenapi",
        tags={
            "key2642": "ykmlftvwwpvcmriffxqh",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const gateway = new azure_native.programmableconnectivity.Gateway("gateway", {
        gatewayName: "pgzk",
        location: "oryhozfmeohscezl",
        resourceGroupName: "rgopenapi",
        tags: {
            key2642: "ykmlftvwwpvcmriffxqh",
        },
    });
    
    resources:
      gateway:
        type: azure-native:programmableconnectivity:Gateway
        properties:
          gatewayName: pgzk
          location: oryhozfmeohscezl
          resourceGroupName: rgopenapi
          tags:
            key2642: ykmlftvwwpvcmriffxqh
    

    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,
                gateway_name: Optional[str] = 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:programmableconnectivity: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 examplegatewayResourceResourceFromProgrammableconnectivity = new AzureNative.ProgrammableConnectivity.Gateway("examplegatewayResourceResourceFromProgrammableconnectivity", new()
    {
        ResourceGroupName = "string",
        GatewayName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := programmableconnectivity.NewGateway(ctx, "examplegatewayResourceResourceFromProgrammableconnectivity", &programmableconnectivity.GatewayArgs{
    	ResourceGroupName: pulumi.String("string"),
    	GatewayName:       pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var examplegatewayResourceResourceFromProgrammableconnectivity = new Gateway("examplegatewayResourceResourceFromProgrammableconnectivity", GatewayArgs.builder()
        .resourceGroupName("string")
        .gatewayName("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    examplegateway_resource_resource_from_programmableconnectivity = azure_native.programmableconnectivity.Gateway("examplegatewayResourceResourceFromProgrammableconnectivity",
        resource_group_name="string",
        gateway_name="string",
        location="string",
        tags={
            "string": "string",
        })
    
    const examplegatewayResourceResourceFromProgrammableconnectivity = new azure_native.programmableconnectivity.Gateway("examplegatewayResourceResourceFromProgrammableconnectivity", {
        resourceGroupName: "string",
        gatewayName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:programmableconnectivity:Gateway
    properties:
        gatewayName: 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:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    GatewayName string
    Azure Programmable Connectivity Gateway Name
    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.
    GatewayName string
    Azure Programmable Connectivity Gateway Name
    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.
    gatewayName String
    Azure Programmable Connectivity Gateway Name
    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.
    gatewayName string
    Azure Programmable Connectivity Gateway Name
    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.
    gateway_name str
    Azure Programmable Connectivity Gateway Name
    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.
    gatewayName String
    Azure Programmable Connectivity Gateway Name
    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:

    GatewayBaseUrl string
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    OperatorApiConnections List<string>
    List of Operator API Connections selected by the user
    ProvisioningState string
    The status of the last operation on the Gateway resource.
    SystemData Pulumi.AzureNative.ProgrammableConnectivity.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"
    GatewayBaseUrl string
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    OperatorApiConnections []string
    List of Operator API Connections selected by the user
    ProvisioningState string
    The status of the last operation on the Gateway resource.
    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"
    gatewayBaseUrl String
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    operatorApiConnections List<String>
    List of Operator API Connections selected by the user
    provisioningState String
    The status of the last operation on the Gateway resource.
    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"
    gatewayBaseUrl string
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    operatorApiConnections string[]
    List of Operator API Connections selected by the user
    provisioningState string
    The status of the last operation on the Gateway resource.
    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_base_url str
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    operator_api_connections Sequence[str]
    List of Operator API Connections selected by the user
    provisioning_state str
    The status of the last operation on the Gateway resource.
    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"
    gatewayBaseUrl String
    Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    operatorApiConnections List<String>
    List of Operator API Connections selected by the user
    provisioningState String
    The status of the last operation on the Gateway resource.
    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

    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:programmableconnectivity:Gateway qwlnmndshgfrtkp /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/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.72.0 published on Wednesday, Nov 13, 2024 by Pulumi