How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Microsoft Azure

Microsoft Azure WorkloadNetworks API

The WorkloadNetworks API from Microsoft Azure — 16 operation(s) for workloadnetworks.

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure WorkloadNetworks API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WorkloadNetworks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 34 operations across 16 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

34 operations 16 paths 29 schemas 6 DELETE16 GET6 PATCH6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 34

Across 16 paths, the API surfaces 34 operations — 6 DELETE, 16 GET, 6 PATCH, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

WorkloadNetworks 34
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments
Microsoft Azure List Of Segments In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListsegments 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
Microsoft Azure Get A Segment By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetsegment 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
Microsoft Azure Create A Segment By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreatesegments 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
Microsoft Azure Create Or Update A Segment By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdatesegments 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
Microsoft Azure Delete A Segment By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeletesegment 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations
Microsoft Azure List Dhcp In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListdhcp 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
Microsoft Azure Get Dhcp By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetdhcp 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
Microsoft Azure Create Dhcp By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreatedhcp 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
Microsoft Azure Create Or Update Dhcp By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdatedhcp 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
Microsoft Azure Delete Dhcp By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeletedhcp 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways
Microsoft Azure List Of Gateways In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListgateways 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
Microsoft Azure Get A Gateway By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetgateway 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles
Microsoft Azure List Of Port Mirroring Profiles In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListportmirroring 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
Microsoft Azure Get A Port Mirroring Profile By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetportmirroring 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
Microsoft Azure Create A Port Mirroring Profile By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreateportmirroring 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
Microsoft Azure Create Or Update A Port Mirroring Profile By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdateportmirroring 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
Microsoft Azure Delete A Port Mirroring Profile By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeleteportmirroring 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups
Microsoft Azure List Of Vm Groups In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListvmgroups 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
Microsoft Azure Get A Vm Group By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetvmgroup 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
Microsoft Azure Create A Vm Group By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreatevmgroup 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
Microsoft Azure Create Or Update A Vm Group By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdatevmgroup 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
Microsoft Azure Delete A Vm Group By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeletevmgroup 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines
Microsoft Azure List Of Virtual Machines In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListvirtualmachines 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
Microsoft Azure Get A Virtual Machine By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetvirtualmachine 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices
Microsoft Azure List Of Dns Services In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListdnsservices 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
Microsoft Azure Get A Dns Service By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetdnsservice 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
Microsoft Azure Create A Dns Service By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreatednsservice 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
Microsoft Azure Create Or Update A Dns Service By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdatednsservice 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
Microsoft Azure Delete A Dns Service By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeletednsservice 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones
Microsoft Azure List Of Dns Zones In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksListdnszones 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
Microsoft Azure Get A Dns Zone By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksGetdnszone 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
Microsoft Azure Create A Dns Zone By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksCreatednszone 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
Microsoft Azure Create Or Update A Dns Zone By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksUpdatednszone 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
Microsoft Azure Delete A Dns Zone By Id In A Private Cloud Workload Network
microsoftAzureWorkloadnetworksDeletednszone 5 params → 200202204default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are WorkloadNetworkDnsServiceProperties (8 properties), WorkloadNetworkPortMirroringProperties (7 properties), WorkloadNetworkSegmentProperties (7 properties), WorkloadNetworkDnsZoneProperties (7 properties). Each schema is shown below with its type and property counts.

WorkloadNetworkVirtualMachine
object
NSX Virtual Machine
1 property
WorkloadNetworkDnsService
object
NSX DNS Service
1 property
WorkloadNetworkDnsZonesList
object
A list of NSX DNS Zones
2 properties
WorkloadNetworkDnsZoneProperties
object
NSX DNS Zone Properties
7 properties
WorkloadNetworkVirtualMachineProperties
object
NSX Virtual Machine Properties
2 properties
WorkloadNetworkSegmentsList
object
A list of NSX Segments
2 properties
WorkloadNetworkDhcpList
object
A list of NSX dhcp entities
2 properties
WorkloadNetworkSegmentPortVif
object
Ports and any VIF attached to segment.
1 property
WorkloadNetworkPortMirroringProperties
object
NSX Port Mirroring Properties
7 properties
WorkloadNetworkVirtualMachinesList
object
A list of NSX Virtual Machines
2 properties
WorkloadNetworkVMGroupProperties
object
NSX VM Group Properties
5 properties
WorkloadNetworkPortMirroring
object
NSX Port Mirroring
1 property
WorkloadNetworkGatewayProperties
object
Properties of a NSX Gateway.
2 properties
Resource
object
The core properties of ARM resources
3 properties
WorkloadNetworkDnsZone
object
NSX DNS Zone
1 property
ProxyResource
The resource model definition for a ARM proxy resource
WorkloadNetworkGateway
object
NSX Gateway.
1 property
WorkloadNetworkDhcp
object
NSX DHCP
1 property
WorkloadNetworkVMGroup
object
NSX VM Group
1 property
WorkloadNetworkSegmentSubnet
object
Subnet configuration for segment
2 properties
WorkloadNetworkVMGroupsList
object
A list of NSX VM Groups
2 properties
WorkloadNetworkPortMirroringList
object
A list of NSX Port Mirroring
2 properties
WorkloadNetworkSegment
object
NSX Segment
1 property
WorkloadNetworkDnsServicesList
object
A list of NSX DNS Services
2 properties
CloudError
object
API error response
1 property
WorkloadNetworkDnsServiceProperties
object
NSX DNS Service Properties
8 properties
WorkloadNetworkSegmentProperties
object
NSX Segment Properties
7 properties
WorkloadNetworkGatewayList
object
A list of NSX Gateways
2 properties
WorkloadNetworkDhcpEntity
object
Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to inherit from
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-workloadnetworks-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
AE Profile APIs.io
Microsoft Azure Communication Services API
AE Profile APIs.io
Microsoft Azure Event Grid API
AE Profile APIs.io
Microsoft Azure Functions API
AE Profile APIs.io
Microsoft Azure DevOps REST API
AE Profile APIs.io
Microsoft Azure AI Foundry API
AE Profile APIs.io
Microsoft Azure Resource JSON Schema
AE Profile APIs.io
Microsoft Azure JSON-LD Context
AE Profile APIs.io
Microsoft Azure AccessConnector API
AE Profile APIs.io
Microsoft Azure AccessControlRecords API
AE Profile APIs.io
Microsoft Azure AccessPolicies API
AE Profile APIs.io
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
AE Profile APIs.io
#WorkloadNetworks
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-workloadnetworks-api
Docs
https://learn.microsoft.com/en-us/rest/api/azure/
Provider
Microsoft Azure
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-workloadnetworks-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-workloadnetworks-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Microsoft Azure WorkloadNetworks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.