Workload Networks - Create Segments

Service:

AVS

API Version:

2023-09-01

Create a WorkloadNetworkSegment

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Name of the private cloud
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
segmentId	path	True	string pattern: ^[-\w\._]+$	The ID of the NSX Segment
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.connectedGateway	string	Gateway which to connect segment to.
properties.displayName	string	Display name of the segment.
properties.revision	integer (int64)	NSX revision number.
properties.subnet	WorkloadNetworkSegmentSubnet	Subnet which to connect segment to.

Responses

Name	Type	Description
200 OK	WorkloadNetworkSegment	Resource 'WorkloadNetworkSegment' update operation succeeded
201 Created	WorkloadNetworkSegment	Resource 'WorkloadNetworkSegment' create operation succeeded Headers Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

WorkloadNetworks_CreateSegments

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/segments/segment1?api-version=2023-09-01

{
  "properties": {
    "displayName": "segment1",
    "connectedGateway": "/infra/tier-1s/gateway",
    "subnet": {
      "dhcpRanges": [
        "40.20.0.0-40.20.0.1"
      ],
      "gatewayAddress": "40.20.20.20/16"
    },
    "revision": 1
  }
}

Java

import com.azure.resourcemanager.avs.models.WorkloadNetworkSegmentSubnet;
import java.util.Arrays;

/**
 * Samples for WorkloadNetworks CreateSegments.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/WorkloadNetworks_CreateSegments.
     * json
     */
    /**
     * Sample code: WorkloadNetworks_CreateSegments.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void workloadNetworksCreateSegments(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.workloadNetworks().defineSegments("segment1").withExistingPrivateCloud("group1", "cloud1")
            .withDisplayName("segment1").withConnectedGateway("/infra/tier-1s/gateway")
            .withSubnet(new WorkloadNetworkSegmentSubnet().withDhcpRanges(Arrays.asList("40.20.0.0-40.20.0.1"))
                .withGatewayAddress("40.20.20.20/16"))
            .withRevision(1L).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python workload_networks_create_segments.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.workload_networks.begin_create_segments(
        resource_group_name="group1",
        private_cloud_name="cloud1",
        segment_id="segment1",
        workload_network_segment={
            "properties": {
                "connectedGateway": "/infra/tier-1s/gateway",
                "displayName": "segment1",
                "revision": 1,
                "subnet": {"dhcpRanges": ["40.20.0.0-40.20.0.1"], "gatewayAddress": "40.20.20.20/16"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/WorkloadNetworks_CreateSegments.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armavs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7678455846b1000fd31db27596e4ca3d299a872/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/WorkloadNetworks_CreateSegments.json
func ExampleWorkloadNetworksClient_BeginCreateSegments() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkloadNetworksClient().BeginCreateSegments(ctx, "group1", "cloud1", "segment1", armavs.WorkloadNetworkSegment{
		Properties: &armavs.WorkloadNetworkSegmentProperties{
			ConnectedGateway: to.Ptr("/infra/tier-1s/gateway"),
			DisplayName:      to.Ptr("segment1"),
			Revision:         to.Ptr[int64](1),
			Subnet: &armavs.WorkloadNetworkSegmentSubnet{
				DhcpRanges: []*string{
					to.Ptr("40.20.0.0-40.20.0.1")},
				GatewayAddress: to.Ptr("40.20.20.20/16"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkloadNetworkSegment = armavs.WorkloadNetworkSegment{
	// 	Name: to.Ptr("segment1"),
	// 	Type: to.Ptr("Microsoft.AVS/privateClouds/workloadNetworks/segments"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/segments/segment1"),
	// 	Properties: &armavs.WorkloadNetworkSegmentProperties{
	// 		ConnectedGateway: to.Ptr("/infra/tier-1s/gateway"),
	// 		DisplayName: to.Ptr("segment1"),
	// 		PortVif: []*armavs.WorkloadNetworkSegmentPortVif{
	// 		},
	// 		Revision: to.Ptr[int64](1),
	// 		Status: to.Ptr(armavs.SegmentStatusEnumSUCCESS),
	// 		Subnet: &armavs.WorkloadNetworkSegmentSubnet{
	// 			DhcpRanges: []*string{
	// 				to.Ptr("40.20.0.0-40.20.0.1")},
	// 				GatewayAddress: to.Ptr("40.20.20.20/16"),
	// 			},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create a WorkloadNetworkSegment
 *
 * @summary Create a WorkloadNetworkSegment
 * x-ms-original-file: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/WorkloadNetworks_CreateSegments.json
 */
