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: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
isDataAction: boolean ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: enum ,
actionType: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
associatedResourceIds:
[
string ,
]
,
bmcConnectionString: string ,
bmcCredentials:
{
password: string ,
username: string ,
}
,
bmcMacAddress: string ,
bootMacAddress: string ,
clusterId: string ,
cordonStatus: enum ,
detailedStatus: enum ,
detailedStatusMessage: string ,
hardwareInventory:
{
additionalHostInformation: string ,
interfaces:
[
{
linkStatus: string ,
macAddress: string ,
name: string ,
networkInterfaceId: string ,
}
,
]
,
nics:
[
{
lldpNeighbor:
{
portDescription: string ,
portName: string ,
systemDescription: string ,
systemName: string ,
}
,
macAddress: string ,
name: string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
lastValidationTime: string ,
result: enum ,
}
,
hybridAksClustersAssociatedIds:
[
string ,
]
,
kubernetesNodeName: string ,
kubernetesVersion: string ,
machineClusterVersion: string ,
machineDetails: string ,
machineName: string ,
machineRoles:
[
string ,
]
,
machineSkuId: string ,
oamIpv4Address: string ,
oamIpv6Address: string ,
osImage: string ,
powerState: enum ,
provisioningState: enum ,
rackId: string ,
rackSlot: integer ,
readyState: enum ,
runtimeProtectionStatus:
{
definitionsLastUpdated: string ,
definitionsVersion: string ,
scanCompletedTime: string ,
scanScheduledTime: string ,
scanStartedTime: string ,
}
,
secretRotationStatus:
[
{
expirePeriodDays: integer ,
lastRotationTime: string ,
rotationPeriodDays: integer ,
secretArchiveReference:
{
keyVaultId: string ,
secretName: string ,
secretVersion: string ,
}
,
secretType: string ,
}
,
]
,
serialNumber: string ,
serviceTag: string ,
virtualMachinesAssociatedIds:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
additionalEgressEndpoints:
[
{
category: string ,
endpoints:
[
{
domainName: string ,
port: integer ,
}
,
]
,
}
,
]
,
associatedResourceIds:
[
string ,
]
,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
enableDefaultEgressEndpoints: enum ,
enabledEgressEndpoints:
[
{
category: string ,
endpoints:
[
{
domainName: string ,
port: integer ,
}
,
]
,
}
,
]
,
hybridAksClustersAssociatedIds:
[
string ,
]
,
interfaceName: string ,
provisioningState: enum ,
virtualMachinesAssociatedIds:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
analyticsWorkspaceId: string ,
availabilityZones:
[
string ,
]
,
clusterVersions:
[
{
supportExpiryDate: string ,
targetClusterVersion: string ,
}
,
]
,
detailedStatus: enum ,
detailedStatusMessage: string ,
fabricControllerId: string ,
managedResourceGroupConfiguration:
{
location: string ,
name: string ,
}
,
managerExtendedLocation:
{
name: string ,
type: string ,
}
,
provisioningState: enum ,
vmSize: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
aggregatorOrSingleRackDefinition:
{
availabilityZone: string ,
bareMetalMachineConfigurationData:
[
{
bmcConnectionString: string ,
bmcCredentials:
{
password: string ,
username: string ,
}
,
bmcMacAddress: string ,
bootMacAddress: string ,
machineDetails: string ,
machineName: string ,
rackSlot: integer ,
serialNumber: string ,
}
,
]
,
networkRackId: string ,
rackLocation: string ,
rackSerialNumber: string ,
rackSkuId: string ,
storageApplianceConfigurationData:
[
{
adminCredentials:
{
password: string ,
username: string ,
}
,
rackSlot: integer ,
serialNumber: string ,
storageApplianceName: string ,
}
,
]
,
}
,
analyticsOutputSettings:
{
analyticsWorkspaceId: string ,
associatedIdentity:
{
identityType: enum ,
userAssignedIdentityResourceId: string ,
}
,
}
,
analyticsWorkspaceId: string ,
availableUpgradeVersions:
[
{
controlImpact: enum ,
expectedDuration: string ,
impactDescription: string ,
supportExpiryDate: string ,
targetClusterVersion: string ,
workloadImpact: enum ,
}
,
]
,
clusterCapacity:
{
availableApplianceStorageGB: integer ,
availableCoreCount: integer ,
availableHostStorageGB: integer ,
availableMemoryGB: integer ,
totalApplianceStorageGB: integer ,
totalCoreCount: integer ,
totalHostStorageGB: integer ,
totalMemoryGB: integer ,
}
,
clusterConnectionStatus: enum ,
clusterExtendedLocation:
{
name: string ,
type: string ,
}
,
clusterLocation: string ,
clusterManagerConnectionStatus: enum ,
clusterManagerId: string ,
clusterServicePrincipal:
{
applicationId: string ,
password: string ,
principalId: string ,
tenantId: string ,
}
,
clusterType: enum ,
clusterVersion: string ,
commandOutputSettings:
{
associatedIdentity:
{
identityType: enum ,
userAssignedIdentityResourceId: string ,
}
,
containerUrl: string ,
}
,
computeDeploymentThreshold:
{
grouping: enum ,
type: enum ,
value: integer ,
}
,
computeRackDefinitions:
[
{
availabilityZone: string ,
bareMetalMachineConfigurationData:
[
{
bmcConnectionString: string ,
bmcCredentials:
{
password: string ,
username: string ,
}
,
bmcMacAddress: string ,
bootMacAddress: string ,
machineDetails: string ,
machineName: string ,
rackSlot: integer ,
serialNumber: string ,
}
,
]
,
networkRackId: string ,
rackLocation: string ,
rackSerialNumber: string ,
rackSkuId: string ,
storageApplianceConfigurationData:
[
{
adminCredentials:
{
password: string ,
username: string ,
}
,
rackSlot: integer ,
serialNumber: string ,
storageApplianceName: string ,
}
,
]
,
}
,
]
,
detailedStatus: enum ,
detailedStatusMessage: string ,
hybridAksExtendedLocation:
{
name: string ,
type: string ,
}
,
managedResourceGroupConfiguration:
{
location: string ,
name: string ,
}
,
manualActionCount: integer ,
networkFabricId: string ,
provisioningState: enum ,
runtimeProtectionConfiguration:
{
enforcementLevel: enum ,
}
,
secretArchive:
{
keyVaultId: string ,
useKeyVault: enum ,
}
,
secretArchiveSettings:
{
associatedIdentity:
{
identityType: enum ,
userAssignedIdentityResourceId: string ,
}
,
vaultUri: string ,
}
,
supportExpiryDate: string ,
updateStrategy:
{
maxUnavailable: integer ,
strategyType: enum ,
thresholdType: enum ,
thresholdValue: integer ,
waitTimeMinutes: integer ,
}
,
vulnerabilityScanningSettings:
{
containerScan: enum ,
}
,
workloadResourceIds:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
aadConfiguration:
{
adminGroupObjectIds:
[
string ,
]
,
}
,
administratorConfiguration:
{
adminUsername: string ,
sshPublicKeys:
[
{
keyData: string ,
}
,
]
,
}
,
attachedNetworkIds:
[
string ,
]
,
availableUpgrades:
[
{
availabilityLifecycle: enum ,
version: string ,
}
,
]
,
clusterId: string ,
connectedClusterId: string ,
controlPlaneKubernetesVersion: string ,
controlPlaneNodeConfiguration:
{
administratorConfiguration:
{
adminUsername: string ,
sshPublicKeys:
[
{
keyData: string ,
}
,
]
,
}
,
availabilityZones:
[
string ,
]
,
count: integer ,
vmSkuName: string ,
}
,
detailedStatus: enum ,
detailedStatusMessage: string ,
featureStatuses:
[
{
detailedStatus: enum ,
detailedStatusMessage: string ,
name: string ,
version: string ,
}
,
]
,
initialAgentPoolConfigurations:
[
{
administratorConfiguration:
{
adminUsername: string ,
sshPublicKeys:
[
{
keyData: string ,
}
,
]
,
}
,
agentOptions:
{
hugepagesCount: integer ,
hugepagesSize: enum ,
}
,
attachedNetworkConfiguration:
{
l2Networks:
[
{
networkId: string ,
pluginType: enum ,
}
,
]
,
l3Networks:
[
{
ipamEnabled: enum ,
networkId: string ,
pluginType: enum ,
}
,
]
,
trunkedNetworks:
[
{
networkId: string ,
pluginType: enum ,
}
,
]
,
}
,
availabilityZones:
[
string ,
]
,
count: integer ,
labels:
[
{
key: string ,
value: string ,
}
,
]
,
mode: enum ,
name: string ,
taints:
[
{
key: string ,
value: string ,
}
,
]
,
upgradeSettings:
{
drainTimeout: integer ,
maxSurge: string ,
maxUnavailable: string ,
}
,
vmSkuName: string ,
}
,
]
,
kubernetesVersion: string ,
managedResourceGroupConfiguration:
{
location: string ,
name: string ,
}
,
networkConfiguration:
{
attachedNetworkConfiguration:
{
l2Networks:
[
{
networkId: string ,
pluginType: enum ,
}
,
]
,
l3Networks:
[
{
ipamEnabled: enum ,
networkId: string ,
pluginType: enum ,
}
,
]
,
trunkedNetworks:
[
{
networkId: string ,
pluginType: enum ,
}
,
]
,
}
,
bgpServiceLoadBalancerConfiguration:
{
bgpAdvertisements:
[
{
advertiseToFabric: enum ,
communities:
[
string ,
]
,
ipAddressPools:
[
string ,
]
,
peers:
[
string ,
]
,
}
,
]
,
bgpPeers:
[
{
bfdEnabled: enum ,
bgpMultiHop: enum ,
holdTime: string ,
keepAliveTime: string ,
myAsn: integer ,
name: string ,
password: string ,
peerAddress: string ,
peerAsn: integer ,
peerPort: integer ,
}
,
]
,
fabricPeeringEnabled: enum ,
ipAddressPools:
[
{
addresses:
[
string ,
]
,
autoAssign: enum ,
name: string ,
onlyUseHostIps: enum ,
}
,
]
,
}
,
cloudServicesNetworkId: string ,
cniNetworkId: string ,
dnsServiceIp: string ,
l2ServiceLoadBalancerConfiguration:
{
ipAddressPools:
[
{
addresses:
[
string ,
]
,
autoAssign: enum ,
name: string ,
onlyUseHostIps: enum ,
}
,
]
,
}
,
podCidrs:
[
string ,
]
,
serviceCidrs:
[
string ,
]
,
}
,
nodes:
[
{
agentPoolId: string ,
availabilityZone: string ,
bareMetalMachineId: string ,
cpuCores: integer ,
detailedStatus: enum ,
detailedStatusMessage: string ,
diskSizeGB: integer ,
image: string ,
kubernetesVersion: string ,
labels:
[
{
key: string ,
value: string ,
}
,
]
,
memorySizeGB: integer ,
mode: enum ,
name: string ,
networkAttachments:
[
{
attachedNetworkId: string ,
defaultGateway: enum ,
ipAllocationMethod: enum ,
ipv4Address: string ,
ipv6Address: string ,
macAddress: string ,
networkAttachmentName: string ,
}
,
]
,
powerState: enum ,
role: enum ,
taints:
[
{
key: string ,
value: string ,
}
,
]
,
vmSkuName: string ,
}
,
]
,
provisioningState: enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
associatedResourceIds:
[
string ,
]
,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
hybridAksClustersAssociatedIds:
[
string ,
]
,
hybridAksPluginType: enum ,
interfaceName: string ,
l2IsolationDomainId: string ,
provisioningState: enum ,
virtualMachinesAssociatedIds:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
associatedResourceIds:
[
string ,
]
,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
hybridAksClustersAssociatedIds:
[
string ,
]
,
hybridAksIpamEnabled: enum ,
hybridAksPluginType: enum ,
interfaceName: string ,
ipAllocationType: enum ,
ipv4ConnectedPrefix: string ,
ipv6ConnectedPrefix: string ,
l3IsolationDomainId: string ,
provisioningState: enum ,
virtualMachinesAssociatedIds:
[
string ,
]
,
vlan: integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
computeMachines:
[
{
properties:
{
bootstrapProtocol: enum ,
cpuCores: integer ,
cpuSockets: integer ,
disks:
[
{
capacityGB: integer ,
connection: enum ,
type: enum ,
}
,
]
,
generation: string ,
hardwareVersion: string ,
memoryCapacityGB: integer ,
model: string ,
networkInterfaces:
[
{
address: string ,
deviceConnectionType: enum ,
model: string ,
physicalSlot: integer ,
portCount: integer ,
portSpeed: integer ,
vendor: string ,
}
,
]
,
totalThreads: integer ,
vendor: string ,
}
,
rackSlot: integer ,
}
,
]
,
controllerMachines:
[
{
properties:
{
bootstrapProtocol: enum ,
cpuCores: integer ,
cpuSockets: integer ,
disks:
[
{
capacityGB: integer ,
connection: enum ,
type: enum ,
}
,
]
,
generation: string ,
hardwareVersion: string ,
memoryCapacityGB: integer ,
model: string ,
networkInterfaces:
[
{
address: string ,
deviceConnectionType: enum ,
model: string ,
physicalSlot: integer ,
portCount: integer ,
portSpeed: integer ,
vendor: string ,
}
,
]
,
totalThreads: integer ,
vendor: string ,
}
,
rackSlot: integer ,
}
,
]
,
description: string ,
maxClusterSlots: integer ,
provisioningState: enum ,
rackType: enum ,
storageAppliances:
[
{
properties:
{
capacityGB: integer ,
model: string ,
}
,
rackSlot: integer ,
}
,
]
,
supportedRackSkuIds:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
rackSkuName: string ,
}

⚐ Response (200)

{
properties:
{
computeMachines:
[
{
properties:
{
bootstrapProtocol: enum ,
cpuCores: integer ,
cpuSockets: integer ,
disks:
[
{
capacityGB: integer ,
connection: enum ,
type: enum ,
}
,
]
,
generation: string ,
hardwareVersion: string ,
memoryCapacityGB: integer ,
model: string ,
networkInterfaces:
[
{
address: string ,
deviceConnectionType: enum ,
model: string ,
physicalSlot: integer ,
portCount: integer ,
portSpeed: integer ,
vendor: string ,
}
,
]
,
totalThreads: integer ,
vendor: string ,
}
,
rackSlot: integer ,
}
,
]
,
controllerMachines:
[
{
properties:
{
bootstrapProtocol: enum ,
cpuCores: integer ,
cpuSockets: integer ,
disks:
[
{
capacityGB: integer ,
connection: enum ,
type: enum ,
}
,
]
,
generation: string ,
hardwareVersion: string ,
memoryCapacityGB: integer ,
model: string ,
networkInterfaces:
[
{
address: string ,
deviceConnectionType: enum ,
model: string ,
physicalSlot: integer ,
portCount: integer ,
portSpeed: integer ,
vendor: string ,
}
,
]
,
totalThreads: integer ,
vendor: string ,
}
,
rackSlot: integer ,
}
,
]
,
description: string ,
maxClusterSlots: integer ,
provisioningState: enum ,
rackType: enum ,
storageAppliances:
[
{
properties:
{
capacityGB: integer ,
model: string ,
}
,
rackSlot: integer ,
}
,
]
,
supportedRackSkuIds:
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
availabilityZone: string ,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
provisioningState: enum ,
rackLocation: string ,
rackSerialNumber: string ,
rackSkuId: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
administratorCredentials:
{
password: string ,
username: string ,
}
,
capacity: integer ,
capacityUsed: integer ,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
managementIpv4Address: string ,
manufacturer: string ,
model: string ,
provisioningState: enum ,
rackId: string ,
rackSlot: integer ,
remoteVendorManagementFeature: enum ,
remoteVendorManagementStatus: enum ,
secretRotationStatus:
[
{
expirePeriodDays: integer ,
lastRotationTime: string ,
rotationPeriodDays: integer ,
secretArchiveReference:
{
keyVaultId: string ,
secretName: string ,
secretVersion: string ,
}
,
secretType: string ,
}
,
]
,
serialNumber: string ,
storageApplianceSkuId: string ,
version: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
associatedResourceIds:
[
string ,
]
,
clusterId: string ,
detailedStatus: enum ,
detailedStatusMessage: string ,
hybridAksClustersAssociatedIds:
[
string ,
]
,
hybridAksPluginType: enum ,
interfaceName: string ,
isolationDomainIds:
[
string ,
]
,
provisioningState: enum ,
virtualMachinesAssociatedIds:
[
string ,
]
,
vlans:
[
integer ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
adminUsername: string ,
availabilityZone: string ,
bareMetalMachineId: string ,
bootMethod: enum ,
cloudServicesNetworkAttachment:
{
attachedNetworkId: string ,
defaultGateway: enum ,
ipAllocationMethod: enum ,
ipv4Address: string ,
ipv6Address: string ,
macAddress: string ,
networkAttachmentName: string ,
}
,
clusterId: string ,
consoleExtendedLocation:
{
name: string ,
type: string ,
}
,
cpuCores: integer ,
detailedStatus: enum ,
detailedStatusMessage: string ,
isolateEmulatorThread: enum ,
memorySizeGB: integer ,
networkAttachments:
[
{
attachedNetworkId: string ,
defaultGateway: enum ,
ipAllocationMethod: enum ,
ipv4Address: string ,
ipv6Address: string ,
macAddress: string ,
networkAttachmentName: string ,
}
,
]
,
networkData: string ,
placementHints:
[
{
hintType: enum ,
resourceId: string ,
schedulingExecution: enum ,
scope: enum ,
}
,
]
,
powerState: enum ,
provisioningState: enum ,
sshPublicKeys:
[
{
keyData: string ,
}
,
]
,
storageProfile:
{
osDisk:
{
createOption: enum ,
deleteOption: enum ,
diskSizeGB: integer ,
}
,
volumeAttachments:
[
string ,
]
,
}
,
userData: string ,
virtioInterface: enum ,
vmDeviceModel: enum ,
vmImage: string ,
vmImageRepositoryCredentials:
{
password: string ,
registryUrl: string ,
username: string ,
}
,
volumes:
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
attachedTo:
[
string ,
]
,
detailedStatus: enum ,
detailedStatusMessage: string ,
provisioningState: enum ,
serialNumber: string ,
sizeMiB: integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
extendedLocation:
{
name: string ,
type: string ,
}
,
properties:
{
associatedResourceIds:
[
string ,
]
,
bmcConnectionString: string ,
bmcCredentials:
{
password: string ,
username: string ,
}
,
bmcMacAddress: string ,
bootMacAddress: string ,
clusterId: string ,
cordonStatus: enum ,
detailedStatus: enum ,
detailedStatusMessage: string ,
hardwareInventory:
{
additionalHostInformation: string ,
interfaces:
[
{
linkStatus: string ,
macAddress: string ,
name: string ,
networkInterfaceId: string ,
}
,
]
,
nics:
[
{
lldpNeighbor:
{
portDescription: string ,
portName: string ,
systemDescription: string ,
systemName: string ,
}
,
macAddress: string ,
name: string ,
}
,
]
,
}
,
hardwareValidationStatus:
{
lastValidationTime: string ,
result: enum ,
}
,
hybridAksClustersAssociatedIds:
[
string ,
]
,
kubernetesNodeName: string ,
kubernetesVersion: string ,
machineClusterVersion: string ,
machineDetails: string ,
machineName: string ,
machineRoles:
[
string ,
]
,
machineSkuId: string ,
oamIpv4Address: string ,
oamIpv6Address: string ,
osImage: string ,
powerState: enum ,
provisioningState: enum ,
rackId: string ,
rackSlot: integer ,
readyState: enum ,
runtimeProtectionStatus:
{
definitionsLastUpdated: string ,
definitionsVersion: string ,
scanCompletedTime: string ,
scanScheduledTime: string ,
scanStartedTime: string ,
}
,