Package-level declarations

Types

Link copied to clipboard
data class AdministrativeCredentialsResponse(val password: String, val username: String)
data class BareMetalMachineConfigurationDataResponse(val bmcConnectionString: String, val bmcCredentials: AdministrativeCredentialsResponse, val bmcMacAddress: String, val bootMacAddress: String, val machineDetails: String? = null, val machineName: String? = null, val rackSlot: Double, val serialNumber: String)
Link copied to clipboard
data class BgpPeerResponse(val asNumber: Double, val peerIp: String)
Link copied to clipboard
data class ClusterAvailableUpgradeVersionResponse(val controlImpact: String, val expectedDuration: String, val impactDescription: String, val supportExpiryDate: String, val targetClusterVersion: String, val workloadImpact: String)
Link copied to clipboard
data class ClusterAvailableVersionResponse(val supportExpiryDate: String, val targetClusterVersion: String)
Link copied to clipboard
data class ClusterCapacityResponse(val availableApplianceStorageGB: Double? = null, val availableCoreCount: Double? = null, val availableHostStorageGB: Double? = null, val availableMemoryGB: Double? = null, val totalApplianceStorageGB: Double? = null, val totalCoreCount: Double? = null, val totalHostStorageGB: Double? = null, val totalMemoryGB: Double? = null)
Link copied to clipboard
data class CniBgpConfigurationResponse(val bgpPeers: List<BgpPeerResponse>? = null, val communityAdvertisements: List<CommunityAdvertisementResponse>? = null, val serviceExternalPrefixes: List<String>? = null, val serviceLoadBalancerPrefixes: List<String>? = null)
Link copied to clipboard
data class CommunityAdvertisementResponse(val communities: List<String>, val subnetPrefix: String)
Link copied to clipboard
data class EgressEndpointResponse(val category: String, val endpoints: List<EndpointDependencyResponse>)
Link copied to clipboard
data class EndpointDependencyResponse(val domainName: String, val port: Double? = null)
Link copied to clipboard
data class ExtendedLocationResponse(val name: String, val type: String)
Link copied to clipboard
data class GetBareMetalMachineKeySetResult(val azureGroupId: String, val detailedStatus: String, val detailedStatusMessage: String, val expiration: String, val extendedLocation: ExtendedLocationResponse, val id: String, val jumpHostsAllowed: List<String>, val lastValidation: String, val location: String, val name: String, val osGroupName: String? = null, val privilegeLevel: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userList: List<KeySetUserResponse>, val userListStatus: List<KeySetUserStatusResponse>)
Link copied to clipboard
data class GetBareMetalMachineResult(val bmcConnectionString: String, val bmcCredentials: AdministrativeCredentialsResponse, val bmcMacAddress: String, val bootMacAddress: String, val clusterId: String, val cordonStatus: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hardwareInventory: HardwareInventoryResponse, val hardwareValidationStatus: HardwareValidationStatusResponse, val hybridAksClustersAssociatedIds: List<String>, val id: String, val kubernetesNodeName: String, val kubernetesVersion: String, val location: String, val machineDetails: String, val machineName: String, val machineSkuId: String, val name: String, val oamIpv4Address: String, val oamIpv6Address: String, val osImage: String, val powerState: String, val provisioningState: String, val rackId: String, val rackSlot: Double, val readyState: String, val serialNumber: String, val serviceTag: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociatedIds: List<String>)
Link copied to clipboard
data class GetBmcKeySetResult(val azureGroupId: String, val detailedStatus: String, val detailedStatusMessage: String, val expiration: String, val extendedLocation: ExtendedLocationResponse, val id: String, val lastValidation: String, val location: String, val name: String, val privilegeLevel: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userList: List<KeySetUserResponse>, val userListStatus: List<KeySetUserStatusResponse>)
Link copied to clipboard
data class GetCloudServicesNetworkResult(val additionalEgressEndpoints: List<EgressEndpointResponse>? = null, val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val enableDefaultEgressEndpoints: String? = null, val enabledEgressEndpoints: List<EgressEndpointResponse>, val extendedLocation: ExtendedLocationResponse, val hybridAksClustersAssociatedIds: List<String>, val id: String, val interfaceName: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociatedIds: List<String>)

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.

