Workload Networks - List Segments

服务:

AVS

API 版本:

2025-09-01

按 WorkloadNetwork 分类的 WorkloadNetworkSegment 资源列表

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

URI 参数

名称	在	必需	类型	说明
privateCloudName	path	True	string pattern: ^[-\w\._]+$	私有云的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	WorkloadNetworkSegmentsList	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

WorkloadNetworks_ListSegments

示例请求

HTTP

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

Java

/**
 * Samples for WorkloadNetworks ListSegments.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/WorkloadNetworks_ListSegments.json
     */
    /**
     * Sample code: WorkloadNetworks_ListSegments.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void workloadNetworksListSegments(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.workloadNetworks().listSegments("group1", "cloud1", com.azure.core.util.Context.NONE);
    }
}

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_list_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="SUBSCRIPTION_ID",
    )

    response = client.workload_networks.list_segments(
        resource_group_name="group1",
        private_cloud_name="cloud1",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-09-01/WorkloadNetworks_ListSegments.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: 2025-09-01/WorkloadNetworks_ListSegments.json
func ExampleWorkloadNetworksClient_NewListSegmentsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkloadNetworksClient().NewListSegmentsPager("group1", "cloud1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armavs.WorkloadNetworksClientListSegmentsResponse{
		// 	WorkloadNetworkSegmentsList: armavs.WorkloadNetworkSegmentsList{
		// 		Value: []*armavs.WorkloadNetworkSegment{
		// 			{
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/segments/segment1"),
		// 				Name: to.Ptr("segment1"),
		// 				Properties: &armavs.WorkloadNetworkSegmentProperties{
		// 					DisplayName: to.Ptr("segment1"),
		// 					ConnectedGateway: to.Ptr("/infra/tier-1s/gateway"),
		// 					Subnet: &armavs.WorkloadNetworkSegmentSubnet{
		// 						DhcpRanges: []*string{
		// 							to.Ptr("40.20.0.0-40.20.0.1"),
		// 						},
		// 						GatewayAddress: to.Ptr("40.20.20.20/16"),
		// 					},
		// 					PortVif: []*armavs.WorkloadNetworkSegmentPortVif{
		// 						{
		// 							PortName: to.Ptr("vm1"),
		// 						},
		// 					},
		// 					Status: to.Ptr(armavs.SegmentStatusEnumSUCCESS),
		// 					Revision: to.Ptr[int64](1),
		// 				},
		// 				Type: to.Ptr("Microsoft.AVS/privateClouds/workloadNetworks/segments"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 list WorkloadNetworkSegment resources by WorkloadNetwork
 *
 * @summary list WorkloadNetworkSegment resources by WorkloadNetwork
 * x-ms-original-file: 2025-09-01/WorkloadNetworks_ListSegments.json
 */
async function workloadNetworksListSegments() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.workloadNetworks.listSegments("group1", "cloud1")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

示例响应

状态代码:

200

{
  "value": [
    {
      "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": [
          {
            "portName": "vm1"
          }
        ],
        "status": "SUCCESS",
        "revision": 1
      },
      "type": "Microsoft.AVS/privateClouds/workloadNetworks/segments"
    }
  ]
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
SegmentStatusEnum	路段现状
systemData	与创建和上次修改资源相关的元数据。
WorkloadNetworkSegment	NSX段
WorkloadNetworkSegmentPortVif	端口和任何连接到段子的VIF。
WorkloadNetworkSegmentProvisioningState	工作负载网络段配置状态
WorkloadNetworkSegmentsList	工作负载网络段列表作的响应。
WorkloadNetworkSegmentSubnet	段子网配置

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

SegmentStatusEnum

枚举

路段现状

值	说明
SUCCESS	是成功的
FAILURE	是失败的

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

WorkloadNetworkSegment

对象

NSX段

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.connectedGateway	string	要连接到段的网关。
properties.displayName	string	段的显示名称。
properties.portVif	WorkloadNetworkSegmentPortVif[]	Port Vif，关联哪个片段。
properties.provisioningState	WorkloadNetworkSegmentProvisioningState	预配状态
properties.revision	integer (int64)	NSX 修订号。
properties.status	SegmentStatusEnum	片段状态。
properties.subnet	WorkloadNetworkSegmentSubnet	要连接到段的子网。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WorkloadNetworkSegmentPortVif

对象

端口和任何连接到段子的VIF。

名称	类型	说明
portName	string	连接在段子上的港口名称或VIF名称。

WorkloadNetworkSegmentProvisioningState

枚举

工作负载网络段配置状态

值	说明
Succeeded	已创建资源。
Failed	资源创建失败。
Canceled	资源创建已取消。
Building	正在生成
Deleting	正在删除
Updating	正在更新

WorkloadNetworkSegmentsList

对象

工作负载网络段列表作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项目的链接
value	WorkloadNetworkSegment[]	本页的工作负载网络段项

WorkloadNetworkSegmentSubnet

对象

段子网配置

名称	类型	说明
dhcpRanges	string[]	为子网分配的 DHCP 范围。
gatewayAddress	string	网关地址。