Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. WorkloadNetworkSegment
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.WorkloadNetworkSegment

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

    NSX Segment

    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

    WorkloadNetworks_CreateSegments

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

return await Deployment.RunAsync(() => 
{
    var workloadNetworkSegment = new AzureNative.AVS.WorkloadNetworkSegment("workloadNetworkSegment", new()
    {
        ConnectedGateway = "/infra/tier-1s/gateway",
        DisplayName = "segment1",
        PrivateCloudName = "cloud1",
        ResourceGroupName = "group1",
        Revision = 1,
        SegmentId = "segment1",
        Subnet = new AzureNative.AVS.Inputs.WorkloadNetworkSegmentSubnetArgs
        {
            DhcpRanges = new[]
            {
                "40.20.0.0-40.20.0.1",
            },
            GatewayAddress = "40.20.20.20/16",
        },
    });

});

    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.NewWorkloadNetworkSegment(ctx, "workloadNetworkSegment", &avs.WorkloadNetworkSegmentArgs{
			ConnectedGateway:  pulumi.String("/infra/tier-1s/gateway"),
			DisplayName:       pulumi.String("segment1"),
			PrivateCloudName:  pulumi.String("cloud1"),
			ResourceGroupName: pulumi.String("group1"),
			Revision:          pulumi.Float64(1),
			SegmentId:         pulumi.String("segment1"),
			Subnet: &avs.WorkloadNetworkSegmentSubnetArgs{
				DhcpRanges: pulumi.StringArray{
					pulumi.String("40.20.0.0-40.20.0.1"),
				},
				GatewayAddress: pulumi.String("40.20.20.20/16"),
			},
		})
		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.WorkloadNetworkSegment;
import com.pulumi.azurenative.avs.WorkloadNetworkSegmentArgs;
import com.pulumi.azurenative.avs.inputs.WorkloadNetworkSegmentSubnetArgs;
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 workloadNetworkSegment = new WorkloadNetworkSegment("workloadNetworkSegment", WorkloadNetworkSegmentArgs.builder()
            .connectedGateway("/infra/tier-1s/gateway")
            .displayName("segment1")
            .privateCloudName("cloud1")
            .resourceGroupName("group1")
            .revision(1.0)
            .segmentId("segment1")
            .subnet(WorkloadNetworkSegmentSubnetArgs.builder()
                .dhcpRanges("40.20.0.0-40.20.0.1")
                .gatewayAddress("40.20.20.20/16")
                .build())
            .build());

    }
}

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

const workloadNetworkSegment = new azure_native.avs.WorkloadNetworkSegment("workloadNetworkSegment", {
    connectedGateway: "/infra/tier-1s/gateway",
    displayName: "segment1",
    privateCloudName: "cloud1",
    resourceGroupName: "group1",
    revision: 1,
    segmentId: "segment1",
    subnet: {
        dhcpRanges: ["40.20.0.0-40.20.0.1"],
        gatewayAddress: "40.20.20.20/16",
    },
});

    import pulumi
import pulumi_azure_native as azure_native

workload_network_segment = azure_native.avs.WorkloadNetworkSegment("workloadNetworkSegment",
    connected_gateway="/infra/tier-1s/gateway",
    display_name="segment1",
    private_cloud_name="cloud1",
    resource_group_name="group1",
    revision=1,
    segment_id="segment1",
    subnet={
        "dhcp_ranges": ["40.20.0.0-40.20.0.1"],
        "gateway_address": "40.20.20.20/16",
    })

    resources:
  workloadNetworkSegment:
    type: azure-native:avs:WorkloadNetworkSegment
    properties:
      connectedGateway: /infra/tier-1s/gateway
      displayName: segment1
      privateCloudName: cloud1
      resourceGroupName: group1
      revision: 1
      segmentId: segment1
      subnet:
        dhcpRanges:
          - 40.20.0.0-40.20.0.1
        gatewayAddress: 40.20.20.20/16

    Create WorkloadNetworkSegment Resource

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

    Constructor syntax

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