Link copied to clipboard
data class GetClusterManagerResult(val analyticsWorkspaceId: String? = null, val availabilityZones: List<String>? = null, val clusterVersions: List<ClusterAvailableVersionResponse>, val detailedStatus: String, val detailedStatusMessage: String, val fabricControllerId: String, val id: String, val location: String, val managedResourceGroupConfiguration: ManagedResourceGroupConfigurationResponse? = null, val managerExtendedLocation: ExtendedLocationResponse, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmSize: String? = null)
Link copied to clipboard
data class GetClusterResult(val aggregatorOrSingleRackDefinition: RackDefinitionResponse, val analyticsWorkspaceId: String, val availableUpgradeVersions: List<ClusterAvailableUpgradeVersionResponse>, val clusterCapacity: ClusterCapacityResponse, val clusterConnectionStatus: String, val clusterExtendedLocation: ExtendedLocationResponse, val clusterLocation: String? = null, val clusterManagerConnectionStatus: String, val clusterManagerId: String, val clusterServicePrincipal: ServicePrincipalInformationResponse? = null, val clusterType: String, val clusterVersion: String, val computeDeploymentThreshold: ValidationThresholdResponse? = null, val computeRackDefinitions: List<RackDefinitionResponse>? = null, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hybridAksExtendedLocation: ExtendedLocationResponse, val id: String, val location: String, val managedResourceGroupConfiguration: ManagedResourceGroupConfigurationResponse? = null, val manualActionCount: Double, val name: String, val networkFabricId: String, val provisioningState: String, val supportExpiryDate: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val workloadResourceIds: List<String>)
Link copied to clipboard
data class GetConsoleResult(val detailedStatus: String, val detailedStatusMessage: String, val enabled: String, val expiration: String? = null, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val privateLinkServiceId: String, val provisioningState: String, val sshPublicKey: SshPublicKeyResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachineAccessId: String)
Link copied to clipboard
data class GetDefaultCniNetworkResult(val clusterId: String, val cniAsNumber: Double, val cniBgpConfiguration: CniBgpConfigurationResponse? = null, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val fabricBgpPeers: List<BgpPeerResponse>, val hybridAksClustersAssociatedIds: List<String>, val id: String, val interfaceName: String, val ipAllocationType: String? = null, val ipv4ConnectedPrefix: String? = null, val ipv6ConnectedPrefix: String? = null, val l3IsolationDomainId: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vlan: Double)
Link copied to clipboard
data class GetHybridAksClusterResult(val associatedNetworkIds: List<String>, val cloudServicesNetworkId: String, val clusterId: String, val controlPlaneCount: Double, val controlPlaneNodes: List<NodeConfigurationResponse>, val defaultCniNetworkId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hybridAksProvisionedClusterId: String, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val volumes: List<String>, val workerCount: Double, val workerNodes: List<NodeConfigurationResponse>)

The details are specific to the Network Cloud use of the Hybrid AKS cluster.

