1. Packages
  2. Azure Native
  3. API Docs
  4. devcenter
  5. NetworkConnection
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.devcenter.NetworkConnection

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Network related settings Azure REST API version: 2023-04-01. Prior API version in Azure Native 1.x: 2022-09-01-preview.

    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.

    Example Usage

    NetworkConnections_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var networkConnection = new AzureNative.DevCenter.NetworkConnection("networkConnection", new()
        {
            DomainJoinType = AzureNative.DevCenter.DomainJoinType.HybridAzureADJoin,
            DomainName = "mydomaincontroller.local",
            DomainPassword = "Password value for user",
            DomainUsername = "testuser@mydomaincontroller.local",
            Location = "centralus",
            NetworkConnectionName = "uswest3network",
            NetworkingResourceGroupName = "NetworkInterfaces",
            ResourceGroupName = "rg1",
            SubnetId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
        });
    
    });
    
    package main
    
    import (
    	devcenter "github.com/pulumi/pulumi-azure-native-sdk/devcenter/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := devcenter.NewNetworkConnection(ctx, "networkConnection", &devcenter.NetworkConnectionArgs{
    			DomainJoinType:              pulumi.String(devcenter.DomainJoinTypeHybridAzureADJoin),
    			DomainName:                  pulumi.String("mydomaincontroller.local"),
    			DomainPassword:              pulumi.String("Password value for user"),
    			DomainUsername:              pulumi.String("testuser@mydomaincontroller.local"),
    			Location:                    pulumi.String("centralus"),
    			NetworkConnectionName:       pulumi.String("uswest3network"),
    			NetworkingResourceGroupName: pulumi.String("NetworkInterfaces"),
    			ResourceGroupName:           pulumi.String("rg1"),
    			SubnetId:                    pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default"),
    		})
    		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.devcenter.NetworkConnection;
    import com.pulumi.azurenative.devcenter.NetworkConnectionArgs;
    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 networkConnection = new NetworkConnection("networkConnection", NetworkConnectionArgs.builder()
                .domainJoinType("HybridAzureADJoin")
                .domainName("mydomaincontroller.local")
                .domainPassword("Password value for user")
                .domainUsername("testuser@mydomaincontroller.local")
                .location("centralus")
                .networkConnectionName("uswest3network")
                .networkingResourceGroupName("NetworkInterfaces")
                .resourceGroupName("rg1")
                .subnetId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    network_connection = azure_native.devcenter.NetworkConnection("networkConnection",
        domain_join_type=azure_native.devcenter.DomainJoinType.HYBRID_AZURE_AD_JOIN,
        domain_name="mydomaincontroller.local",
        domain_password="Password value for user",
        domain_username="testuser@mydomaincontroller.local",
        location="centralus",
        network_connection_name="uswest3network",
        networking_resource_group_name="NetworkInterfaces",
        resource_group_name="rg1",
        subnet_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const networkConnection = new azure_native.devcenter.NetworkConnection("networkConnection", {
        domainJoinType: azure_native.devcenter.DomainJoinType.HybridAzureADJoin,
        domainName: "mydomaincontroller.local",
        domainPassword: "Password value for user",
        domainUsername: "testuser@mydomaincontroller.local",
        location: "centralus",
        networkConnectionName: "uswest3network",
        networkingResourceGroupName: "NetworkInterfaces",
        resourceGroupName: "rg1",
        subnetId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
    });
    
    resources:
      networkConnection:
        type: azure-native:devcenter:NetworkConnection
        properties:
          domainJoinType: HybridAzureADJoin
          domainName: mydomaincontroller.local
          domainPassword: Password value for user
          domainUsername: testuser@mydomaincontroller.local
          location: centralus
          networkConnectionName: uswest3network
          networkingResourceGroupName: NetworkInterfaces
          resourceGroupName: rg1
          subnetId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default
    

    Create NetworkConnection Resource

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

    Constructor syntax

    new NetworkConnection(name: string, args: NetworkConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkConnection(resource_name: str,
                          args: NetworkConnectionArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkConnection(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          domain_join_type: Optional[Union[str, DomainJoinType]] = None,
                          resource_group_name: Optional[str] = None,
                          subnet_id: Optional[str] = None,
                          domain_name: Optional[str] = None,
                          domain_password: Optional[str] = None,
                          domain_username: Optional[str] = None,
                          location: Optional[str] = None,
                          network_connection_name: Optional[str] = None,
                          networking_resource_group_name: Optional[str] = None,
                          organization_unit: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewNetworkConnection(ctx *Context, name string, args NetworkConnectionArgs, opts ...ResourceOption) (*NetworkConnection, error)
    public NetworkConnection(string name, NetworkConnectionArgs args, CustomResourceOptions? opts = null)
    public NetworkConnection(String name, NetworkConnectionArgs args)
    public NetworkConnection(String name, NetworkConnectionArgs args, CustomResourceOptions options)
    
    type: azure-native:devcenter:NetworkConnection
    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 NetworkConnectionArgs
    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 NetworkConnectionArgs
    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 NetworkConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkConnectionArgs
    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 networkConnectionResource = new AzureNative.DevCenter.NetworkConnection("networkConnectionResource", new()
    {
        DomainJoinType = "string",
        ResourceGroupName = "string",
        SubnetId = "string",
        DomainName = "string",
        DomainPassword = "string",
        DomainUsername = "string",
        Location = "string",
        NetworkConnectionName = "string",
        NetworkingResourceGroupName = "string",
        OrganizationUnit = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := devcenter.NewNetworkConnection(ctx, "networkConnectionResource", &devcenter.NetworkConnectionArgs{
    	DomainJoinType:              pulumi.String("string"),
    	ResourceGroupName:           pulumi.String("string"),
    	SubnetId:                    pulumi.String("string"),
    	DomainName:                  pulumi.String("string"),
    	DomainPassword:              pulumi.String("string"),
    	DomainUsername:              pulumi.String("string"),
    	Location:                    pulumi.String("string"),
    	NetworkConnectionName:       pulumi.String("string"),
    	NetworkingResourceGroupName: pulumi.String("string"),
    	OrganizationUnit:            pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var networkConnectionResource = new NetworkConnection("networkConnectionResource", NetworkConnectionArgs.builder()
        .domainJoinType("string")
        .resourceGroupName("string")
        .subnetId("string")
        .domainName("string")
        .domainPassword("string")
        .domainUsername("string")
        .location("string")
        .networkConnectionName("string")
        .networkingResourceGroupName("string")
        .organizationUnit("string")
        .tags(Map.of("string", "string"))
        .build());
    
    network_connection_resource = azure_native.devcenter.NetworkConnection("networkConnectionResource",
        domain_join_type="string",
        resource_group_name="string",
        subnet_id="string",
        domain_name="string",
        domain_password="string",
        domain_username="string",
        location="string",
        network_connection_name="string",
        networking_resource_group_name="string",
        organization_unit="string",
        tags={
            "string": "string",
        })
    
    const networkConnectionResource = new azure_native.devcenter.NetworkConnection("networkConnectionResource", {
        domainJoinType: "string",
        resourceGroupName: "string",
        subnetId: "string",
        domainName: "string",
        domainPassword: "string",
        domainUsername: "string",
        location: "string",
        networkConnectionName: "string",
        networkingResourceGroupName: "string",
        organizationUnit: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:devcenter:NetworkConnection
    properties:
        domainJoinType: string
        domainName: string
        domainPassword: string
        domainUsername: string
        location: string
        networkConnectionName: string
        networkingResourceGroupName: string
        organizationUnit: string
        resourceGroupName: string
        subnetId: string
        tags:
            string: string
    

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

    DomainJoinType string | Pulumi.AzureNative.DevCenter.DomainJoinType
    AAD Join type.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SubnetId string
    The subnet to attach Virtual Machines to
    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.
    Location string
    The geo-location where the resource lives
    NetworkConnectionName string
    Name of the Network Connection that can be applied to a Pool.
    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 | DomainJoinType
    AAD Join type.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SubnetId string
    The subnet to attach Virtual Machines to
    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.
    Location string
    The geo-location where the resource lives
    NetworkConnectionName string
    Name of the Network Connection that can be applied to a Pool.
    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 | DomainJoinType
    AAD Join type.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subnetId String
    The subnet to attach Virtual Machines to
    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.
    location String
    The geo-location where the resource lives
    networkConnectionName String
    Name of the Network Connection that can be applied to a Pool.
    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 | DomainJoinType
    AAD Join type.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    subnetId string
    The subnet to attach Virtual Machines to
    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.
    location string
    The geo-location where the resource lives
    networkConnectionName string
    Name of the Network Connection that can be applied to a Pool.
    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 | DomainJoinType
    AAD Join type.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    subnet_id str
    The subnet to attach Virtual Machines to
    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.
    location str
    The geo-location where the resource lives
    network_connection_name str
    Name of the Network Connection that can be applied to a Pool.
    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 | "HybridAzureADJoin" | "AzureADJoin"
    AAD Join type.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subnetId String
    The subnet to attach Virtual Machines to
    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.
    location String
    The geo-location where the resource lives
    networkConnectionName String
    Name of the Network Connection that can be applied to a Pool.
    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.

    Outputs

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

    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
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the resource.
    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"
    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
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the 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"
    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
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the 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"
    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
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the 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"
    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
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the 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"
    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
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the 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

    DomainJoinType, DomainJoinTypeArgs

    HybridAzureADJoin
    HybridAzureADJoin
    AzureADJoin
    AzureADJoin
    DomainJoinTypeHybridAzureADJoin
    HybridAzureADJoin
    DomainJoinTypeAzureADJoin
    AzureADJoin
    HybridAzureADJoin
    HybridAzureADJoin
    AzureADJoin
    AzureADJoin
    HybridAzureADJoin
    HybridAzureADJoin
    AzureADJoin
    AzureADJoin
    HYBRID_AZURE_AD_JOIN
    HybridAzureADJoin
    AZURE_AD_JOIN
    AzureADJoin
    "HybridAzureADJoin"
    HybridAzureADJoin
    "AzureADJoin"
    AzureADJoin

    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:devcenter:NetworkConnection uswest3network /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName} 
    

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi