Microsoft.NetworkCloud (preview:2024-10-01)

2025/01/06 • 126 new methods

Operations_List (new)
Description :  Get a list of all available resource provider operations. It contains a URL link to get the next set of results.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetworkCloud/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_ListBySubscription (new)
Description :  Get a list of bare metal machines in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/bareMetalMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of bare metal machines. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_ListBySubscription (new)
Description :  Get a list of cloud services networks in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/cloudServicesNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of cloud services networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_ListBySubscription (new)
Description :  Get a list of cluster managers in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusterManagers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of cluster managers. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListBySubscription (new)
Description :  Get a list of clusters in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of clusters. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_ListBySubscription (new)
Description :  Get a list of Kubernetes clusters in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of additional details related to Kubernetes clusters. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_ListBySubscription (new)
Description :  Get a list of layer 2 (L2) networks in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l2Networks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of L2 networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_ListBySubscription (new)
Description :  Get a list of layer 3 (L3) networks in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/l3Networks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of L3 networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RackSkus_ListBySubscription (new)
Description :  Get a list of rack SKUs in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of Rack SKUs. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
computeMachines:
{
Description: The list of machine SKUs and associated rack slot for the compute-dedicated machines in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
bootstrapProtocol:
{
Description: The type of bootstrap protocol used. ,
Enum:
{
PXE: No description available. ,
}
,
Required: False ,
}
enum ,
cpuCores:
{
Description: The count of CPU cores for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: The count of CPU sockets for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: The list of disks. ,
Required: False ,
}
[
{
capacityGB:
{
Description: The maximum amount of storage. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
connection:
{
Description: The connection type of the rack SKU resource. ,
Enum:
{
PCIE: No description available. ,
SATA: No description available. ,
RAID: No description available. ,
SAS: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The disk type of rack SKU resource. ,
Enum:
{
HDD: No description available. ,
SSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
generation:
{
Description: The generation of the architecture. ,
Required: False ,
}
string ,
hardwareVersion:
{
Description: The hardware version of the machine. ,
Required: False ,
}
string ,
memoryCapacityGB:
{
Description: The maximum amount of memory. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the machine. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
address:
{
Description: The partial address of Peripheral Component Interconnect (PCI). ,
Required: False ,
}
string ,
deviceConnectionType:
{
Description: The connection type of the device. ,
Enum:
{
PCI: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The model name of the device. ,
Required: False ,
}
string ,
physicalSlot:
{
Description: The physical slot for this device. ,
Format: int64 ,
Required: False ,
}
integer ,
portCount:
{
Description: The number of ports on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
portSpeed:
{
Description: The maximum amount of data in gigabits that the line card transmits through a port at any given second. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The vendor name of the device. ,
Required: False ,
}
string ,
}
,
]
,
totalThreads:
{
Description: The count of SMT and physical core threads for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The make of the machine. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the machine. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
controllerMachines:
{
Description: The list of machine SKUs and associated rack slot for the control-plane dedicated machines in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
bootstrapProtocol:
{
Description: The type of bootstrap protocol used. ,
Enum:
{
PXE: No description available. ,
}
,
Required: False ,
}
enum ,
cpuCores:
{
Description: The count of CPU cores for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: The count of CPU sockets for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: The list of disks. ,
Required: False ,
}
[
{
capacityGB:
{
Description: The maximum amount of storage. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
connection:
{
Description: The connection type of the rack SKU resource. ,
Enum:
{
PCIE: No description available. ,
SATA: No description available. ,
RAID: No description available. ,
SAS: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The disk type of rack SKU resource. ,
Enum:
{
HDD: No description available. ,
SSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
generation:
{
Description: The generation of the architecture. ,
Required: False ,
}
string ,
hardwareVersion:
{
Description: The hardware version of the machine. ,
Required: False ,
}
string ,
memoryCapacityGB:
{
Description: The maximum amount of memory. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the machine. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
address:
{
Description: The partial address of Peripheral Component Interconnect (PCI). ,
Required: False ,
}
string ,
deviceConnectionType:
{
Description: The connection type of the device. ,
Enum:
{
PCI: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The model name of the device. ,
Required: False ,
}
string ,
physicalSlot:
{
Description: The physical slot for this device. ,
Format: int64 ,
Required: False ,
}
integer ,
portCount:
{
Description: The number of ports on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
portSpeed:
{
Description: The maximum amount of data in gigabits that the line card transmits through a port at any given second. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The vendor name of the device. ,
Required: False ,
}
string ,
}
,
]
,
totalThreads:
{
Description: The count of SMT and physical core threads for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The make of the machine. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the machine. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
description:
{
Description: The free-form text describing the rack. ,
Required: False ,
}
string ,
maxClusterSlots:
{
Description: The maximum number of compute racks supported by an aggregator rack. 0 if this is a compute rack or a rack for a single rack cluster(rackType="Single"). ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the rack SKU resource. ,
Enum:
{
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
rackType:
{
Description: The type of the rack. ,
Enum:
{
Aggregator: No description available. ,
Compute: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
storageAppliances:
{
Description: The list of appliance SKUs and associated rack slot for the storage appliance(s) in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
capacityGB:
{
Description: The maximum capacity of the storage appliance. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the storage appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedRackSkuIds:
{
Description: The list of supported SKUs if the rack is an aggregator. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RackSkus_Get (new)
Description :  Get the properties of the provided rack SKU.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/rackSkus/{rackSkuName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
rackSkuName:
{
Description: The name of the rack SKU. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
computeMachines:
{
Description: The list of machine SKUs and associated rack slot for the compute-dedicated machines in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
bootstrapProtocol:
{
Description: The type of bootstrap protocol used. ,
Enum:
{
PXE: No description available. ,
}
,
Required: False ,
}
enum ,
cpuCores:
{
Description: The count of CPU cores for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: The count of CPU sockets for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: The list of disks. ,
Required: False ,
}
[
{
capacityGB:
{
Description: The maximum amount of storage. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
connection:
{
Description: The connection type of the rack SKU resource. ,
Enum:
{
PCIE: No description available. ,
SATA: No description available. ,
RAID: No description available. ,
SAS: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The disk type of rack SKU resource. ,
Enum:
{
HDD: No description available. ,
SSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
generation:
{
Description: The generation of the architecture. ,
Required: False ,
}
string ,
hardwareVersion:
{
Description: The hardware version of the machine. ,
Required: False ,
}
string ,
memoryCapacityGB:
{
Description: The maximum amount of memory. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the machine. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
address:
{
Description: The partial address of Peripheral Component Interconnect (PCI). ,
Required: False ,
}
string ,
deviceConnectionType:
{
Description: The connection type of the device. ,
Enum:
{
PCI: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The model name of the device. ,
Required: False ,
}
string ,
physicalSlot:
{
Description: The physical slot for this device. ,
Format: int64 ,
Required: False ,
}
integer ,
portCount:
{
Description: The number of ports on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
portSpeed:
{
Description: The maximum amount of data in gigabits that the line card transmits through a port at any given second. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The vendor name of the device. ,
Required: False ,
}
string ,
}
,
]
,
totalThreads:
{
Description: The count of SMT and physical core threads for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The make of the machine. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the machine. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
controllerMachines:
{
Description: The list of machine SKUs and associated rack slot for the control-plane dedicated machines in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
bootstrapProtocol:
{
Description: The type of bootstrap protocol used. ,
Enum:
{
PXE: No description available. ,
}
,
Required: False ,
}
enum ,
cpuCores:
{
Description: The count of CPU cores for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: The count of CPU sockets for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
disks:
{
Description: The list of disks. ,
Required: False ,
}
[
{
capacityGB:
{
Description: The maximum amount of storage. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
connection:
{
Description: The connection type of the rack SKU resource. ,
Enum:
{
PCIE: No description available. ,
SATA: No description available. ,
RAID: No description available. ,
SAS: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The disk type of rack SKU resource. ,
Enum:
{
HDD: No description available. ,
SSD: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
generation:
{
Description: The generation of the architecture. ,
Required: False ,
}
string ,
hardwareVersion:
{
Description: The hardware version of the machine. ,
Required: False ,
}
string ,
memoryCapacityGB:
{
Description: The maximum amount of memory. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the machine. ,
Required: False ,
}
string ,
networkInterfaces:
{
Description: The list of network interfaces. ,
Required: False ,
}
[
{
address:
{
Description: The partial address of Peripheral Component Interconnect (PCI). ,
Required: False ,
}
string ,
deviceConnectionType:
{
Description: The connection type of the device. ,
Enum:
{
PCI: No description available. ,
}
,
Required: False ,
}
enum ,
model:
{
Description: The model name of the device. ,
Required: False ,
}
string ,
physicalSlot:
{
Description: The physical slot for this device. ,
Format: int64 ,
Required: False ,
}
integer ,
portCount:
{
Description: The number of ports on the device. ,
Format: int64 ,
Required: False ,
}
integer ,
portSpeed:
{
Description: The maximum amount of data in gigabits that the line card transmits through a port at any given second. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The vendor name of the device. ,
Required: False ,
}
string ,
}
,
]
,
totalThreads:
{
Description: The count of SMT and physical core threads for this machine. ,
Format: int64 ,
Required: False ,
}
integer ,
vendor:
{
Description: The make of the machine. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the machine. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
description:
{
Description: The free-form text describing the rack. ,
Required: False ,
}
string ,
maxClusterSlots:
{
Description: The maximum number of compute racks supported by an aggregator rack. 0 if this is a compute rack or a rack for a single rack cluster(rackType="Single"). ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state of the rack SKU resource. ,
Enum:
{
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
rackType:
{
Description: The type of the rack. ,
Enum:
{
Aggregator: No description available. ,
Compute: No description available. ,
Single: No description available. ,
}
,
Required: False ,
}
enum ,
storageAppliances:
{
Description: The list of appliance SKUs and associated rack slot for the storage appliance(s) in this rack model. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
capacityGB:
{
Description: The maximum capacity of the storage appliance. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
}
,
rackSlot:
{
Description: The position in the rack for the storage appliance. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
supportedRackSkuIds:
{
Description: The list of supported SKUs if the rack is an aggregator. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_ListBySubscription (new)
Description :  Get a list of racks in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/racks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of racks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_ListBySubscription (new)
Description :  Get a list of storage appliances in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/storageAppliances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of storage appliances. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_ListBySubscription (new)
Description :  Get a list of trunked networks in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/trunkedNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of trunked networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListBySubscription (new)
Description :  Get a list of virtual machines in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of virtual machines. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_ListBySubscription (new)
Description :  Get a list of volumes in the provided subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/volumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of volumes. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_ListByResourceGroup (new)
Description :  Get a list of bare metal machines in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of bare metal machines. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Get (new)
Description :  Get properties of the provided bare metal machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_CreateOrUpdate (new)
Description :  Create a new bare metal machine or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Delete (new)
Description :  Delete the provided bare metal machine. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Update (new)
Description :  Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
machineDetails:
{
Description: The details provided by the customer during the creation of rack manifests that allows for custom data to be associated with this machine. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: True ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster this bare metal machine is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
cordonStatus:
{
Description: The cordon status of the bare metal machine. ,
Enum:
{
Cordoned: No description available. ,
Uncordoned: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The more detailed status of the bare metal machine. ,
Enum:
{
Preparing: No description available. ,
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
Deprovisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hardwareInventory:
{
Description: The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. ,
Required: False ,
}
{
additionalHostInformation:
{
Description: Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. ,
Required: False ,
}
string ,
interfaces:
{
Description: The list of network interfaces and associated details for the bare metal machine. ,
Required: False ,
}
[
{
linkStatus:
{
Description: The current status of the link. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address associated with this interface. ,
Required: False ,
}
string ,
name:
{
Description: The name of the interface. ,
Required: False ,
}
string ,
networkInterfaceId:
{
Description: The resource ID of the network interface for the port on the switch that this machine's interface is connected to. ,
Required: False ,
}
string ,
}
,
]
,
nics:
{
Description: Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. ,
Required: False ,
}
[
{
lldpNeighbor:
{
Description: The information about the device connected to this NIC. ,
Required: False ,
}
{
portDescription:
{
Description: The descriptive information about the port on the connected device. ,
Required: False ,
}
string ,
portName:
{
Description: The system-assigned name of the port on the connected device. ,
Required: False ,
}
string ,
systemDescription:
{
Description: The descriptive information about the connected device. ,
Required: False ,
}
string ,
systemName:
{
Description: The system-assigned name of the connected device. ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: The MAC address associated with this NIC. ,
Required: False ,
}
string ,
name:
{
Description: The name of the NIC/interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
Description: The details of the latest hardware validation performed for this bare metal machine. ,
Required: False ,
}
{
lastValidationTime:
{
Description: The timestamp of the hardware validation execution. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The outcome of the hardware validation. ,
Enum:
{
Pass: No description available. ,
Fail: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
kubernetesNodeName:
{
Description: The name of this machine represented by the host object in the Cluster's Kubernetes control plane. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The version of Kubernetes running on this machine. ,
Required: False ,
}
string ,
machineClusterVersion:
{
Description: The cluster version that has been applied to this machine during deployment or a version update. ,
Required: False ,
}
string ,
machineDetails:
{
Description: The custom details provided by the customer. ,
Required: True ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: True ,
}
string ,
machineRoles:
{
Description: The list of roles that are assigned to the cluster node running on this machine. ,
Required: False ,
}
[
string ,
]
,
machineSkuId:
{
Description: The unique internal identifier of the bare metal machine SKU. ,
Required: True ,
}
string ,
oamIpv4Address:
{
Description: The IPv4 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
oamIpv6Address:
{
Description: The IPv6 address that is assigned to the bare metal machine during the cluster deployment. ,
Required: False ,
}
string ,
osImage:
{
Description: The image that is currently provisioned to the OS disk. ,
Required: False ,
}
string ,
powerState:
{
Description: The power state derived from the baseboard management controller. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this bare metal machine resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. ,
Format: int64 ,
Required: True ,
}
integer ,
readyState:
{
Description: The indicator of whether the bare metal machine is ready to receive workloads. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionStatus:
{
Description: The runtime protection status of the bare metal machine. ,
Required: False ,
}
{
definitionsLastUpdated:
{
Description: The timestamp when the malware definitions were last updated. ,
Format: date-time ,
Required: False ,
}
string ,
definitionsVersion:
{
Description: The version of the malware definitions. ,
Required: False ,
}
string ,
scanCompletedTime:
{
Description: The timestamp of the most recently completed scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
scanScheduledTime:
{
Description: The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
scanStartedTime:
{
Description: The timestamp of the most recently started scan, or empty if there has never been a scan. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: True ,
}
string ,
serviceTag:
{
Description: The discovered value of the machine's service tag. ,
Required: False ,
}
string ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Cordon (new)
Description :  Cordon the provided bare metal machine's Kubernetes node.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineCordonParameters:
{
Description: The request body. ,
Required: False ,
}
{
evacuate:
{
Description: The indicator of whether to evacuate the node workload when the bare metal machine is cordoned. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_PowerOff (new)
Description :  Power off the provided bare metal machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/powerOff
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachinePowerOffParameters:
{
Description: The request body. ,
Required: False ,
}
{
skipShutdown:
{
Description: The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Reimage (new)
Description :  Reimage the provided bare metal machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/reimage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Replace (new)
Description :  Replace the provided bare metal machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineReplaceParameters:
{
Description: The request body. ,
Required: False ,
}
{
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: False ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC device. ,
Required: False ,
}
string ,
bootMacAddress:
{
Description: The MAC address of a NIC connected to the PXE network. ,
Required: False ,
}
string ,
machineName:
{
Description: The OS-level hostname assigned to this machine. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number of the bare metal machine. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Restart (new)
Description :  Restart the provided bare metal machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_RunCommand (new)
Description :  Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineRunCommandParameters:
{
Description: The request body. ,
Required: True ,
}
{
arguments:
{
Description: The list of string arguments that will be passed to the script in order as separate arguments. ,
Required: False ,
}
[
string ,
]
,
limitTimeSeconds:
{
Description: The maximum time the script is allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252). ,
Format: int64 ,
Required: True ,
}
integer ,
script:
{
Description: The base64 encoded script to execute on the bare metal machine. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_RunDataExtracts (new)
Description :  Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runDataExtracts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineRunDataExtractsParameters:
{
Description: The request body. ,
Required: True ,
}
{
commands:
{
Description: The list of curated data extraction commands to be executed directly against the target machine. ,
Required: True ,
}
[
{
arguments:
{
Description: The list of string arguments that will be passed to the script in order as separate arguments. ,
Required: False ,
}
[
string ,
]
,
command:
{
Description: The command to execute against the bare metal machine. ,
Required: True ,
}
string ,
}
,
]
,
limitTimeSeconds:
{
Description: The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_RunReadCommands (new)
Description :  Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/runReadCommands
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
bareMetalMachineRunReadCommandsParameters:
{
Description: The request body. ,
Required: True ,
}
{
commands:
{
Description: The list of read-only commands to be executed directly against the target machine. ,
Required: True ,
}
[
{
arguments:
{
Description: The list of string arguments that will be passed to the script in order as separate arguments. ,
Required: False ,
}
[
string ,
]
,
command:
{
Description: The command to execute against the bare metal machine. ,
Required: True ,
}
string ,
}
,
]
,
limitTimeSeconds:
{
Description: The maximum time the commands are allowed to run. If the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Start (new)
Description :  Start the provided bare metal machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachines_Uncordon (new)
Description :  Uncordon the provided bare metal machine's Kubernetes node.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/uncordon
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
bareMetalMachineName:
{
Description: The name of the bare metal machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_ListByResourceGroup (new)
Description :  Get a list of cloud services networks in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of cloud services networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_Get (new)
Description :  Get properties of the provided cloud services network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudServicesNetworkName:
{
Description: The name of the cloud services network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_CreateOrUpdate (new)
Description :  Create a new cloud services network or update the properties of the existing cloud services network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudServicesNetworkName:
{
Description: The name of the cloud services network. ,
Required: True ,
}
string ,
cloudServicesNetworkParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
Description: Upon creation, the additional services that are provided by the platform will be allocated and represented in the status of this resource. All resources associated with this cloud services network will be part of the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many virtual machines and/or Hybrid AKS clusters. ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_Delete (new)
Description :  Delete the provided cloud services network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudServicesNetworkName:
{
Description: The name of the cloud services network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudServicesNetworks_Update (new)
Description :  Update properties of the provided cloud services network, or update the tags associated with it. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/cloudServicesNetworks/{cloudServicesNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudServicesNetworkName:
{
Description: The name of the cloud services network. ,
Required: True ,
}
string ,
cloudServicesNetworkUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
Description: Upon creation, the additional services that are provided by the platform will be allocated and represented in the status of this resource. All resources associated with this cloud services network will be part of the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many virtual machines and/or Hybrid AKS clusters. ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
additionalEgressEndpoints:
{
Description: The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this cloud services network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the cloud services network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enableDefaultEgressEndpoints:
{
Description: The indicator of whether the platform default endpoints are allowed for the egress traffic. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
enabledEgressEndpoints:
{
Description: The full list of additional and default egress endpoints that are currently enabled. ,
Required: False ,
}
[
{
category:
{
Description: The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. ,
Required: True ,
}
string ,
endpoints:
{
Description: The list of endpoint dependencies. ,
Required: True ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: True ,
}
string ,
port:
{
Description: The port of this endpoint. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network. ,
Required: False ,
}
[
string ,
]
,
interfaceName:
{
Description: The name of the interface that will be present in the virtual machine to represent this network. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cloud services network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 cloud services network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_ListByResourceGroup (new)
Description :  Get a list of cluster managers in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of cluster managers. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_Get (new)
Description :  Get the properties of the provided cluster manager.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterManagerName:
{
Description: The name of the cluster manager. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_CreateOrUpdate (new)
Description :  Create a new cluster manager or update properties of the cluster manager if it exists.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterManagerName:
{
Description: The name of the cluster manager. ,
Required: True ,
}
string ,
clusterManagerParameters:
{
Description: The request body. ,
Required: True ,
}
{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_Delete (new)
Description :  Delete the provided cluster manager.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterManagerName:
{
Description: The name of the cluster manager. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ClusterManagers_Update (new)
Description :  Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusterManagers/{clusterManagerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterManagerName:
{
Description: The name of the cluster manager. ,
Required: True ,
}
string ,
clusterManagerUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the cluster manager. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the Log Analytics workspace that is used for the logs collection. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZones:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The Azure availability zones within the region that will be used to support the cluster manager resource. ,
Required: False ,
}
[
string ,
]
,
clusterVersions:
{
Description: The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource. ,
Required: False ,
}
[
{
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The version of the cluster to be deployed. ,
Required: False ,
}
string ,
}
,
]
,
detailedStatus:
{
Description: The detailed status that provides additional information about the cluster manager. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
ProvisioningFailed: No description available. ,
Updating: No description available. ,
UpdateFailed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
fabricControllerId:
{
Description: The resource ID of the fabric controller that has one to one mapping with the cluster manager. ,
Format: arm-id ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
managerExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the cluster manager. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
vmSize:
{
Description: Field deprecated, this value will no longer influence the cluster manager allocation process and will be removed in a future version. The size of the Azure virtual machines to use for hosting the cluster manager resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  Get a list of clusters in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of clusters. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Get properties of the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create a new cluster or update the properties of the cluster if it exists.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
clusterParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Delete the provided cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
clusterUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: False ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aggregatorOrSingleRackDefinition:
{
Description: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster. ,
Required: True ,
}
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
Description: The settings for the log analytics workspace used for output of logs from this cluster. ,
Required: False ,
}
{
analyticsWorkspaceId:
{
Description: The resource ID of the analytics workspace that is to be used by the specified identity. ,
Format: arm-id ,
Required: False ,
}
string ,
associatedIdentity:
{
Description: The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
analyticsWorkspaceId:
{
Description: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs. ,
Format: arm-id ,
Required: False ,
}
string ,
availableUpgradeVersions:
{
Description: The list of cluster runtime version upgrades available for this cluster. ,
Required: False ,
}
[
{
controlImpact:
{
Description: The indicator of whether the control plane will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expectedDuration:
{
Description: The expected duration needed for this upgrade. ,
Required: False ,
}
string ,
impactDescription:
{
Description: The impact description including the specific details and release notes. ,
Required: False ,
}
string ,
supportExpiryDate:
{
Description: The last date the version of the platform is supported. ,
Required: False ,
}
string ,
targetClusterVersion:
{
Description: The target version this cluster will be upgraded to. ,
Required: False ,
}
string ,
workloadImpact:
{
Description: The indicator of whether the workload will be impacted during the upgrade. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
clusterCapacity:
{
Description: The capacity supported by this cluster. ,
Required: False ,
}
{
availableApplianceStorageGB:
{
Description: The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The remaining number of cores that are available in this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
availableHostStorageGB:
{
Description: The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
availableMemoryGB:
{
Description: The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalApplianceStorageGB:
{
Description: The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalCoreCount:
{
Description: The total number of cores that are supported by this cluster for workload use. ,
Format: int64 ,
Required: False ,
}
integer ,
totalHostStorageGB:
{
Description: The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
totalMemoryGB:
{
Description: The total memory supported by this cluster for workload use. Measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
clusterConnectionStatus:
{
Description: The latest heartbeat status between the cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
Undefined: No description available. ,
}
,
Required: False ,
}
enum ,
clusterExtendedLocation:
{
Description: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
clusterLocation:
{
Description: The customer-provided location information to identify where the cluster resides. ,
Required: False ,
}
string ,
clusterManagerConnectionStatus:
{
Description: The latest connectivity status between cluster manager and the cluster. ,
Enum:
{
Connected: No description available. ,
Unreachable: No description available. ,
}
,
Required: False ,
}
enum ,
clusterManagerId:
{
Description: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterServicePrincipal:
{
Description: The service principal to be used by the cluster during Arc Appliance installation. ,
Required: False ,
}
{
applicationId:
{
Description: The application ID, also known as client ID, of the service principal. ,
Required: True ,
}
string ,
password:
{
Description: The password of the service principal. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID, also known as the object ID, of the service principal. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. ,
Required: True ,
}
string ,
}
,
clusterType:
{
Description: The type of rack configuration for the cluster. ,
Enum:
{
SingleRack: No description available. ,
MultiRack: No description available. ,
}
,
Required: True ,
}
enum ,
clusterVersion:
{
Description: The current runtime version of the cluster. ,
Required: True ,
}
string ,
commandOutputSettings:
{
Description: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
containerUrl:
{
Description: The URL of the storage account container that is to be used by the specified identities. ,
Format: uri ,
Required: False ,
}
string ,
}
,
computeDeploymentThreshold:
{
Description: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment. ,
Required: False ,
}
{
grouping:
{
Description: Selection of how the type evaluation is applied to the cluster calculation. ,
Enum:
{
PerCluster: No description available. ,
PerRack: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
computeRackDefinitions:
{
Description: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster. ,
Required: False ,
}
[
{
availabilityZone:
{
Description: The zone name used for this rack when created. Availability zones are used for workload placement. ,
Required: False ,
}
string ,
bareMetalMachineConfigurationData:
{
Description: The unordered list of bare metal machine configuration. ,
Required: False ,
}
[
{
bmcConnectionString:
{
Description: The connection string for the baseboard management controller including IP address and protocol. ,
Required: False ,
}
string ,
bmcCredentials:
{
Description: The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
bmcMacAddress:
{
Description: The MAC address of the BMC for this machine. ,
Required: True ,
}
string ,
bootMacAddress:
{
Description: The MAC address associated with the PXE NIC card. ,
Required: True ,
}
string ,
machineDetails:
{
Description: The free-form additional information about the machine, e.g. an asset tag. ,
Required: False ,
}
string ,
machineName:
{
Description: The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically. ,
Required: False ,
}
string ,
rackSlot:
{
Description: The slot the physical machine is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. ,
Required: True ,
}
string ,
}
,
]
,
networkRackId:
{
Description: The resource ID of the network rack that matches this rack definition. ,
Format: arm-id ,
Required: True ,
}
string ,
rackLocation:
{
Description: The free-form description of the rack's location. ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The resource ID of the sku for the rack being added. ,
Format: arm-id ,
Required: True ,
}
string ,
storageApplianceConfigurationData:
{
Description: The list of storage appliance configuration data for this rack. ,
Required: False ,
}
[
{
adminCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
rackSlot:
{
Description: The slot that storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
serialNumber:
{
Description: The serial number of the appliance. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The user-provided name for the storage appliance that will be created from this specification. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
detailedStatus:
{
Description: The current detailed status of the cluster. ,
Enum:
{
PendingDeployment: No description available. ,
Deploying: No description available. ,
Running: No description available. ,
Updating: No description available. ,
UpdatePaused: No description available. ,
Degraded: No description available. ,
Deleting: No description available. ,
Disconnected: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the detailed status. ,
Required: False ,
}
string ,
hybridAksExtendedLocation:
{
Description: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters). ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
manualActionCount:
{
Description: The count of Manual Action Taken (MAT) events that have not been validated. ,
Format: int64 ,
Required: False ,
}
integer ,
networkFabricId:
{
Description: The resource ID of the Network Fabric associated with the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the cluster. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Validating: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
runtimeProtectionConfiguration:
{
Description: The settings for cluster runtime protection. ,
Required: False ,
}
{
enforcementLevel:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Audit: No description available. ,
Disabled: No description available. ,
OnDemand: No description available. ,
Passive: No description available. ,
RealTime: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchive:
{
Description: The configuration for use of a key vault to store secrets for later retrieval by the operator. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault to archive the secrets of the cluster. ,
Format: arm-id ,
Required: True ,
}
string ,
useKeyVault:
{
Description: The indicator if the specified key vault should be used to archive the secrets of the cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
secretArchiveSettings:
{
Description: The settings for the secret archive used to hold credentials for the cluster. ,
Required: False ,
}
{
associatedIdentity:
{
Description: The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. ,
Required: False ,
}
{
identityType:
{
Description: The type of managed identity that is being selected. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
vaultUri:
{
Description: The URI for the key vault used as the secret archive. ,
Format: uri ,
Required: False ,
}
string ,
}
,
supportExpiryDate:
{
Description: The support end date of the runtime version of the cluster. ,
Required: False ,
}
string ,
updateStrategy:
{
Description: The strategy for updating the cluster. ,
Required: False ,
}
{
maxUnavailable:
{
Description: The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. Limited by the maximum number of machines in the increment. Defaults to the whole increment size. ,
Format: int64 ,
Required: False ,
}
integer ,
strategyType:
{
Description: The mode of operation for runtime protection. ,
Enum:
{
Rack: No description available. ,
PauseAfterRack: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdType:
{
Description: Selection of how the threshold should be evaluated. ,
Enum:
{
CountSuccess: No description available. ,
PercentSuccess: No description available. ,
}
,
Required: True ,
}
enum ,
thresholdValue:
{
Description: The numeric threshold value. ,
Format: int64 ,
Required: True ,
}
integer ,
waitTimeMinutes:
{
Description: The time to wait between the increments of update defined by the strategy. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vulnerabilityScanningSettings:
{
Description: The settings for how security vulnerability scanning is applied to the cluster. ,
Required: False ,
}
{
containerScan:
{
Description: The mode selection for container vulnerability scanning. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
workloadResourceIds:
{
Description: The list of workload resource IDs that are hosted within this cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachineKeySets_ListByCluster (new)
Description :  Get a list of bare metal machine key sets for the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of bare metal machine key sets. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachineKeySets_Get (new)
Description :  Get bare metal machine key set of the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bareMetalMachineKeySetName:
{
Description: The name of the bare metal machine key set. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachineKeySets_CreateOrUpdate (new)
Description :  Create a new bare metal machine key set or update the existing one for the provided cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bareMetalMachineKeySetName:
{
Description: The name of the bare metal machine key set. ,
Required: True ,
}
string ,
bareMetalMachineKeySetParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachineKeySets_Delete (new)
Description :  Delete the bare metal machine key set of the provided cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bareMetalMachineKeySetName:
{
Description: The name of the bare metal machine key set. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BareMetalMachineKeySets_Update (new)
Description :  Patch properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bareMetalMachineKeySetName:
{
Description: The name of the bare metal machine key set. ,
Required: True ,
}
string ,
bareMetalMachineKeySetUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: False ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: False ,
}
[
string ,
]
,
userList:
{
Description: The unique list of permitted users. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the bare metal machines. ,
Format: date-time ,
Required: True ,
}
string ,
jumpHostsAllowed:
{
Description: The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. ,
Required: True ,
}
[
string ,
]
,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
osGroupName:
{
Description: The name of the group that users will be assigned to on the operating system of the machines. ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
Standard: No description available. ,
Superuser: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the bare metal machine key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BmcKeySets_ListByCluster (new)
Description :  Get a list of baseboard management controller key sets for the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of baseboard management controller key sets. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BmcKeySets_Get (new)
Description :  Get baseboard management controller key set of the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bmcKeySetName:
{
Description: The name of the baseboard management controller key set. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BmcKeySets_CreateOrUpdate (new)
Description :  Create a new baseboard management controller key set or update the existing one for the provided cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bmcKeySetName:
{
Description: The name of the baseboard management controller key set. ,
Required: True ,
}
string ,
bmcKeySetParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BmcKeySets_Delete (new)
Description :  Delete the baseboard management controller key set of the provided cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bmcKeySetName:
{
Description: The name of the baseboard management controller key set. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BmcKeySets_Update (new)
Description :  Patch properties of baseboard management controller key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
bmcKeySetName:
{
Description: The name of the baseboard management controller key set. ,
Required: True ,
}
string ,
bmcKeySetUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: False ,
}
string ,
userList:
{
Description: The unique list of permitted users. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
azureGroupId:
{
Description: The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. ,
Required: True ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the key set. ,
Enum:
{
AllActive: No description available. ,
SomeInvalid: No description available. ,
AllInvalid: No description available. ,
Validating: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
expiration:
{
Description: The date and time after which the users in this key set will be removed from the baseboard management controllers. ,
Format: date-time ,
Required: True ,
}
string ,
lastValidation:
{
Description: The last time this key set was validated. ,
Format: date-time ,
Required: False ,
}
string ,
privilegeLevel:
{
Description: The access level allowed for the users in this key set. ,
Enum:
{
ReadOnly: No description available. ,
Administrator: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the baseboard management controller key set. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
userList:
{
Description: The unique list of permitted users. ,
Required: True ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: True ,
}
string ,
description:
{
Description: The free-form description for this user. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
userPrincipalName:
{
Description: The user principal name (email format) used to validate this user's group membership. ,
Required: False ,
}
string ,
}
,
]
,
userListStatus:
{
Description: The status evaluation of each user. ,
Required: False ,
}
[
{
azureUserName:
{
Description: The user name that will be used for access. ,
Required: False ,
}
string ,
status:
{
Description: The indicator of whether the user is currently deployed for access. ,
Enum:
{
Active: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
statusMessage:
{
Description: The additional information describing the current status of this user, if any available. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ContinueUpdateVersion (new)
Description :  Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/continueUpdateVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
clusterContinueUpdateVersionParameters:
{
Description: The request body. ,
Required: True ,
}
{
machineGroupTargetingMode:
{
Description: The mode by which the cluster will target the next grouping of servers to continue the update. ,
Enum:
{
AlphaByRack: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Deploy (new)
Description :  Deploy the cluster using the rack configuration provided during creation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
clusterDeployParameters:
{
Description: The request body. ,
Required: False ,
}
{
skipValidationsForMachines:
{
Description: The names of bare metal machines in the cluster that should be skipped during environment validation. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricsConfigurations_ListByCluster (new)
Description :  Get a list of metrics configurations for the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of metrics configurations. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricsConfigurations_Get (new)
Description :  Get metrics configuration of the provided cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
metricsConfigurationName:
{
Description: The name of the metrics configuration for the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricsConfigurations_CreateOrUpdate (new)
Description :  Create new or update the existing metrics configuration of the provided cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
metricsConfigurationName:
{
Description: The name of the metrics configuration for the cluster. ,
Required: True ,
}
string ,
metricsConfigurationParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricsConfigurations_Delete (new)
Description :  Delete the metrics configuration of the provided cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
metricsConfigurationName:
{
Description: The name of the metrics configuration for the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricsConfigurations_Update (new)
Description :  Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
metricsConfigurationName:
{
Description: The name of the metrics configuration for the cluster. ,
Required: True ,
}
string ,
metricsConfigurationUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: False ,
}
integer ,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
collectionInterval:
{
Description: The interval in minutes by which metrics will be collected. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the metrics configuration. ,
Enum:
{
Processing: No description available. ,
Applied: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
disabledMetrics:
{
Description: The list of metrics that are available for the cluster but disabled at the moment. ,
Required: False ,
}
[
string ,
]
,
enabledMetrics:
{
Description: The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the metrics configuration. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ScanRuntime (new)
Description :  Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
ClusterScanRuntimeParameters:
{
Description: The request body. ,
Required: False ,
}
{
scanActivity:
{
Description: The choice of if the scan operation should run the scan. ,
Enum:
{
Scan: No description available. ,
Skip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_UpdateVersion (new)
Description :  Update the version of the provided cluster to one of the available supported versions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
clusterUpdateVersionParameters:
{
Description: The request body. ,
Required: True ,
}
{
targetClusterVersion:
{
Description: The version to be applied to the cluster during update. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_ListByResourceGroup (new)
Description :  Get a list of Kubernetes clusters in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of additional details related to Kubernetes clusters. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_Get (new)
Description :  Get properties of the provided the Kubernetes cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_CreateOrUpdate (new)
Description :  Create a new Kubernetes cluster or update the properties of the existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
kubernetesClusterParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_Delete (new)
Description :  Delete the provided Kubernetes cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_Update (new)
Description :  Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
kubernetesClusterUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
administratorConfiguration:
{
Description: The configuration of the default administrator credentials. ,
Required: False ,
}
{
sshPublicKeys:
{
Description: SshPublicKey represents the public key used to authenticate with a resource through SSH. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane that can be patched for this Kubernetes cluster. ,
Required: False ,
}
{
administratorConfiguration:
{
Description: The configuration of administrator credentials for the control plane nodes. ,
Required: False ,
}
{
sshPublicKeys:
{
Description: SshPublicKey represents the public key used to authenticate with a resource through SSH. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
aadConfiguration:
{
Description: The Azure Active Directory Integration properties. ,
Required: False ,
}
{
adminGroupObjectIds:
{
Description: The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. ,
Required: True ,
}
[
string ,
]
,
}
,
administratorConfiguration:
{
Description: The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
attachedNetworkIds:
{
Description: The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools. ,
Required: False ,
}
[
string ,
]
,
availableUpgrades:
{
Description: The list of versions that this Kubernetes cluster can be upgraded to. ,
Required: False ,
}
[
{
availabilityLifecycle:
{
Description: The version lifecycle indicator. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version available for upgrading. ,
Required: False ,
}
string ,
}
,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
connectedClusterId:
{
Description: The resource ID of the connected cluster set up when this Kubernetes cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
controlPlaneKubernetesVersion:
{
Description: The current running version of Kubernetes on the control plane. ,
Required: False ,
}
string ,
controlPlaneNodeConfiguration:
{
Description: The defining characteristics of the control plane for this Kubernetes Cluster. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in the control plane. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
vmSkuName:
{
Description: The name of the VM SKU supplied during creation. ,
Required: True ,
}
string ,
}
,
detailedStatus:
{
Description: The current status of the Kubernetes cluster. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
featureStatuses:
{
Description: The current feature settings. ,
Required: False ,
}
[
{
detailedStatus:
{
Description: The status representing the state of this feature. ,
Enum:
{
Running: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
name:
{
Description: The name of the feature. ,
Required: False ,
}
string ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
]
,
initialAgentPoolConfigurations:
{
Description: The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource. ,
Required: True ,
}
[
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name that will be used for the agent pool resource representing this agent pool. ,
Required: True ,
}
string ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
]
,
kubernetesVersion:
{
Description: The Kubernetes version for this cluster. ,
Required: True ,
}
string ,
managedResourceGroupConfiguration:
{
Description: The configuration of the managed resource group associated with the resource. ,
Required: False ,
}
{
location:
{
Description: The location of the managed resource group. If not specified, the location of the parent resource is chosen. ,
Required: False ,
}
string ,
name:
{
Description: The name for the managed resource group. If not specified, the unique name is automatically generated. ,
Required: False ,
}
string ,
}
,
networkConfiguration:
{
Description: The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster. ,
Required: True ,
}
{
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
Description: The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
bgpAdvertisements:
{
Description: The association of IP address pools to the communities and peers, allowing for announcement of IPs. ,
Required: False ,
}
[
{
advertiseToFabric:
{
Description: The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
communities:
{
Description: The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. ,
Required: False ,
}
[
string ,
]
,
ipAddressPools:
{
Description: The names of the IP address pools associated with this announcement. ,
Required: True ,
}
[
string ,
]
,
peers:
{
Description: The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
bgpPeers:
{
Description: The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. ,
Required: False ,
}
[
{
bfdEnabled:
{
Description: The indicator of BFD enablement for this BgpPeer. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
bgpMultiHop:
{
Description: The indicator to enable multi-hop peering support. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
holdTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
keepAliveTime:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. ,
Required: False ,
}
string ,
myAsn:
{
Description: The autonomous system number used for the local end of the BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name used to identify this BGP peer for association with a BGP advertisement. ,
Required: True ,
}
string ,
password:
{
Description: The authentication password for routers enforcing TCP MD5 authenticated sessions. ,
Required: False ,
}
string ,
peerAddress:
{
Description: The IPv4 or IPv6 address used to connect this BGP session. ,
Required: True ,
}
string ,
peerAsn:
{
Description: The autonomous system number expected from the remote end of the BGP session. ,
Format: int64 ,
Required: True ,
}
integer ,
peerPort:
{
Description: The port used to connect this BGP session. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
fabricPeeringEnabled:
{
Description: The indicator to specify if the load balancer peers with the network fabric. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
cloudServicesNetworkId:
{
Description: The resource ID of the associated Cloud Services network. ,
Format: arm-id ,
Required: True ,
}
string ,
cniNetworkId:
{
Description: The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. ,
Format: arm-id ,
Required: True ,
}
string ,
dnsServiceIp:
{
Description: The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. ,
Required: False ,
}
string ,
l2ServiceLoadBalancerConfiguration:
{
Description: The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. ,
Required: False ,
}
{
ipAddressPools:
{
Description: The list of pools of IP addresses that can be allocated to load balancer services. ,
Required: False ,
}
[
{
addresses:
{
Description: The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. ,
Required: True ,
}
[
string ,
]
,
autoAssign:
{
Description: The indicator to determine if automatic allocation from the pool should occur. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name used to identify this IP address pool for association with a BGP advertisement. ,
Required: True ,
}
string ,
onlyUseHostIps:
{
Description: The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
podCidrs:
{
Description: The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
serviceCidrs:
{
Description: The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. ,
Required: False ,
}
[
string ,
]
,
}
,
nodes:
{
Description: The details of the nodes in this cluster. ,
Required: False ,
}
[
{
agentPoolId:
{
Description: The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. ,
Format: arm-id ,
Required: False ,
}
string ,
availabilityZone:
{
Description: The availability zone this node is running within. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts this node. ,
Format: arm-id ,
Required: False ,
}
string ,
cpuCores:
{
Description: The number of CPU cores configured for this node, derived from the VM SKU specified. ,
Format: int64 ,
Required: False ,
}
integer ,
detailedStatus:
{
Description: The detailed state of this node. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: The size of the disk configured for this node. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
image:
{
Description: The machine image used to deploy this node. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The currently running version of Kubernetes and bundled features running on this node. ,
Required: False ,
}
string ,
labels:
{
Description: The list of labels on this node that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
memorySizeGB:
{
Description: The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: False ,
}
integer ,
mode:
{
Description: The mode of the agent pool containing this node. Not applicable for control plane nodes. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of this node, as realized in the Kubernetes cluster. ,
Required: False ,
}
string ,
networkAttachments:
{
Description: The NetworkAttachments made to this node. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
powerState:
{
Description: The power state of this node. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The role of this node in the cluster. ,
Enum:
{
ControlPlane: No description available. ,
Worker: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The list of taints that have been assigned to the agent pool containing this node. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
vmSkuName:
{
Description: The VM SKU name that was used to create this cluster node. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
InProgress: No description available. ,
Created: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_ListByKubernetesCluster (new)
Description :  Get a list of agent pools for the provided Kubernetes cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of agent pools. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_Get (new)
Description :  Get properties of the provided Kubernetes cluster agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the Kubernetes cluster agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_CreateOrUpdate (new)
Description :  Create a new Kubernetes cluster agent pool or update the properties of the existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the Kubernetes cluster agent pool. ,
Required: True ,
}
string ,
agentPoolParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_Delete (new)
Description :  Delete the provided Kubernetes cluster agent pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the Kubernetes cluster agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentPools_Update (new)
Description :  Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the Kubernetes cluster agent pool. ,
Required: True ,
}
string ,
agentPoolUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
administratorConfiguration:
{
Description: The configuration of administrator credentials for the control plane nodes. ,
Required: False ,
}
{
sshPublicKeys:
{
Description: SshPublicKey represents the public key used to authenticate with a resource through SSH. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorConfiguration:
{
Description: The administrator credentials to be used for the nodes in this agent pool. ,
Required: False ,
}
{
adminUsername:
{
Description: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
}
,
agentOptions:
{
Description: The configurations that will be applied to each agent in this agent pool. ,
Required: False ,
}
{
hugepagesCount:
{
Description: The number of hugepages to allocate. ,
Format: int64 ,
Required: True ,
}
integer ,
hugepagesSize:
{
Description: The size of the hugepages to allocate. ,
Enum:
{
2M: No description available. ,
1G: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
attachedNetworkConfiguration:
{
Description: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. ,
Required: False ,
}
{
l2Networks:
{
Description: The list of Layer 2 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
l3Networks:
{
Description: The list of Layer 3 Networks and related configuration for attachment. ,
Required: False ,
}
[
{
ipamEnabled:
{
Description: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
trunkedNetworks:
{
Description: The list of Trunked Networks and related configuration for attachment. ,
Required: False ,
}
[
{
networkId:
{
Description: The resource ID of the network that is being configured for attachment. ,
Format: arm-id ,
Required: True ,
}
string ,
pluginType:
{
Description: The indicator of how this network will be utilized by the Kubernetes cluster. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
MACVLAN: No description available. ,
IPVLAN: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
availabilityZones:
{
Description: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. ,
Required: False ,
}
[
string ,
]
,
count:
{
Description: The number of virtual machines that use this configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The current status of the agent pool. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
kubernetesVersion:
{
Description: The Kubernetes version running in this agent pool. ,
Required: False ,
}
string ,
labels:
{
Description: The labels applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
mode:
{
Description: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. ,
Enum:
{
System: No description available. ,
User: No description available. ,
NotApplicable: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the agent pool. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
taints:
{
Description: The taints applied to the nodes in this agent pool. ,
Required: False ,
}
[
{
key:
{
Description: The name of the label or taint. ,
Required: True ,
}
string ,
value:
{
Description: The value of the label or taint. ,
Required: True ,
}
string ,
}
,
]
,
upgradeSettings:
{
Description: The configuration of the agent pool. ,
Required: False ,
}
{
drainTimeout:
{
Description: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. ,
Format: int64 ,
Required: False ,
}
integer ,
maxSurge:
{
Description: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
maxUnavailable:
{
Description: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. ,
Required: False ,
}
string ,
}
,
vmSkuName:
{
Description: The name of the VM SKU that determines the size of resources allocated for node VMs. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusterFeatures_ListByKubernetesCluster (new)
Description :  Get a list of features for the provided Kubernetes cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of Kubernetes cluster features. ,
Required: False ,
}
[
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusterFeatures_Get (new)
Description :  Get properties of the provided the Kubernetes cluster feature.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusterFeatures_CreateOrUpdate (new)
Description :  Create a new Kubernetes cluster feature or update properties of the Kubernetes cluster feature if it exists.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
kubernetesClusterFeatureParameters:
{
Description: The request body. ,
Required: True ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusterFeatures_Delete (new)
Description :  Delete the provided Kubernetes cluster feature.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusterFeatures_Update (new)
Description :  Patch properties of the provided Kubernetes cluster feature.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/features/{featureName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
featureName:
{
Description: The name of the feature. ,
Required: True ,
}
string ,
kubernetesClusterFeatureUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
availabilityLifecycle:
{
Description: The lifecycle indicator of the feature. ,
Enum:
{
Preview: No description available. ,
GenerallyAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatus:
{
Description: The detailed status of the feature. ,
Enum:
{
Error: No description available. ,
Provisioning: No description available. ,
Installed: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message for the detailed status of the feature. ,
Required: False ,
}
string ,
options:
{
Description: The configured options for the feature. ,
Required: False ,
}
[
{
key:
{
Description: The key to the mapped value. ,
Required: True ,
}
string ,
value:
{
Description: The value of the mapping key. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Kubernetes cluster feature. ,
Enum:
{
Accepted: No description available. ,
Canceled: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
required:
{
Description: The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the feature. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KubernetesClusters_RestartNode (new)
Description :  Restart a targeted node of a Kubernetes cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
kubernetesClusterName:
{
Description: The name of the Kubernetes cluster. ,
Required: True ,
}
string ,
kubernetesClusterRestartNodeParameters:
{
Description: The request body. ,
Required: True ,
}
{
nodeName:
{
Description: The name of the node to restart. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_ListByResourceGroup (new)
Description :  Get a list of layer 2 (L2) networks in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of L2 networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_Get (new)
Description :  Get properties of the provided layer 2 (L2) network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2NetworkName:
{
Description: The name of the L2 network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_CreateOrUpdate (new)
Description :  Create a new layer 2 (L2) network or update the properties of the existing network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2NetworkName:
{
Description: The name of the L2 network. ,
Required: True ,
}
string ,
l2NetworkParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_Delete (new)
Description :  Delete the provided layer 2 (L2) network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2NetworkName:
{
Description: The name of the L2 network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2Networks_Update (new)
Description :  Update tags associated with the provided layer 2 (L2) network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l2Networks/{l2NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2NetworkName:
{
Description: The name of the L2 network. ,
Required: True ,
}
string ,
l2NetworkUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L2 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L2 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
l2IsolationDomainId:
{
Description: The resource ID of the Network Fabric l2IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L2 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_ListByResourceGroup (new)
Description :  Get a list of layer 3 (L3) networks in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of L3 networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_Get (new)
Description :  Get properties of the provided layer 3 (L3) network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3NetworkName:
{
Description: The name of the L3 network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_CreateOrUpdate (new)
Description :  Create a new layer 3 (L3) network or update the properties of the existing network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3NetworkName:
{
Description: The name of the L3 network. ,
Required: True ,
}
string ,
l3NetworkParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_Delete (new)
Description :  Delete the provided layer 3 (L3) network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3NetworkName:
{
Description: The name of the L3 network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3Networks_Update (new)
Description :  Update tags associated with the provided layer 3 (L3) network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/l3Networks/{l3NetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3NetworkName:
{
Description: The name of the L3 network. ,
Required: True ,
}
string ,
l3NetworkUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this L3 network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the L3 network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network. ,
Required: False ,
}
[
string ,
]
,
hybridAksIpamEnabled:
{
Description: Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine. ,
Required: False ,
}
string ,
ipAllocationType:
{
Description: The type of the IP address allocation, defaulted to "DualStack". ,
Enum:
{
IPV4: No description available. ,
IPV6: No description available. ,
DualStack: No description available. ,
}
,
Required: False ,
}
enum ,
ipv4ConnectedPrefix:
{
Description: The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack. ,
Required: False ,
}
string ,
ipv6ConnectedPrefix:
{
Description: The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack. ,
Required: False ,
}
string ,
l3IsolationDomainId:
{
Description: The resource ID of the Network Fabric l3IsolationDomain. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the L3 network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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 L3 network. ,
Required: False ,
}
[
string ,
]
,
vlan:
{
Description: The VLAN from the l3IsolationDomain that is used for this network. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_ListByResourceGroup (new)
Description :  Get a list of racks in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of racks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_Get (new)
Description :  Get properties of the provided rack.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
rackName:
{
Description: The name of the rack. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_CreateOrUpdate (new)
Description :  Create a new rack or update properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
rackName:
{
Description: The name of the rack. ,
Required: True ,
}
string ,
rackParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_Delete (new)
Description :  Delete the provided rack. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
rackName:
{
Description: The name of the rack. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Racks_Update (new)
Description :  Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/racks/{rackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
rackName:
{
Description: The name of the rack. ,
Required: True ,
}
string ,
rackUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: False ,
}
string ,
rackSerialNumber:
{
Description: The globally unique identifier for the rack. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
availabilityZone:
{
Description: The value that will be used for machines in this rack to represent the availability zones that can be referenced by Hybrid AKS Clusters for node arrangement. ,
Required: True ,
}
string ,
clusterId:
{
Description: The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the rack. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the rack resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackLocation:
{
Description: The free-form description of the rack location. (e.g. “DTN Datacenter, Floor 3, Isle 9, Rack 2B”) ,
Required: True ,
}
string ,
rackSerialNumber:
{
Description: The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. ,
Required: True ,
}
string ,
rackSkuId:
{
Description: The SKU for the rack. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_ListByResourceGroup (new)
Description :  Get a list of storage appliances in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of storage appliances. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_Get (new)
Description :  Get properties of the provided storage appliance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_CreateOrUpdate (new)
Description :  Create a new storage appliance or update the properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
storageApplianceParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_Delete (new)
Description :  Delete the provided storage appliance. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_Update (new)
Description :  Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
storageApplianceUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
administratorCredentials:
{
Description: The credentials of the administrative interface on this storage appliance. ,
Required: True ,
}
{
password:
{
Description: The password of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
username:
{
Description: The username of the administrator of the device used during initialization. ,
Required: True ,
}
string ,
}
,
capacity:
{
Description: The total capacity of the storage appliance. Measured in GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
capacityUsed:
{
Description: The amount of storage consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
clusterId:
{
Description: The resource ID of the cluster this storage appliance is associated with. Measured in GiB. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The detailed status of the storage appliance. ,
Enum:
{
Available: No description available. ,
Degraded: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: The endpoint for the management interface of the storage appliance. ,
Required: False ,
}
string ,
manufacturer:
{
Description: The manufacturer of the storage appliance. ,
Required: False ,
}
string ,
model:
{
Description: The model of the storage appliance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the storage appliance. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
rackId:
{
Description: The resource ID of the rack where this storage appliance resides. ,
Format: arm-id ,
Required: True ,
}
string ,
rackSlot:
{
Description: The slot the storage appliance is in the rack based on the BOM configuration. ,
Format: int64 ,
Required: True ,
}
integer ,
remoteVendorManagementFeature:
{
Description: The indicator of whether the storage appliance supports remote vendor management. ,
Enum:
{
Supported: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVendorManagementStatus:
{
Description: The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Unsupported: No description available. ,
}
,
Required: False ,
}
enum ,
secretRotationStatus:
{
Description: The list of statuses that represent secret rotation activity. ,
Required: False ,
}
[
{
expirePeriodDays:
{
Description: The maximum number of days the secret may be used before it must be changed. ,
Format: int64 ,
Required: False ,
}
integer ,
lastRotationTime:
{
Description: The date and time when the secret was last changed. ,
Format: date-time ,
Required: False ,
}
string ,
rotationPeriodDays:
{
Description: The number of days a secret exists before rotations will be attempted. ,
Format: int64 ,
Required: False ,
}
integer ,
secretArchiveReference:
{
Description: The reference to the secret in a key vault. ,
Required: False ,
}
{
keyVaultId:
{
Description: The resource ID of the key vault containing the secret. ,
Format: arm-id ,
Required: False ,
}
string ,
secretName:
{
Description: The name of the secret in the key vault. ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the secret in the key vault. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The type name used to identify the purpose of the secret. ,
Required: False ,
}
string ,
}
,
]
,
serialNumber:
{
Description: The serial number for the storage appliance. ,
Required: True ,
}
string ,
storageApplianceSkuId:
{
Description: The SKU for the storage appliance. ,
Required: True ,
}
string ,
version:
{
Description: The version of the storage appliance. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_DisableRemoteVendorManagement (new)
Description :  Disable remote vendor management of the provided storage appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/disableRemoteVendorManagement
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAppliances_EnableRemoteVendorManagement (new)
Description :  Enable remote vendor management of the provided storage appliance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/enableRemoteVendorManagement
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
storageApplianceName:
{
Description: The name of the storage appliance. ,
Required: True ,
}
string ,
storageApplianceEnableRemoteVendorManagementParameters:
{
Description: The request body. ,
Required: False ,
}
{
supportEndpoints:
{
Description: Field Deprecated. This field is not used and will be rejected if provided. The list of IPv4 subnets (in CIDR format), IPv6 subnets (in CIDR format), or hostnames that the storage appliance needs accessible in order to turn on the remote vendor management. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_ListByResourceGroup (new)
Description :  Get a list of trunked networks in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of trunked networks. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_Get (new)
Description :  Get properties of the provided trunked network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trunkedNetworkName:
{
Description: The name of the trunked network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_CreateOrUpdate (new)
Description :  Create a new trunked network or update the properties of the existing trunked network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trunkedNetworkName:
{
Description: The name of the trunked network. ,
Required: True ,
}
string ,
trunkedNetworkParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_Delete (new)
Description :  Delete the provided trunked network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trunkedNetworkName:
{
Description: The name of the trunked network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrunkedNetworks_Update (new)
Description :  Update tags associated with the provided trunked network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/trunkedNetworks/{trunkedNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trunkedNetworkName:
{
Description: The name of the trunked network. ,
Required: True ,
}
string ,
trunkedNetworkUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
associatedResourceIds:
{
Description: The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. ,
Required: False ,
}
[
string ,
]
,
clusterId:
{
Description: The resource ID of the Network Cloud cluster this trunked network is associated with. ,
Format: arm-id ,
Required: False ,
}
string ,
detailedStatus:
{
Description: The more detailed status of the trunked network. ,
Enum:
{
Error: No description available. ,
Available: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
hybridAksClustersAssociatedIds:
{
Description: Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network. ,
Required: False ,
}
[
string ,
]
,
hybridAksPluginType:
{
Description: 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. ,
Enum:
{
DPDK: No description available. ,
SRIOV: No description available. ,
OSDevice: No description available. ,
}
,
Required: False ,
}
enum ,
interfaceName:
{
Description: 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. ,
Required: False ,
}
string ,
isolationDomainIds:
{
Description: The list of resource IDs representing the Network Fabric isolation domains. It can be any combination of l2IsolationDomain and l3IsolationDomain resources. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the trunked network. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
virtualMachinesAssociatedIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
vlans:
{
Description: The list of vlans that are selected from the isolation domains for trunking. ,
Required: True ,
}
[
integer ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_ListByResourceGroup (new)
Description :  Get a list of virtual machines in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of virtual machines. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (new)
Description :  Get properties of the provided virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_CreateOrUpdate (new)
Description :  Create a new virtual machine or update the properties of the existing virtual machine.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
virtualMachineParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Delete (new)
Description :  Delete the provided virtual machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Update (new)
Description :  Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
virtualMachineUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
adminUsername:
{
Description: The name of the administrator to which the ssh public keys will be added into the authorized keys. ,
Required: True ,
}
string ,
availabilityZone:
{
Description: The cluster availability zone containing this virtual machine. ,
Required: False ,
}
string ,
bareMetalMachineId:
{
Description: The resource ID of the bare metal machine that hosts the virtual machine. ,
Format: arm-id ,
Required: False ,
}
string ,
bootMethod:
{
Description: Selects the boot method for the virtual machine. ,
Enum:
{
UEFI: No description available. ,
BIOS: No description available. ,
}
,
Required: False ,
}
enum ,
cloudServicesNetworkAttachment:
{
Description: The cloud service network that provides platform-level services for the virtual machine. ,
Required: True ,
}
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
clusterId:
{
Description: The resource ID of the cluster the virtual machine is created for. ,
Format: arm-id ,
Required: False ,
}
string ,
consoleExtendedLocation:
{
Description: The extended location to use for creation of a VM console resource. ,
Required: False ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
cpuCores:
{
Description: The number of CPU cores in the virtual machine. ,
Format: int64 ,
Required: True ,
}
integer ,
detailedStatus:
{
Description: The more detailed status of the virtual machine. ,
Enum:
{
Available: No description available. ,
Error: No description available. ,
Provisioning: No description available. ,
Running: No description available. ,
Scheduling: No description available. ,
Stopped: No description available. ,
Terminating: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
isolateEmulatorThread:
{
Description: Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
memorySizeGB:
{
Description: The memory size of the virtual machine. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
networkAttachments:
{
Description: The list of network attachments to the virtual machine. ,
Required: False ,
}
[
{
attachedNetworkId:
{
Description: The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. ,
Format: arm-id ,
Required: True ,
}
string ,
defaultGateway:
{
Description: The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
ipAllocationMethod:
{
Description: The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value. ,
Enum:
{
Dynamic: No description available. ,
Static: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
ipv4Address:
{
Description: The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty. ,
Required: False ,
}
string ,
macAddress:
{
Description: The MAC address of the interface for the virtual machine that corresponds to this network attachment. ,
Required: False ,
}
string ,
networkAttachmentName:
{
Description: The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
networkData:
{
Description: The Base64 encoded cloud-init network data. ,
Required: False ,
}
string ,
placementHints:
{
Description: The scheduling hints for the virtual machine. ,
Required: False ,
}
[
{
hintType:
{
Description: The specification of whether this hint supports affinity or anti-affinity with the referenced resources. ,
Enum:
{
Affinity: No description available. ,
AntiAffinity: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. ,
Format: arm-id ,
Required: True ,
}
string ,
schedulingExecution:
{
Description: The indicator of whether the hint is a hard or soft requirement during scheduling. ,
Enum:
{
Hard: No description available. ,
Soft: No description available. ,
}
,
Required: True ,
}
enum ,
scope:
{
Description: The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. ,
Enum:
{
Rack: No description available. ,
Machine: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
powerState:
{
Description: The power state of the virtual machine. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the virtual machine. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKeys:
{
Description: The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. ,
Required: False ,
}
[
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
]
,
storageProfile:
{
Description: The storage profile that specifies size and other parameters about the disks related to the virtual machine. ,
Required: True ,
}
{
osDisk:
{
Description: The disk to use with this virtual machine. ,
Required: True ,
}
{
createOption:
{
Description: The strategy for creating the OS disk. ,
Enum:
{
Ephemeral: Utilize the local storage of the host machine. ,
Persistent: Utilize a storage appliance backed volume to host the disk. ,
}
,
Required: False ,
}
enum ,
deleteOption:
{
Description: The strategy for deleting the OS disk. ,
Enum:
{
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
volumeAttachments:
{
Description: The resource IDs of volumes that are requested to be attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
userData:
{
Description: The Base64 encoded cloud-init user data. ,
Required: False ,
}
string ,
virtioInterface:
{
Description: Field Deprecated, use virtualizationModel instead. The type of the virtio interface. ,
Enum:
{
Modern: No description available. ,
Transitional: No description available. ,
}
,
Required: False ,
}
enum ,
vmDeviceModel:
{
Description: The type of the device model to use. ,
Enum:
{
T1: Traditional and most compatible device virtualization interface. ,
T2: Modern and enhanced device virtualization interface. ,
T3: Improved security and functionality (including TPM and secure boot support). ,
}
,
Required: False ,
}
enum ,
vmImage:
{
Description: The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. ,
Required: True ,
}
string ,
vmImageRepositoryCredentials:
{
Description: The credentials used to login to the image repository that has access to the specified image. ,
Required: False ,
}
{
password:
{
Description: The password or token used to access an image in the target repository. ,
Required: True ,
}
string ,
registryUrl:
{
Description: The URL of the authentication server used to validate the repository credentials. ,
Required: True ,
}
string ,
username:
{
Description: The username used to access an image in the target repository. ,
Required: True ,
}
string ,
}
,
volumes:
{
Description: The resource IDs of volumes that are attached to the virtual machine. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Consoles_ListByVirtualMachine (new)
Description :  Get a list of consoles for the provided virtual machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of virtual machine consoles. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Consoles_Get (new)
Description :  Get properties of the provided virtual machine console.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the virtual machine console. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Consoles_CreateOrUpdate (new)
Description :  Create a new virtual machine console or update the properties of the existing virtual machine console.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the virtual machine console. ,
Required: True ,
}
string ,
consoleParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Consoles_Delete (new)
Description :  Delete the provided virtual machine console.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the virtual machine console. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Consoles_Update (new)
Description :  Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
consoleName:
{
Description: The name of the virtual machine console. ,
Required: True ,
}
string ,
consoleUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
properties:
{
Description: The list of the resource properties. ,
Required: False ,
}
{
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: False ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
}
,
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster manager associated with the cluster this virtual machine is created on. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
detailedStatus:
{
Description: The more detailed status of the console. ,
Enum:
{
Ready: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
enabled:
{
Description: The indicator of whether the console access is enabled. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: True ,
}
enum ,
expiration:
{
Description: The date and time after which the key will be disallowed access. ,
Format: date-time ,
Required: False ,
}
string ,
privateLinkServiceId:
{
Description: The resource ID of the private link service that is used to provide virtual machine console access. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the virtual machine console. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
sshPublicKey:
{
Description: The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. ,
Required: True ,
}
{
keyData:
{
Description: The SSH public key data. ,
Required: True ,
}
string ,
}
,
virtualMachineAccessId:
{
Description: The unique identifier for the virtual machine that is used to access the console. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_PowerOff (new)
Description :  Power off the provided virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/powerOff
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
virtualMachinePowerOffParameters:
{
Description: The request body. ,
Required: False ,
}
{
skipShutdown:
{
Description: The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately. ,
Enum:
{
True: No description available. ,
False: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Reimage (new)
Description :  Reimage the provided virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/reimage
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Restart (new)
Description :  Restart the provided virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Start (new)
Description :  Start the provided virtual machine.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: The name of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_ListByResourceGroup (new)
Description :  Get a list of volumes in the provided resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of volumes. ,
Required: False ,
}
[
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Get (new)
Description :  Get properties of the provided volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_CreateOrUpdate (new)
Description :  Create a new volume or update the properties of the existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
volumeParameters:
{
Description: The request body. ,
Required: True ,
}
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}
,
$schema:
{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Delete (new)
Description :  Delete the provided volume.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL to retrieve the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Update (new)
Description :  Update tags associated with the provided volume.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume. ,
Required: True ,
}
string ,
volumeUpdateParameters:
{
Description: The request body. ,
Required: False ,
}
{
tags:
{
Description: The Azure resource tags that will replace the existing ones. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
extendedLocation:
{
Description: The extended location of the cluster associated with the resource. ,
Required: True ,
}
{
name:
{
Description: The resource ID of the extended location on which the resource will be created. ,
Required: True ,
}
string ,
type:
{
Description: The extended location type, for example, CustomLocation. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The list of the resource properties. ,
Required: True ,
}
{
attachedTo:
{
Description: The list of resource IDs that attach the volume. It may include virtual machines and Hybrid AKS clusters. ,
Required: False ,
}
[
string ,
]
,
detailedStatus:
{
Description: The more detailed status of the volume. ,
Enum:
{
Error: No description available. ,
Active: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
detailedStatusMessage:
{
Description: The descriptive message about the current detailed status. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the volume. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Provisioning: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
serialNumber:
{
Description: The unique identifier of the volume. ,
Required: False ,
}
string ,
sizeMiB:
{
Description: The size of the allocation for this volume in Mebibytes. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}