Link copied to clipboard
data class GetL2NetworkResult(val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hybridAksClustersAssociatedIds: List<String>, val hybridAksPluginType: String? = null, val id: String, val interfaceName: String? = null, val l2IsolationDomainId: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociatedIds: List<String>)
Link copied to clipboard
data class GetL3NetworkResult(val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hybridAksClustersAssociatedIds: List<String>, val hybridAksIpamEnabled: String? = null, val hybridAksPluginType: String? = null, val id: String, val interfaceName: String? = null, val ipAllocationType: String? = null, val ipv4ConnectedPrefix: String? = null, val ipv6ConnectedPrefix: String? = null, val l3IsolationDomainId: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociatedIds: List<String>, val vlan: Double)
Link copied to clipboard
data class GetMetricsConfigurationResult(val collectionInterval: Double, val detailedStatus: String, val detailedStatusMessage: String, val disabledMetrics: List<String>, val enabledMetrics: List<String>? = null, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)
Link copied to clipboard
data class GetRackResult(val availabilityZone: String, val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val provisioningState: String, val rackLocation: String, val rackSerialNumber: String, val rackSkuId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)
Link copied to clipboard
data class GetStorageApplianceResult(val administratorCredentials: AdministrativeCredentialsResponse, val capacity: Double, val capacityUsed: Double, val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val managementIpv4Address: String, val name: String, val provisioningState: String, val rackId: String, val rackSlot: Double, val remoteVendorManagementFeature: String, val remoteVendorManagementStatus: String, val serialNumber: String, val storageApplianceSkuId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)
Link copied to clipboard
data class GetTrunkedNetworkResult(val clusterId: String, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val hybridAksClustersAssociatedIds: List<String>, val hybridAksPluginType: String? = null, val id: String, val interfaceName: String? = null, val isolationDomainIds: List<String>, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachinesAssociatedIds: List<String>, val vlans: List<Double>)
Link copied to clipboard
data class GetVirtualMachineResult(val adminUsername: String, val bareMetalMachineId: String, val bootMethod: String? = null, val cloudServicesNetworkAttachment: NetworkAttachmentResponse, val clusterId: String, val cpuCores: Double, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val id: String, val isolateEmulatorThread: String? = null, val location: String, val memorySizeGB: Double, val name: String, val networkAttachments: List<NetworkAttachmentResponse>? = null, val networkData: String? = null, val placementHints: List<VirtualMachinePlacementHintResponse>? = null, val powerState: String, val provisioningState: String, val sshPublicKeys: List<SshPublicKeyResponse>? = null, val storageProfile: StorageProfileResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userData: String? = null, val virtioInterface: String? = null, val vmDeviceModel: String? = null, val vmImage: String, val vmImageRepositoryCredentials: ImageRepositoryCredentialsResponse? = null, val volumes: List<String>)
Link copied to clipboard
data class GetVolumeResult(val attachedTo: List<String>, val detailedStatus: String, val detailedStatusMessage: String, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val provisioningState: String, val serialNumber: String, val sizeMiB: Double, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)
data class HardwareInventoryNetworkInterfaceResponse(val linkStatus: String, val macAddress: String, val name: String, val networkInterfaceId: String)
Link copied to clipboard
data class HardwareInventoryResponse(val additionalHostInformation: String, val interfaces: List<HardwareInventoryNetworkInterfaceResponse>, val nics: List<NicResponse>)
Link copied to clipboard
data class HardwareValidationStatusResponse(val lastValidationTime: String, val result: String)
Link copied to clipboard
data class ImageRepositoryCredentialsResponse(val password: String, val registryUrl: String, val username: String)
Link copied to clipboard
data class KeySetUserResponse(val azureUserName: String, val description: String? = null, val sshPublicKey: SshPublicKeyResponse)
Link copied to clipboard
data class KeySetUserStatusResponse(val azureUserName: String, val status: String, val statusMessage: String)
Link copied to clipboard
data class LldpNeighborResponse(val portDescription: String, val portName: String, val systemDescription: String, val systemName: String)
data class ManagedResourceGroupConfigurationResponse(val location: String? = null, val name: String? = null)
Link copied to clipboard
data class NetworkAttachmentResponse(val attachedNetworkId: String, val defaultGateway: String? = null, val ipAllocationMethod: String, val ipv4Address: String? = null, val ipv6Address: String? = null, val macAddress: String, val networkAttachmentName: String? = null)
Link copied to clipboard
data class NicResponse(val lldpNeighbor: LldpNeighborResponse, val macAddress: String, val name: String)
Link copied to clipboard
data class NodeConfigurationResponse(val agentPoolId: String, val agentPoolName: String, val cpuCores: Double, val diskSizeGB: Double, val memorySizeGB: Double, val nodePoolName: String, val nodes: List<NodeResponse>, val vmCount: Double, val vmSize: String)
Link copied to clipboard
data class NodeResponse(val bareMetalMachineId: String, val imageId: String, val networkAttachments: List<NetworkAttachmentResponse>, val nodeName: String, val powerState: String)
Link copied to clipboard
data class OsDiskResponse(val createOption: String? = null, val deleteOption: String? = null, val diskSizeGB: Double)
Link copied to clipboard
data class RackDefinitionResponse(val availabilityZone: String? = null, val bareMetalMachineConfigurationData: List<BareMetalMachineConfigurationDataResponse>? = null, val networkRackId: String, val rackLocation: String? = null, val rackSerialNumber: String, val rackSkuId: String, val storageApplianceConfigurationData: List<StorageApplianceConfigurationDataResponse>? = null)
Link copied to clipboard
data class ServicePrincipalInformationResponse(val applicationId: String, val password: String, val principalId: String, val tenantId: String)
Link copied to clipboard
data class SshPublicKeyResponse(val keyData: String)
data class StorageApplianceConfigurationDataResponse(val adminCredentials: AdministrativeCredentialsResponse, val rackSlot: Double, val serialNumber: String, val storageApplianceName: String? = null)
Link copied to clipboard
data class StorageProfileResponse(val osDisk: OsDiskResponse, val volumeAttachments: List<String>? = null)
Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class ValidationThresholdResponse(val grouping: String, val type: String, val value: Double)
Link copied to clipboard
data class VirtualMachinePlacementHintResponse(val hintType: String, val resourceId: String, val schedulingExecution: String, val scope: String)