@overload
def WorkloadNetworkSegment(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           private_cloud_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           connected_gateway: Optional[str] = None,
                           display_name: Optional[str] = None,
                           revision: Optional[float] = None,
                           segment_id: Optional[str] = None,
                           subnet: Optional[WorkloadNetworkSegmentSubnetArgs] = None)
    func NewWorkloadNetworkSegment(ctx *Context, name string, args WorkloadNetworkSegmentArgs, opts ...ResourceOption) (*WorkloadNetworkSegment, error)
    public WorkloadNetworkSegment(string name, WorkloadNetworkSegmentArgs args, CustomResourceOptions? opts = null)
    public WorkloadNetworkSegment(String name, WorkloadNetworkSegmentArgs args)
public WorkloadNetworkSegment(String name, WorkloadNetworkSegmentArgs args, CustomResourceOptions options)

    type: azure-native:avs:WorkloadNetworkSegment
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 WorkloadNetworkSegmentArgs
    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 WorkloadNetworkSegmentArgs
    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 WorkloadNetworkSegmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadNetworkSegmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadNetworkSegmentArgs
    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 workloadNetworkSegmentResource = new AzureNative.AVS.WorkloadNetworkSegment("workloadNetworkSegmentResource", new()
{
    PrivateCloudName = "string",
    ResourceGroupName = "string",
    ConnectedGateway = "string",
    DisplayName = "string",
    Revision = 0,
    SegmentId = "string",
    Subnet = new AzureNative.AVS.Inputs.WorkloadNetworkSegmentSubnetArgs
    {
        DhcpRanges = new[]
        {
            "string",
        },
        GatewayAddress = "string",
    },
});

    example, err := avs.NewWorkloadNetworkSegment(ctx, "workloadNetworkSegmentResource", &avs.WorkloadNetworkSegmentArgs{
	PrivateCloudName:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ConnectedGateway:  pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Revision:          pulumi.Float64(0),
	SegmentId:         pulumi.String("string"),
	Subnet: &avs.WorkloadNetworkSegmentSubnetArgs{
		DhcpRanges: pulumi.StringArray{
			pulumi.String("string"),
		},
		GatewayAddress: pulumi.String("string"),
	},
})

    var workloadNetworkSegmentResource = new WorkloadNetworkSegment("workloadNetworkSegmentResource", WorkloadNetworkSegmentArgs.builder()
    .privateCloudName("string")
    .resourceGroupName("string")
    .connectedGateway("string")
    .displayName("string")
    .revision(0)
    .segmentId("string")
    .subnet(WorkloadNetworkSegmentSubnetArgs.builder()
        .dhcpRanges("string")
        .gatewayAddress("string")
        .build())
    .build());

    workload_network_segment_resource = azure_native.avs.WorkloadNetworkSegment("workloadNetworkSegmentResource",
    private_cloud_name="string",
    resource_group_name="string",
    connected_gateway="string",
    display_name="string",
    revision=0,
    segment_id="string",
    subnet={
        "dhcp_ranges": ["string"],
        "gateway_address": "string",
    })

    const workloadNetworkSegmentResource = new azure_native.avs.WorkloadNetworkSegment("workloadNetworkSegmentResource", {
    privateCloudName: "string",
    resourceGroupName: "string",
    connectedGateway: "string",
    displayName: "string",
    revision: 0,
    segmentId: "string",
    subnet: {
        dhcpRanges: ["string"],
        gatewayAddress: "string",
    },
});

    type: azure-native:avs:WorkloadNetworkSegment
