Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. getGlobalReachConnection
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.avs.getGlobalReachConnection

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a GlobalReachConnection

Uses Azure REST API version 2023-09-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.

Using getGlobalReachConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGlobalReachConnection(args: GetGlobalReachConnectionArgs, opts?: InvokeOptions): Promise<GetGlobalReachConnectionResult>
function getGlobalReachConnectionOutput(args: GetGlobalReachConnectionOutputArgs, opts?: InvokeOptions): Output<GetGlobalReachConnectionResult>
Copy
def get_global_reach_connection(global_reach_connection_name: Optional[str] = None,
                                private_cloud_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetGlobalReachConnectionResult
def get_global_reach_connection_output(global_reach_connection_name: Optional[pulumi.Input[str]] = None,
                                private_cloud_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetGlobalReachConnectionResult]
Copy
func LookupGlobalReachConnection(ctx *Context, args *LookupGlobalReachConnectionArgs, opts ...InvokeOption) (*LookupGlobalReachConnectionResult, error)
func LookupGlobalReachConnectionOutput(ctx *Context, args *LookupGlobalReachConnectionOutputArgs, opts ...InvokeOption) LookupGlobalReachConnectionResultOutput
Copy

> Note: This function is named LookupGlobalReachConnection in the Go SDK.

public static class GetGlobalReachConnection 
{
    public static Task<GetGlobalReachConnectionResult> InvokeAsync(GetGlobalReachConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalReachConnectionResult> Invoke(GetGlobalReachConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGlobalReachConnectionResult> getGlobalReachConnection(GetGlobalReachConnectionArgs args, InvokeOptions options)
public static Output<GetGlobalReachConnectionResult> getGlobalReachConnection(GetGlobalReachConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:avs:getGlobalReachConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GlobalReachConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the global reach connection
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
GlobalReachConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the global reach connection
PrivateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
globalReachConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the global reach connection
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
globalReachConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the global reach connection
privateCloudName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
global_reach_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the global reach connection
private_cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private cloud
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
globalReachConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the global reach connection
privateCloudName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private cloud
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getGlobalReachConnection Result

The following output properties are available:

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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
PeerExpressRouteCircuit string
Identifier of the ExpressRoute Circuit to peer with in the global reach connection
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
PeerExpressRouteCircuit string
Identifier of the ExpressRoute Circuit to peer with in the global reach connection
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
peerExpressRouteCircuit String
Identifier of the ExpressRoute Circuit to peer with in the global reach connection
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
peerExpressRouteCircuit string
Identifier of the ExpressRoute Circuit to peer with in the global reach connection
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
peer_express_route_circuit str
Identifier of the ExpressRoute Circuit to peer with in the global reach connection
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
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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"
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
peerExpressRouteCircuit String
Identifier of the ExpressRoute Circuit to peer with in the global reach connection

Supporting Types

SystemDataResponse

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native