Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. GlobalReachConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.GlobalReachConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    A global reach connection resource

    Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-01.

    Other available API versions: 2022-05-01, 2023-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native avs [ApiVersion]. See the version guide for details.

    Example Usage

    GlobalReachConnections_CreateOrUpdate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var globalReachConnection = new AzureNative.AVS.GlobalReachConnection("globalReachConnection", new()
    {
        AuthorizationKey = "01010101-0101-0101-0101-010101010101",
        GlobalReachConnectionName = "connection1",
        PeerExpressRouteCircuit = "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer",
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
    });

});

    package main

import (
	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avs.NewGlobalReachConnection(ctx, "globalReachConnection", &avs.GlobalReachConnectionArgs{
			AuthorizationKey:          pulumi.String("01010101-0101-0101-0101-010101010101"),
			GlobalReachConnectionName: pulumi.String("connection1"),
			PeerExpressRouteCircuit:   pulumi.String("/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer"),
			PrivateCloudName:          pulumi.String("cloud1"),
			ResourceGroupName:         pulumi.String("group1"),
		})
		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.avs.GlobalReachConnection;
import com.pulumi.azurenative.avs.GlobalReachConnectionArgs;
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 globalReachConnection = new GlobalReachConnection("globalReachConnection", GlobalReachConnectionArgs.builder()
            .authorizationKey("01010101-0101-0101-0101-010101010101")
            .globalReachConnectionName("connection1")
            .peerExpressRouteCircuit("/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer")
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const globalReachConnection = new azure_native.avs.GlobalReachConnection("globalReachConnection", {
    authorizationKey: "01010101-0101-0101-0101-010101010101",
    globalReachConnectionName: "connection1",
    peerExpressRouteCircuit: "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer",
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
});

    import pulumi
import pulumi_azure_native as azure_native

global_reach_connection = azure_native.avs.GlobalReachConnection("globalReachConnection",
    authorization_key="01010101-0101-0101-0101-010101010101",
    global_reach_connection_name="connection1",
    peer_express_route_circuit="/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer",
    private_cloud_name="cloud1",
    resource_group_name="group1")

    resources:
  globalReachConnection:
    type: azure-native:avs:GlobalReachConnection
    properties:
      authorizationKey: 01010101-0101-0101-0101-010101010101
      globalReachConnectionName: connection1
      peerExpressRouteCircuit: /subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer
      privateCloudName: cloud1
      resourceGroupName: group1

    Create GlobalReachConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GlobalReachConnection(name: string, args: GlobalReachConnectionArgs, opts?: CustomResourceOptions);
    @overload
def GlobalReachConnection(resource_name: str,
                          args: GlobalReachConnectionArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def GlobalReachConnection(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          private_cloud_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          authorization_key: Optional[str] = None,
                          express_route_id: Optional[str] = None,
                          global_reach_connection_name: Optional[str] = None,
                          peer_express_route_circuit: Optional[str] = None)
    func NewGlobalReachConnection(ctx *Context, name string, args GlobalReachConnectionArgs, opts ...ResourceOption) (*GlobalReachConnection, error)
    public GlobalReachConnection(string name, GlobalReachConnectionArgs args, CustomResourceOptions? opts = null)
    public GlobalReachConnection(String name, GlobalReachConnectionArgs args)
public GlobalReachConnection(String name, GlobalReachConnectionArgs args, CustomResourceOptions options)

    type: azure-native:avs:GlobalReachConnection
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 GlobalReachConnectionArgs
    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 GlobalReachConnectionArgs
    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 GlobalReachConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalReachConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalReachConnectionArgs
    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 globalReachConnectionResource = new AzureNative.AVS.GlobalReachConnection("globalReachConnectionResource", new()
{
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    AuthorizationKey = "string",
    ExpressRouteId = "string",
    GlobalReachConnectionName = "string",
    PeerExpressRouteCircuit = "string",
});

    example, err := avs.NewGlobalReachConnection(ctx, "globalReachConnectionResource", &avs.GlobalReachConnectionArgs{
	PrivateCloudName:          pulumi.String("string"),
	ResourceGroupName:         pulumi.String("string"),
	AuthorizationKey:          pulumi.String("string"),
	ExpressRouteId:            pulumi.String("string"),
	GlobalReachConnectionName: pulumi.String("string"),
	PeerExpressRouteCircuit:   pulumi.String("string"),
})

    var globalReachConnectionResource = new GlobalReachConnection("globalReachConnectionResource", GlobalReachConnectionArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .authorizationKey("string")
    .expressRouteId("string")
    .globalReachConnectionName("string")
    .peerExpressRouteCircuit("string")
    .build());

    global_reach_connection_resource = azure_native.avs.GlobalReachConnection("globalReachConnectionResource",
    private_cloud_name="string",
    resource_group_name="string",
    authorization_key="string",
    express_route_id="string",
    global_reach_connection_name="string",
    peer_express_route_circuit="string")

    const globalReachConnectionResource = new azure_native.avs.GlobalReachConnection("globalReachConnectionResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    authorizationKey: "string",
    expressRouteId: "string",
    globalReachConnectionName: "string",
    peerExpressRouteCircuit: "string",
});

    type: azure-native:avs:GlobalReachConnection
properties:
    authorizationKey: string
    expressRouteId: string
    globalReachConnectionName: string
    peerExpressRouteCircuit: string
    privateCloudName: string
    resourceGroupName: string

    GlobalReachConnection 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 GlobalReachConnection resource accepts the following input properties:

    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthorizationKey string
    Authorization key from the peer express route used for the global reach connection
    ExpressRouteId string
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    GlobalReachConnectionName string
    Name of the global reach connection
    PeerExpressRouteCircuit string
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthorizationKey string
    Authorization key from the peer express route used for the global reach connection
    ExpressRouteId string
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    GlobalReachConnectionName string
    Name of the global reach connection
    PeerExpressRouteCircuit string
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authorizationKey String
    Authorization key from the peer express route used for the global reach connection
    expressRouteId String
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    globalReachConnectionName String
    Name of the global reach connection
    peerExpressRouteCircuit String
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authorizationKey string
    Authorization key from the peer express route used for the global reach connection
    expressRouteId string
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    globalReachConnectionName string
    Name of the global reach connection
    peerExpressRouteCircuit string
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    authorization_key str
    Authorization key from the peer express route used for the global reach connection
    express_route_id str
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    global_reach_connection_name str
    Name of the global reach connection
    peer_express_route_circuit str
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authorizationKey String
    Authorization key from the peer express route used for the global reach connection
    expressRouteId String
    The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection
    globalReachConnectionName String
    Name of the global reach connection
    peerExpressRouteCircuit String
    Identifier of the ExpressRoute Circuit to peer with in the global reach connection

    Outputs

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

    AddressPrefix string
    The network used for global reach carved out from the original network block provided for the private cloud
    AzureApiVersion string
    The Azure API version of the resource.
    CircuitConnectionStatus string
    The connection status of the global reach connection
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The state of the ExpressRoute Circuit Authorization provisioning
    SystemData Pulumi.AzureNative.AVS.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"
    AddressPrefix string
    The network used for global reach carved out from the original network block provided for the private cloud
    AzureApiVersion string
    The Azure API version of the resource.
    CircuitConnectionStatus string
    The connection status of the global reach connection
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The state of the ExpressRoute Circuit Authorization provisioning
    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"
    addressPrefix String
    The network used for global reach carved out from the original network block provided for the private cloud
    azureApiVersion String
    The Azure API version of the resource.
    circuitConnectionStatus String
    The connection status of the global reach connection
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The state of the ExpressRoute Circuit Authorization provisioning
    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"
    addressPrefix string
    The network used for global reach carved out from the original network block provided for the private cloud
    azureApiVersion string
    The Azure API version of the resource.
    circuitConnectionStatus string
    The connection status of the global reach connection
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The state of the ExpressRoute Circuit Authorization provisioning
    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"
    address_prefix str
    The network used for global reach carved out from the original network block provided for the private cloud
    azure_api_version str
    The Azure API version of the resource.
    circuit_connection_status str
    The connection status of the global reach connection
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The state of the ExpressRoute Circuit Authorization provisioning
    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"
    addressPrefix String
    The network used for global reach carved out from the original network block provided for the private cloud
    azureApiVersion String
    The Azure API version of the resource.
    circuitConnectionStatus String
    The connection status of the global reach connection
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The state of the ExpressRoute Circuit Authorization provisioning
    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:avs:GlobalReachConnection connection1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native