@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a network connection resource
*
* Uses Azure REST API version 2024-02-01.
*
* Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01, 2025-04-01-preview, 2025-07-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native devcenter [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNetworkConnection(args: GetNetworkConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkConnectionResult>;
export interface GetNetworkConnectionArgs {
/**
* Name of the Network Connection that can be applied to a Pool.
*/
networkConnectionName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Network related settings
*/
export interface GetNetworkConnectionResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* AAD Join type.
*/
readonly domainJoinType: string;
/**
* Active Directory domain name
*/
readonly domainName?: string;
/**
* The password for the account used to join domain
*/
readonly domainPassword?: 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.
*/
readonly domainUsername?: string;
/**
* Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.
*/
readonly healthCheckStatus: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* The name for resource group where NICs will be placed.
*/
readonly networkingResourceGroupName?: string;
/**
* Active Directory domain Organization Unit (OU)
*/
readonly organizationUnit?: string;
/**
* The provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* The subnet to attach Virtual Machines to
*/
readonly subnetId: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.devcenter.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets a network connection resource
*
* Uses Azure REST API version 2024-02-01.
*
* Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01, 2025-04-01-preview, 2025-07-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native devcenter [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNetworkConnectionOutput(args: GetNetworkConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkConnectionResult>;
export interface GetNetworkConnectionOutputArgs {
/**
* Name of the Network Connection that can be applied to a Pool.
*/
networkConnectionName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}