async function workloadNetworksCreateSegments() {
  const subscriptionId =
    process.env["AVS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["AVS_RESOURCE_GROUP"] || "group1";
  const privateCloudName = "cloud1";
  const segmentId = "segment1";
  const workloadNetworkSegment = {
    connectedGateway: "/infra/tier-1s/gateway",
    displayName: "segment1",
    revision: 1,
    subnet: {
      dhcpRanges: ["40.20.0.0-40.20.0.1"],
      gatewayAddress: "40.20.20.20/16",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const result = await client.workloadNetworks.beginCreateSegmentsAndWait(
    resourceGroupName,
    privateCloudName,
    segmentId,
    workloadNetworkSegment,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Avs.Models;
using Azure.ResourceManager.Avs;

// Generated from example definition: specification/vmware/resource-manager/Microsoft.AVS/stable/2023-09-01/examples/WorkloadNetworks_CreateSegments.json
// this example is just showing the usage of "WorkloadNetworks_CreateSegments" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkloadNetworkResource created on azure
// for more information of creating WorkloadNetworkResource, please refer to the document of WorkloadNetworkResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "group1";
string privateCloudName = "cloud1";
ResourceIdentifier workloadNetworkResourceId = WorkloadNetworkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, privateCloudName);
WorkloadNetworkResource workloadNetwork = client.GetWorkloadNetworkResource(workloadNetworkResourceId);

// get the collection of this WorkloadNetworkSegmentResource
WorkloadNetworkSegmentCollection collection = workloadNetwork.GetWorkloadNetworkSegments();

// invoke the operation
string segmentId = "segment1";
WorkloadNetworkSegmentData data = new WorkloadNetworkSegmentData()
{
    DisplayName = "segment1",
    ConnectedGateway = "/infra/tier-1s/gateway",
    Subnet = new WorkloadNetworkSegmentSubnet()
    {
        DhcpRanges =
        {
        "40.20.0.0-40.20.0.1"
        },
        GatewayAddress = "40.20.20.20/16",
    },
    Revision = 1L,
};
ArmOperation<WorkloadNetworkSegmentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, segmentId, data);
WorkloadNetworkSegmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WorkloadNetworkSegmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/segments/segment1",
  "name": "segment1",
  "properties": {
    "displayName": "segment1",
    "connectedGateway": "/infra/tier-1s/gateway",
    "subnet": {
      "dhcpRanges": [
        "40.20.0.0-40.20.0.1"
      ],
      "gatewayAddress": "40.20.20.20/16"
    },
    "portVif": [],
    "status": "SUCCESS",
    "revision": 1
  },
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/segments"
}

Status code:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/segments/segment1",
  "name": "segment1",
  "properties": {
    "displayName": "segment1",
    "connectedGateway": "/infra/tier-1s/gateway",
    "subnet": {
      "dhcpRanges": [
        "40.20.0.0-40.20.0.1"
      ],
      "gatewayAddress": "40.20.20.20/16"
    },
    "portVif": [],
    "status": "SUCCESS",
    "revision": 1
  },
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/segments"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SegmentStatusEnum	Segment status
systemData	Metadata pertaining to creation and last modification of the resource.
WorkloadNetworkSegment	NSX Segment
WorkloadNetworkSegmentPortVif	Ports and any VIF attached to segment.
WorkloadNetworkSegmentProvisioningState	Workload Network Segment provisioning state
WorkloadNetworkSegmentSubnet	Subnet configuration for segment

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SegmentStatusEnum

Enumeration

Segment status

Value	Description
SUCCESS	is success
FAILURE	is failure

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

WorkloadNetworkSegment

Object

NSX Segment

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.connectedGateway	string	Gateway which to connect segment to.
properties.displayName	string	Display name of the segment.
properties.portVif	WorkloadNetworkSegmentPortVif[]	Port Vif which segment is associated with.
properties.provisioningState	WorkloadNetworkSegmentProvisioningState	The provisioning state
properties.revision	integer (int64)	NSX revision number.
properties.status	SegmentStatusEnum	Segment status.
properties.subnet	WorkloadNetworkSegmentSubnet	Subnet which to connect segment to.
systemData	systemData	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"

WorkloadNetworkSegmentPortVif

Object

Ports and any VIF attached to segment.

Name	Type	Description
portName	string	Name of port or VIF attached to segment.

WorkloadNetworkSegmentProvisioningState

Enumeration

Workload Network Segment provisioning state

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Building	is building
Deleting	is deleting
Updating	is updating

WorkloadNetworkSegmentSubnet

Object

Subnet configuration for segment

Name	Type	Description
dhcpRanges	string[]	DHCP Range assigned for subnet.
gatewayAddress	string	Gateway address.