Trunked Networks - Get

Service:: Operator Nexus - Network Cloud

API Version:: 2025-02-01

Retrieve the trunked network.
Get properties of the provided trunked network.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
trunkedNetworkName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$	The name of the trunked network.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	TrunkedNetwork	The resource has been successfully retrieved.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Get Trunked network

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName?api-version=2025-02-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python trunked_networks_get.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 = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.trunked_networks.get(
        resource_group_name="resourceGroupName",
        trunked_network_name="trunkedNetworkName",
    )
    print(response)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/examples/TrunkedNetworks_Get.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

Sample response

Status code:: 200

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName",
  "name": "trunkedNetworkName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/trunkedNetworks",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "interfaceName": "eth0",
    "isolationDomainIds": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName",
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName"
    ],
    "vlans": [
      12,
      14
    ],
    "provisioningState": "Succeeded",
    "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName",
    "associatedResourceIds": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"
    ],
    "detailedStatus": "Available",
    "detailedStatusMessage": "Trunked network is up"
  }
}

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
ExtendedLocation	ExtendedLocation represents the Azure custom location where the resource will be created.
HybridAksPluginType	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
systemData	Metadata pertaining to creation and last modification of the resource.
TrunkedNetwork	TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network.
TrunkedNetworkDetailedStatus	The more detailed status of the trunked network.
TrunkedNetworkProvisioningState	The provisioning state of the trunked network.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

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.

ExtendedLocation

Object

ExtendedLocation represents the Azure custom location where the resource will be created.

Name	Type	Description
name	string	The resource ID of the extended location on which the resource will be created.
type	string	The extended location type, for example, CustomLocation.

HybridAksPluginType

Enumeration

Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.

Value	Description
DPDK
OSDevice
SRIOV

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.

TrunkedNetwork

Object

TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network.

Name	Type	Default value	Description
etag	string		Resource ETag.
extendedLocation	ExtendedLocation		ExtendedLocation represents the Azure custom location where the resource will be created. The extended location of the cluster associated with the resource.
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.associatedResourceIds	string[]		The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
properties.clusterId	string (arm-id)		The resource ID of the Network Cloud cluster this trunked network is associated with.
properties.detailedStatus	TrunkedNetworkDetailedStatus		The more detailed status of the trunked network.
properties.detailedStatusMessage	string		The descriptive message about the current detailed status.
properties.hybridAksClustersAssociatedIds	string[]		Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network.
properties.hybridAksPluginType	HybridAksPluginType	SRIOV	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
properties.interfaceName	string maxLength: 12 pattern: ^[a-zA-Z0-9@._-]*$		The default interface name for this trunked network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
properties.isolationDomainIds	string[]		The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources.
properties.provisioningState	TrunkedNetworkProvisioningState		The provisioning state of the trunked network.
properties.virtualMachinesAssociatedIds	string[]		Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network.
properties.vlans	integer[] (int64)		The list of vlans that are selected from the isolation domains for trunking.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

TrunkedNetworkDetailedStatus

Enumeration

The more detailed status of the trunked network.

Value	Description
Available
Error
Provisioning

TrunkedNetworkProvisioningState

Enumeration

The provisioning state of the trunked network.

Value	Description
Accepted
Canceled
Failed
Provisioning
Succeeded

Freigeben über

Trunked Networks - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Trunked network

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

HybridAksPluginType

systemData

TrunkedNetwork

TrunkedNetworkDetailedStatus

TrunkedNetworkProvisioningState