properties:
    connectedGateway: string
    displayName: string
    privateCloudName: string
    resourceGroupName: string
    revision: 0
    segmentId: string
    subnet:
        dhcpRanges:
            - string
        gatewayAddress: string

    WorkloadNetworkSegment 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 WorkloadNetworkSegment 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.
    ConnectedGateway string
    Gateway which to connect segment to.
    DisplayName string
    Display name of the segment.
    Revision double
    NSX revision number.
    SegmentId string
    The ID of the NSX Segment
    Subnet Pulumi.AzureNative.AVS.Inputs.WorkloadNetworkSegmentSubnet
    Subnet which to connect segment to.
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConnectedGateway string
    Gateway which to connect segment to.
    DisplayName string
    Display name of the segment.
    Revision float64
    NSX revision number.
    SegmentId string
    The ID of the NSX Segment
    Subnet WorkloadNetworkSegmentSubnetArgs
    Subnet which to connect segment to.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    connectedGateway String
    Gateway which to connect segment to.
    displayName String
    Display name of the segment.
    revision Double
    NSX revision number.
    segmentId String
    The ID of the NSX Segment
    subnet WorkloadNetworkSegmentSubnet
    Subnet which to connect segment to.
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    connectedGateway string
    Gateway which to connect segment to.
    displayName string
    Display name of the segment.
    revision number
    NSX revision number.
    segmentId string
    The ID of the NSX Segment
    subnet WorkloadNetworkSegmentSubnet
    Subnet which to connect segment to.
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    connected_gateway str
    Gateway which to connect segment to.
    display_name str
    Display name of the segment.
    revision float
    NSX revision number.
    segment_id str
    The ID of the NSX Segment
    subnet WorkloadNetworkSegmentSubnetArgs
    Subnet which to connect segment to.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    connectedGateway String
    Gateway which to connect segment to.
    displayName String
    Display name of the segment.
    revision Number
    NSX revision number.
    segmentId String
    The ID of the NSX Segment
    subnet Property Map
    Subnet which to connect segment to.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PortVif List<Pulumi.AzureNative.AVS.Outputs.WorkloadNetworkSegmentPortVifResponse>
    Port Vif which segment is associated with.
    ProvisioningState string
    The provisioning state
    Status string
    Segment status.
    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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    PortVif []WorkloadNetworkSegmentPortVifResponse
    Port Vif which segment is associated with.
    ProvisioningState string
    The provisioning state
    Status string
    Segment status.
    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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    portVif List<WorkloadNetworkSegmentPortVifResponse>
    Port Vif which segment is associated with.
    provisioningState String
    The provisioning state
    status String
    Segment status.
    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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    portVif WorkloadNetworkSegmentPortVifResponse[]
    Port Vif which segment is associated with.
    provisioningState string
    The provisioning state
    status string
    Segment status.
    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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    port_vif Sequence[WorkloadNetworkSegmentPortVifResponse]
    Port Vif which segment is associated with.
    provisioning_state str
    The provisioning state
    status str
    Segment status.
    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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    portVif List<Property Map>
    Port Vif which segment is associated with.
    provisioningState String
    The provisioning state
    status String
    Segment status.
    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.

    WorkloadNetworkSegmentPortVifResponse, WorkloadNetworkSegmentPortVifResponseArgs

    PortName string
    Name of port or VIF attached to segment.
    PortName string
    Name of port or VIF attached to segment.
    portName String
    Name of port or VIF attached to segment.
    portName string
    Name of port or VIF attached to segment.
    port_name str
    Name of port or VIF attached to segment.
    portName String
    Name of port or VIF attached to segment.

    WorkloadNetworkSegmentSubnet, WorkloadNetworkSegmentSubnetArgs

    DhcpRanges List<string>
    DHCP Range assigned for subnet.
    GatewayAddress string
    Gateway address.
    DhcpRanges []string
    DHCP Range assigned for subnet.
    GatewayAddress string
    Gateway address.
    dhcpRanges List<String>
    DHCP Range assigned for subnet.
    gatewayAddress String
    Gateway address.
    dhcpRanges string[]
    DHCP Range assigned for subnet.
    gatewayAddress string
    Gateway address.
    dhcp_ranges Sequence[str]
    DHCP Range assigned for subnet.
    gateway_address str
    Gateway address.
    dhcpRanges List<String>
    DHCP Range assigned for subnet.
    gatewayAddress String
    Gateway address.

    WorkloadNetworkSegmentSubnetResponse, WorkloadNetworkSegmentSubnetResponseArgs

    DhcpRanges List<string>
    DHCP Range assigned for subnet.
    GatewayAddress string
    Gateway address.
    DhcpRanges []string
    DHCP Range assigned for subnet.
    GatewayAddress string
    Gateway address.
    dhcpRanges List<String>
    DHCP Range assigned for subnet.
    gatewayAddress String
    Gateway address.
    dhcpRanges string[]
    DHCP Range assigned for subnet.
    gatewayAddress string
    Gateway address.
    dhcp_ranges Sequence[str]
    DHCP Range assigned for subnet.
    gateway_address str
    Gateway address.
    dhcpRanges List<String>
    DHCP Range assigned for subnet.
    gatewayAddress String
    Gateway address.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:avs:WorkloadNetworkSegment segment1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}

    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