Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devcenter
  5. getNetworkConnection
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devcenter.getNetworkConnection

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a network connection resource

Uses Azure REST API version 2023-04-01.

Other available API versions: 2023-08-01-preview, 2023-10-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01.

Using getNetworkConnection

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 getNetworkConnection(args: GetNetworkConnectionArgs, opts?: InvokeOptions): Promise<GetNetworkConnectionResult>
function getNetworkConnectionOutput(args: GetNetworkConnectionOutputArgs, opts?: InvokeOptions): Output<GetNetworkConnectionResult>
Copy
def get_network_connection(network_connection_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNetworkConnectionResult
def get_network_connection_output(network_connection_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNetworkConnectionResult]
Copy
func LookupNetworkConnection(ctx *Context, args *LookupNetworkConnectionArgs, opts ...InvokeOption) (*LookupNetworkConnectionResult, error)
func LookupNetworkConnectionOutput(ctx *Context, args *LookupNetworkConnectionOutputArgs, opts ...InvokeOption) LookupNetworkConnectionResultOutput
Copy

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

public static class GetNetworkConnection 
{
    public static Task<GetNetworkConnectionResult> InvokeAsync(GetNetworkConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkConnectionResult> Invoke(GetNetworkConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkConnectionResult> getNetworkConnection(GetNetworkConnectionArgs args, InvokeOptions options)
public static Output<GetNetworkConnectionResult> getNetworkConnection(GetNetworkConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devcenter:getNetworkConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Network Connection that can be applied to a Pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
NetworkConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Network Connection that can be applied to a Pool.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
networkConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Network Connection that can be applied to a Pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
networkConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Network Connection that can be applied to a Pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
network_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Network Connection that can be applied to a Pool.
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.
networkConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Network Connection that can be applied to a Pool.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getNetworkConnection Result

The following output properties are available:

DomainJoinType string
AAD Join type.
HealthCheckStatus string
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SubnetId string
The subnet to attach Virtual Machines to
SystemData Pulumi.AzureNative.DevCenter.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"
DomainName string
Active Directory domain name
DomainPassword string
The password for the account used to join domain
DomainUsername string
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
NetworkingResourceGroupName string
The name for resource group where NICs will be placed.
OrganizationUnit string
Active Directory domain Organization Unit (OU)
Tags Dictionary<string, string>
Resource tags.
DomainJoinType string
AAD Join type.
HealthCheckStatus string
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SubnetId string
The subnet to attach Virtual Machines to
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"
DomainName string
Active Directory domain name
DomainPassword string
The password for the account used to join domain
DomainUsername string
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
NetworkingResourceGroupName string
The name for resource group where NICs will be placed.
OrganizationUnit string
Active Directory domain Organization Unit (OU)
Tags map[string]string
Resource tags.
domainJoinType String
AAD Join type.
healthCheckStatus String
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
subnetId String
The subnet to attach Virtual Machines to
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"
domainName String
Active Directory domain name
domainPassword String
The password for the account used to join domain
domainUsername String
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
networkingResourceGroupName String
The name for resource group where NICs will be placed.
organizationUnit String
Active Directory domain Organization Unit (OU)
tags Map<String,String>
Resource tags.
domainJoinType string
AAD Join type.
healthCheckStatus string
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The provisioning state of the resource.
subnetId string
The subnet to attach Virtual Machines to
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"
domainName string
Active Directory domain name
domainPassword string
The password for the account used to join domain
domainUsername string
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
networkingResourceGroupName string
The name for resource group where NICs will be placed.
organizationUnit string
Active Directory domain Organization Unit (OU)
tags {[key: string]: string}
Resource tags.
domain_join_type str
AAD Join type.
health_check_status str
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The provisioning state of the resource.
subnet_id str
The subnet to attach Virtual Machines to
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"
domain_name str
Active Directory domain name
domain_password str
The password for the account used to join domain
domain_username str
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
networking_resource_group_name str
The name for resource group where NICs will be placed.
organization_unit str
Active Directory domain Organization Unit (OU)
tags Mapping[str, str]
Resource tags.
domainJoinType String
AAD Join type.
healthCheckStatus String
Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
subnetId String
The subnet to attach Virtual Machines to
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"
domainName String
Active Directory domain name
domainPassword String
The password for the account used to join domain
domainUsername String
The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.
networkingResourceGroupName String
The name for resource group where NICs will be placed.
organizationUnit String
Active Directory domain Organization Unit (OU)
tags Map<String>
Resource tags.

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 v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native