Package-level declarations

Types

Link copied to clipboard
data class AdapterPropertyOverridesResponse(val jumboPacket: String? = null, val networkDirect: String? = null, val networkDirectTechnology: String? = null)

The AdapterPropertyOverrides of a cluster.

Link copied to clipboard
data class ArcConnectivityPropertiesResponse(val enabled: Boolean? = null)

Connectivity related configuration required by arc server.

Link copied to clipboard
data class ClusterDesiredPropertiesResponse(val diagnosticLevel: String? = null, val windowsServerSubscription: String? = null)

Desired properties of the cluster.

Link copied to clipboard
data class ClusterNodeResponse(val coreCount: Double, val ehcResourceId: String, val id: Double, val lastLicensingTimestamp: String, val manufacturer: String, val memoryInGiB: Double, val model: String, val name: String, val nodeType: String, val osDisplayVersion: String, val osName: String, val osVersion: String, val serialNumber: String, val windowsServerSubscription: String)

Cluster node details.

Link copied to clipboard
data class ClusterReportedPropertiesResponse(val clusterId: String, val clusterName: String, val clusterType: String, val clusterVersion: String, val diagnosticLevel: String? = null, val imdsAttestation: String, val lastUpdated: String, val manufacturer: String, val nodes: List<ClusterNodeResponse>, val supportedCapabilities: List<String>)

Properties reported by cluster agent.

Link copied to clipboard
data class ClusterResponse(val azureServiceEndpoint: String? = null, val cloudAccountName: String? = null, val name: String? = null, val witnessPath: String? = null, val witnessType: String? = null)

AzureStackHCI Cluster deployment properties.

Link copied to clipboard
data class DefaultExtensionDetailsResponse(val category: String, val consentTime: String)

Properties for a particular default extension category.

Link copied to clipboard
data class DeploymentConfigurationResponse(val scaleUnits: List<ScaleUnitsResponse>, val version: String? = null)

Deployment Configuration

Link copied to clipboard
data class DeploymentDataResponse(val adouPath: String? = null, val cluster: ClusterResponse? = null, val domainFqdn: String? = null, val hostNetwork: HostNetworkResponse? = null, val infrastructureNetwork: List<InfrastructureNetworkResponse>? = null, val namingPrefix: String? = null, val observability: ObservabilityResponse? = null, val optionalServices: OptionalServicesResponse? = null, val physicalNodes: List<PhysicalNodesResponse>? = null, val secretsLocation: String? = null, val securitySettings: SecuritySettingsResponse? = null, val storage: StorageResponse? = null)

The Deployment data of AzureStackHCI Cluster.

Link copied to clipboard
data class DeploymentStatusResponse(val status: String, val steps: List<StepResponse>)

The DeploymentStatus of AzureStackHCI Cluster.

Link copied to clipboard
data class DeploymentStepResponse(val description: String, val endTimeUtc: String, val exception: List<String>, val fullStepIndex: String, val name: String, val startTimeUtc: String, val status: String, val steps: List<DeploymentStepResponse>)

The Step of AzureStackHCI Cluster.

Link copied to clipboard
data class DeviceConfigurationResponse(val deviceMetadata: String? = null, val nicDetails: List<NicDetailResponse>)

The device Configuration of a device.

Link copied to clipboard
data class EceActionStatusResponse(val status: String, val steps: List<DeploymentStepResponse>)

The ECE action plan deployment status for AzureStackHCI Cluster.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class ExtendedLocationResponse(val name: String? = null, val type: String? = null)

The complex type of the extended location.

Link copied to clipboard
data class ExtensionInstanceViewResponse(val name: String? = null, val status: ExtensionInstanceViewResponseStatus? = null, val type: String? = null, val typeHandlerVersion: String? = null)

Describes the Extension Instance View.

Link copied to clipboard
data class ExtensionInstanceViewResponseStatus(val code: String? = null, val displayStatus: String? = null, val level: String? = null, val message: String? = null, val time: String? = null)

Instance view status.

Link copied to clipboard
data class GalleryImageIdentifierResponse(val offer: String, val publisher: String, val sku: String)

This is the gallery image definition identifier.

Link copied to clipboard
data class GalleryImageStatusResponse(val downloadStatus: GalleryImageStatusResponseDownloadStatus? = null, val errorCode: String? = null, val errorMessage: String? = null, val progressPercentage: Double? = null, val provisioningStatus: GalleryImageStatusResponseProvisioningStatus? = null)

The observed state of gallery images

Link copied to clipboard
data class GalleryImageStatusResponseDownloadStatus(val downloadSizeInMB: Double? = null)

The download status of the gallery image

data class GalleryImageStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
Link copied to clipboard
data class GalleryImageVersionResponse(val name: String? = null, val storageProfile: GalleryImageVersionStorageProfileResponse)

Specifies information about the gallery image version that you want to create or update.

This is the storage profile of a Gallery Image Version.

Link copied to clipboard
data class GalleryOSDiskImageResponse(val sizeInMB: Double)

This is the OS disk image.

Link copied to clipboard
data class GetArcSettingResult(val aggregateState: String, val arcApplicationClientId: String? = null, val arcApplicationObjectId: String? = null, val arcApplicationTenantId: String? = null, val arcInstanceResourceGroup: String? = null, val arcServicePrincipalObjectId: String? = null, val connectivityProperties: List<ArcConnectivityPropertiesResponse>? = null, val defaultExtensions: List<DefaultExtensionDetailsResponse>, val id: String, val name: String, val perNodeDetails: List<PerNodeStateResponse>, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

ArcSetting details.

Link copied to clipboard
data class GetClusterResult(val aadApplicationObjectId: String? = null, val aadClientId: String? = null, val aadServicePrincipalObjectId: String? = null, val aadTenantId: String? = null, val billingModel: String, val cloudId: String, val cloudManagementEndpoint: String? = null, val desiredProperties: ClusterDesiredPropertiesResponse? = null, val id: String, val lastBillingTimestamp: String, val lastSyncTimestamp: String, val location: String, val name: String, val principalId: String, val provisioningState: String, val registrationTimestamp: String, val reportedProperties: ClusterReportedPropertiesResponse, val resourceProviderObjectId: String, val serviceEndpoint: String, val softwareAssuranceProperties: SoftwareAssurancePropertiesResponse? = null, val status: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tenantId: String, val trialDaysRemaining: Double, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Cluster details.

Link copied to clipboard
data class GetDeploymentSettingResult(val arcNodeResourceIds: List<String>, val deploymentConfiguration: DeploymentConfigurationResponse, val deploymentMode: String, val id: String, val name: String, val provisioningState: String, val reportedProperties: ReportedPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Edge device resource

Link copied to clipboard
data class GetEdgeDeviceResult(val deviceConfiguration: DeviceConfigurationResponse, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Edge device resource

Link copied to clipboard
data class GetExtensionResult(val aggregateState: String, val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val managedBy: String, val name: String, val perNodeExtensionDetails: List<PerNodeExtensionStateResponse>, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val systemData: SystemDataResponse, val type: String, val typeHandlerVersion: String? = null)

Details of a particular extension in HCI Cluster.

Link copied to clipboard
data class GetGalleryImageResult(val cloudInitDataSource: String? = null, val containerName: String? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val identifier: GalleryImageIdentifierResponse? = null, val imagePath: String? = null, val location: String, val name: String, val osType: String? = null, val provisioningState: String, val status: GalleryImageStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val version: GalleryImageVersionResponse? = null)

The gallery images resource definition.

Link copied to clipboard
data class GetGuestAgentResult(val credentials: GuestCredentialResponse? = null, val httpProxyConfig: HttpProxyConfigurationResponse? = null, val id: String, val name: String, val provisioningAction: String? = null, val provisioningState: String, val status: String, val systemData: SystemDataResponse, val type: String)

Defines the GuestAgent.

Link copied to clipboard
data class GetHciEdgeDeviceJobResult(val id: String, val kind: String, val name: String, val properties: Either<HciCollectLogJobPropertiesResponse, HciRemoteSupportJobPropertiesResponse>, val systemData: SystemDataResponse, val type: String)

Edge device job for Azure Stack HCI solution.

Link copied to clipboard
data class GetHybridIdentityMetadatumResult(val id: String, val identity: IdentityResponse, val name: String, val provisioningState: String, val publicKey: String? = null, val resourceUid: String? = null, val systemData: SystemDataResponse, val type: String)

Defines the HybridIdentityMetadata.

Link copied to clipboard
data class GetLogicalNetworkResult(val dhcpOptions: LogicalNetworkPropertiesResponseDhcpOptions? = null, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val provisioningState: String, val status: LogicalNetworkStatusResponse, val subnets: List<SubnetResponse>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmSwitchName: String? = null)

The logical network resource definition.

Link copied to clipboard
data class GetMachineExtensionResult(val autoUpgradeMinorVersion: Boolean? = null, val forceUpdateTag: String? = null, val id: String, val instanceView: MachineExtensionPropertiesResponseInstanceView? = null, val location: String? = null, val name: String, val protectedSettings: Any? = null, val provisioningState: String, val publisher: String? = null, val settings: Any? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val typeHandlerVersion: String? = null)

Describes a Machine Extension.

Link copied to clipboard
data class GetMarketplaceGalleryImageResult(val cloudInitDataSource: String? = null, val containerName: String? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val identifier: GalleryImageIdentifierResponse? = null, val location: String, val name: String, val osType: String? = null, val provisioningState: String, val status: MarketplaceGalleryImageStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val version: GalleryImageVersionResponse? = null)

The marketplace gallery image resource definition.

Link copied to clipboard
data class GetNetworkInterfaceResult(val dnsSettings: InterfaceDNSSettingsResponse? = null, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val ipConfigurations: List<IPConfigurationResponse>? = null, val location: String, val macAddress: String? = null, val name: String, val provisioningState: String, val status: NetworkInterfaceStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The network interface resource definition.

Link copied to clipboard
data class GetNetworkSecurityGroupResult(val eTag: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val networkInterfaces: List<NetworkInterfaceArmReferenceResponse>, val provisioningState: String, val subnets: List<LogicalNetworkArmReferenceResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

NetworkSecurityGroup resource.

Link copied to clipboard
data class GetSecurityRuleResult(val access: String, val description: String? = null, val destinationAddressPrefixes: List<String>? = null, val destinationPortRanges: List<String>? = null, val direction: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val name: String, val priority: Int, val protocol: String, val provisioningState: String, val sourceAddressPrefixes: List<String>? = null, val sourcePortRanges: List<String>? = null, val systemData: SystemDataResponse, val type: String)

Security Rule resource.

Link copied to clipboard
data class GetSecuritySettingResult(val id: String, val name: String, val provisioningState: String, val securedCoreComplianceAssignment: String? = null, val securityComplianceStatus: SecurityComplianceStatusResponse, val systemData: SystemDataResponse, val type: String)

Security settings proxy resource

Link copied to clipboard
data class GetStorageContainerResult(val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val path: String? = null, val provisioningState: String, val status: StorageContainerStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The storage container resource definition.

Link copied to clipboard
data class GetUpdateResult(val additionalProperties: String? = null, val availabilityType: String? = null, val description: String? = null, val displayName: String? = null, val healthCheckDate: String? = null, val id: String, val installedDate: String? = null, val location: String? = null, val name: String, val notifyMessage: String? = null, val packagePath: String? = null, val packageSizeInMb: Double? = null, val packageType: String? = null, val prerequisites: List<UpdatePrerequisiteResponse>? = null, val progressPercentage: Double? = null, val provisioningState: String, val publisher: String? = null, val releaseLink: String? = null, val state: String? = null, val systemData: SystemDataResponse, val type: String, val version: String? = null)

Update details

Link copied to clipboard
data class GetUpdateRunResult(val description: String? = null, val duration: String? = null, val endTimeUtc: String? = null, val errorMessage: String? = null, val id: String, val lastUpdatedTime: String? = null, val lastUpdatedTimeUtc: String? = null, val location: String? = null, val name: String, val provisioningState: String, val startTimeUtc: String? = null, val state: String? = null, val status: String? = null, val steps: List<StepResponse>? = null, val systemData: SystemDataResponse, val timeStarted: String? = null, val type: String)

Details of an Update run

Link copied to clipboard
data class GetUpdateSummaryResult(val currentVersion: String? = null, val hardwareModel: String? = null, val healthCheckDate: String? = null, val id: String, val lastChecked: String? = null, val lastUpdated: String? = null, val location: String? = null, val name: String, val oemFamily: String? = null, val provisioningState: String, val state: String? = null, val systemData: SystemDataResponse, val type: String)

Get the update summaries for the cluster

Link copied to clipboard
data class GetVirtualHardDiskResult(val blockSizeBytes: Int? = null, val containerId: String? = null, val diskFileFormat: String? = null, val diskSizeGB: Double? = null, val dynamic: Boolean? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val location: String, val logicalSectorBytes: Int? = null, val name: String, val physicalSectorBytes: Int? = null, val provisioningState: String, val status: VirtualHardDiskStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The virtual hard disk resource definition.

Link copied to clipboard
data class GetVirtualMachineInstanceResult(val extendedLocation: ExtendedLocationResponse? = null, val guestAgentInstallStatus: GuestAgentInstallStatusResponse? = null, val hardwareProfile: VirtualMachineInstancePropertiesResponseHardwareProfile? = null, val id: String, val identity: IdentityResponse? = null, val instanceView: VirtualMachineInstanceViewResponse, val name: String, val networkProfile: VirtualMachineInstancePropertiesResponseNetworkProfile? = null, val osProfile: VirtualMachineInstancePropertiesResponseOsProfile? = null, val provisioningState: String, val resourceUid: String? = null, val securityProfile: VirtualMachineInstancePropertiesResponseSecurityProfile? = null, val status: VirtualMachineInstanceStatusResponse, val storageProfile: VirtualMachineInstancePropertiesResponseStorageProfile? = null, val systemData: SystemDataResponse, val type: String, val vmId: String)

The virtual machine instance resource definition.

Link copied to clipboard
data class GetVirtualMachineResult(val extendedLocation: ExtendedLocationResponse? = null, val guestAgentProfile: GuestAgentProfileResponse? = null, val hardwareProfile: VirtualMachinePropertiesResponseHardwareProfile? = null, val id: String, val identity: IdentityResponse? = null, val location: String, val name: String, val networkProfile: VirtualMachinePropertiesResponseNetworkProfile? = null, val osProfile: VirtualMachinePropertiesResponseOsProfile? = null, val provisioningState: String, val securityProfile: VirtualMachinePropertiesResponseSecurityProfile? = null, val status: VirtualMachineStatusResponse, val storageProfile: VirtualMachinePropertiesResponseStorageProfile? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmId: String)

The virtual machine resource definition.

Link copied to clipboard
data class GetVirtualNetworkResult(val dhcpOptions: VirtualNetworkPropertiesResponseDhcpOptions? = null, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val networkType: String? = null, val provisioningState: String, val status: VirtualNetworkStatusResponse, val subnets: List<VirtualNetworkPropertiesResponseSubnets>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmSwitchName: String? = null)

The virtual network resource definition.

Link copied to clipboard
data class GuestAgentInstallStatusResponse(val agentVersion: String, val errorDetails: List<ErrorDetailResponse>, val lastStatusChange: String, val status: String, val vmUuid: String)

Defines the status of a guest agent installation.

Link copied to clipboard
data class GuestAgentProfileResponse(val agentVersion: String, val errorDetails: List<ErrorDetailResponse>, val lastStatusChange: String, val status: String, val vmUuid: String)

Defines the resource properties.

Link copied to clipboard
data class GuestCredentialResponse(val username: String? = null)

Username / Password Credentials to connect to guest.

Link copied to clipboard
data class HciCollectLogJobPropertiesResponse(val deploymentMode: String? = null, val endTimeUtc: String, val fromDate: String, val jobId: String, val jobType: String, val lastLogGenerated: String, val provisioningState: String, val reportedProperties: LogCollectionReportedPropertiesResponse, val startTimeUtc: String, val status: String, val toDate: String)

Represents the properties of an HCI Collect Log job.

Link copied to clipboard
data class HciRemoteSupportJobPropertiesResponse(val accessLevel: String, val deploymentMode: String? = null, val endTimeUtc: String, val expirationTimestamp: String, val jobId: String, val jobType: String, val provisioningState: String, val reportedProperties: RemoteSupportJobReportedPropertiesResponse, val startTimeUtc: String, val status: String, val type: String)

Represents the properties of a remote support job for HCI.

Link copied to clipboard
data class HostNetworkResponse(val enableStorageAutoIp: Boolean? = null, val intents: List<IntentsResponse>? = null, val storageConnectivitySwitchless: Boolean? = null, val storageNetworks: List<StorageNetworksResponse>? = null)

The HostNetwork of a cluster.

Link copied to clipboard
data class HttpProxyConfigurationResponse(val httpsProxy: String? = null)

HTTP Proxy configuration for the VM.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Identity for the resource.

Link copied to clipboard
data class InfrastructureNetworkResponse(val dnsServers: List<String>? = null, val gateway: String? = null, val ipPools: List<IpPoolsResponse>? = null, val subnetMask: String? = null, val useDhcp: Boolean? = null)

The InfrastructureNetwork of a AzureStackHCI Cluster.

Link copied to clipboard
data class InstanceViewStatusResponse(val code: String? = null, val displayStatus: String? = null, val level: String? = null, val message: String? = null, val time: String? = null)

Instance view status.

Link copied to clipboard
data class IntentsResponse(val adapter: List<String>? = null, val adapterPropertyOverrides: AdapterPropertyOverridesResponse? = null, val name: String? = null, val overrideAdapterProperty: Boolean? = null, val overrideQosPolicy: Boolean? = null, val overrideVirtualSwitchConfiguration: Boolean? = null, val qosPolicyOverrides: QosPolicyOverridesResponse? = null, val trafficType: List<String>? = null, val virtualSwitchConfigurationOverrides: VirtualSwitchConfigurationOverridesResponse? = null)

The Intents of a cluster.

Link copied to clipboard
data class InterfaceDNSSettingsResponse(val dnsServers: List<String>? = null)
Link copied to clipboard
data class IPConfigurationResponse(val name: String? = null, val properties: IPConfigurationResponseProperties? = null)

InterfaceIPConfiguration iPConfiguration in a network interface.

Link copied to clipboard
data class IPConfigurationResponseProperties(val prefixLength: String? = null, val privateIPAddress: String? = null, val privateIPAllocationMethod: String? = null, val subnet: IPConfigurationResponseSubnet? = null)

InterfaceIPConfigurationPropertiesFormat properties of IP configuration.

Link copied to clipboard
data class IPConfigurationResponseSubnet(val id: String? = null)

Subnet - Name of Subnet bound to the IP configuration.

Link copied to clipboard
data class IPPoolInfoResponse(val available: String, val used: String)
Link copied to clipboard
data class IPPoolResponse(val end: String? = null, val info: IPPoolInfoResponse? = null, val ipPoolType: String? = null, val name: String? = null, val start: String? = null)
Link copied to clipboard
data class IpPoolsResponse(val endingAddress: String? = null, val startingAddress: String? = null)

The dnsServers of a device.

Link copied to clipboard
data class LogCollectionJobSessionResponse(val correlationId: String, val endTime: String, val logSize: Int, val startTime: String, val status: String, val timeCollected: String)

Represents a session for collecting logs from an edge device.

Link copied to clipboard
data class LogCollectionReportedPropertiesResponse(val deploymentStatus: EceActionStatusResponse, val logCollectionSessionDetails: List<LogCollectionJobSessionResponse>, val percentComplete: Int, val validationStatus: EceActionStatusResponse)

Represents the reported properties of a log collection job.

Link copied to clipboard
data class LogicalNetworkArmReferenceResponse(val id: String? = null)

The ARM ID for a Logical Network.

data class LogicalNetworkPropertiesResponseDhcpOptions(val dnsServers: List<String>? = null)

DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.

Link copied to clipboard
data class LogicalNetworkStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val provisioningStatus: LogicalNetworkStatusResponseProvisioningStatus? = null)

The observed state of logical networks

data class LogicalNetworkStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
data class MachineExtensionInstanceViewResponseStatus(val code: String, val displayStatus: String, val level: String, val message: String, val time: String)

Instance view status.

data class MachineExtensionPropertiesResponseInstanceView(val name: String, val status: MachineExtensionInstanceViewResponseStatus? = null, val type: String, val typeHandlerVersion: String)

The machine extension instance view.

Link copied to clipboard
data class MarketplaceGalleryImageStatusResponse(val downloadStatus: MarketplaceGalleryImageStatusResponseDownloadStatus? = null, val errorCode: String? = null, val errorMessage: String? = null, val progressPercentage: Double? = null, val provisioningStatus: MarketplaceGalleryImageStatusResponseProvisioningStatus? = null)

The observed state of marketplace gallery images

data class MarketplaceGalleryImageStatusResponseDownloadStatus(val downloadSizeInMB: Double? = null)

The download status of the gallery image

data class MarketplaceGalleryImageStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
Link copied to clipboard
data class NetworkInterfaceArmReferenceResponse(val id: String? = null)

The ARM ID for a Network Interface.

Link copied to clipboard
data class NetworkInterfaceStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val provisioningStatus: NetworkInterfaceStatusResponseProvisioningStatus? = null)

The observed state of network interfaces

data class NetworkInterfaceStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
Link copied to clipboard
data class NicDetailResponse(val adapterName: String, val componentId: String? = null, val defaultGateway: String? = null, val defaultIsolationId: String? = null, val dnsServers: List<String>? = null, val driverVersion: String? = null, val interfaceDescription: String? = null, val ip4Address: String? = null, val subnetMask: String? = null)

The NIC Detail of a device.

Link copied to clipboard
data class ObservabilityResponse(val episodicDataUpload: Boolean? = null, val euLocation: Boolean? = null, val streamingDataClient: Boolean? = null)

The Observability of AzureStackHCI Cluster.

Link copied to clipboard
data class OptionalServicesResponse(val customLocation: String? = null)

The OptionalServices of AzureStackHCI Cluster.

Link copied to clipboard
data class PerNodeExtensionStateResponse(val extension: String, val instanceView: ExtensionInstanceViewResponse, val name: String, val state: String, val typeHandlerVersion: String)

Status of Arc Extension for a particular node in HCI Cluster.

Link copied to clipboard
data class PerNodeStateResponse(val arcInstance: String, val name: String, val state: String)

Status of Arc agent for a particular node in HCI Cluster.

Link copied to clipboard
data class PhysicalNodesResponse(val ipv4Address: String? = null, val name: String? = null)

The PhysicalNodes of a cluster.

Link copied to clipboard
data class QosPolicyOverridesResponse(val bandwidthPercentageSMB: String? = null, val priorityValue8021ActionCluster: String? = null, val priorityValue8021ActionSMB: String? = null)

The QoSPolicyOverrides of a cluster.

Link copied to clipboard
data class RemoteSupportJobNodeSettingsResponse(val connectionErrorMessage: String, val connectionStatus: String, val createdAt: String, val state: String, val updatedAt: String)

Represents the settings of a remote support node.

data class RemoteSupportJobReportedPropertiesResponse(val deploymentStatus: EceActionStatusResponse, val nodeSettings: RemoteSupportJobNodeSettingsResponse, val percentComplete: Int, val sessionDetails: List<RemoteSupportSessionResponse>, val validationStatus: EceActionStatusResponse)

Represents the reported properties of a remote support job.

Link copied to clipboard
data class RemoteSupportSessionResponse(val accessLevel: String, val sessionEndTime: String, val sessionId: String, val sessionStartTime: String, val transcriptLocation: String)

Represents a remote support session.

Link copied to clipboard
data class ReportedPropertiesResponse(val deploymentStatus: DeploymentStatusResponse, val validationStatus: ValidationStatusResponse)

The DeploymentStatus of AzureStackHCI Cluster.

Link copied to clipboard
data class RouteResponse(val addressPrefix: String? = null, val name: String? = null, val nextHopIpAddress: String? = null)

Route - Route resource.

Link copied to clipboard
data class RouteTableResponse(val etag: String, val name: String, val routes: List<RouteResponse>? = null, val type: String)

Route table resource.

Link copied to clipboard
data class ScaleUnitsResponse(val deploymentData: DeploymentDataResponse)

Scale units will contains list of deployment data

Link copied to clipboard
data class SecurityComplianceStatusResponse(val dataAtRestEncrypted: String, val dataInTransitProtected: String, val lastUpdated: String, val securedCoreCompliance: String, val wdacCompliance: String)

Security compliance properties of the resource

Link copied to clipboard
data class SecuritySettingsResponse(val bitlockerBootVolume: Boolean? = null, val bitlockerDataVolumes: Boolean? = null, val credentialGuardEnforced: Boolean? = null, val driftControlEnforced: Boolean? = null, val drtmProtection: Boolean? = null, val hvciProtection: Boolean? = null, val sideChannelMitigationEnforced: Boolean? = null, val smbClusterEncryption: Boolean? = null, val smbSigningEnforced: Boolean? = null, val wdacEnforced: Boolean? = null)

The SecuritySettings of AzureStackHCI Cluster.

Link copied to clipboard
data class SoftwareAssurancePropertiesResponse(val lastUpdated: String, val softwareAssuranceIntent: String? = null, val softwareAssuranceStatus: String? = null)

Software Assurance properties of the cluster.

Link copied to clipboard
data class SshConfigurationResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

SSH configuration for Linux based VMs running on Azure

Link copied to clipboard
data class SshPublicKeyResponse(val keyData: String? = null, val path: String? = null)

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Link copied to clipboard
data class StepResponse(val description: String? = null, val endTimeUtc: String? = null, val errorMessage: String? = null, val exception: List<String>? = null, val fullStepIndex: String? = null, val lastUpdatedTimeUtc: String? = null, val name: String? = null, val startTimeUtc: String? = null, val status: String? = null, val steps: List<StepResponse>? = null)

Progress representation of the update run steps.

Link copied to clipboard
data class StorageContainerStatusResponse(val availableSizeMB: Double? = null, val containerSizeMB: Double? = null, val errorCode: String? = null, val errorMessage: String? = null, val provisioningStatus: StorageContainerStatusResponseProvisioningStatus? = null)

The observed state of storage containers

data class StorageContainerStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
Link copied to clipboard
data class StorageNetworksResponse(val name: String? = null, val networkAdapterName: String? = null, val vlanId: String? = null)

The StorageNetworks of a cluster.

Link copied to clipboard
data class StorageResponse(val configurationMode: String? = null)

The Storage config of AzureStackHCI Cluster.

IPConfigurationReference - Describes a IPConfiguration under the virtual network

Link copied to clipboard
data class SubnetResponse(val addressPrefix: String? = null, val addressPrefixes: List<String>? = null, val ipAllocationMethod: String? = null, val ipConfigurationReferences: List<SubnetPropertiesFormatResponseIpConfigurationReferences>? = null, val ipPools: List<IPPoolResponse>? = null, val name: String? = null, val routeTable: RouteTableResponse? = null, val vlan: Int? = 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 UpdatePrerequisiteResponse(val packageName: String? = null, val updateType: String? = null, val version: String? = null)

If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class ValidationStatusResponse(val status: String, val steps: List<StepResponse>)

The ValidationStatus of AzureStackHCI Cluster.

Link copied to clipboard
data class VirtualHardDiskStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val provisioningStatus: VirtualHardDiskStatusResponseProvisioningStatus? = null)

The observed state of virtual hard disks

data class VirtualHardDiskStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
data class VirtualMachineInstancePropertiesResponseDynamicMemoryConfig(val maximumMemoryMB: Double? = null, val minimumMemoryMB: Double? = null, val targetMemoryBuffer: Int? = null)
data class VirtualMachineInstancePropertiesResponseHardwareProfile(val dynamicMemoryConfig: VirtualMachineInstancePropertiesResponseDynamicMemoryConfig? = null, val memoryMB: Double? = null, val processors: Int? = null, val vmSize: String? = null)

HardwareProfile - Specifies the hardware settings for the virtual machine instance.

Which Image to use for the virtual machine instance

data class VirtualMachineInstancePropertiesResponseLinuxConfiguration(val disablePasswordAuthentication: Boolean? = null, val provisionVMAgent: Boolean? = null, val provisionVMConfigAgent: Boolean? = null, val ssh: SshConfigurationResponse? = null)

LinuxConfiguration - linux specific configuration values for the virtual machine instance

NetworkProfile - describes the network configuration the virtual machine instance

data class VirtualMachineInstancePropertiesResponseOsDisk(val id: String? = null, val osType: String? = null)

VHD to attach as OS disk

data class VirtualMachineInstancePropertiesResponseOsProfile(val adminUsername: String? = null, val computerName: String? = null, val linuxConfiguration: VirtualMachineInstancePropertiesResponseLinuxConfiguration? = null, val windowsConfiguration: VirtualMachineInstancePropertiesResponseWindowsConfiguration? = null)

OsProfile - describes the configuration of the operating system and sets login data

data class VirtualMachineInstancePropertiesResponseSecurityProfile(val enableTPM: Boolean? = null, val securityType: String? = null, val uefiSettings: VirtualMachineInstancePropertiesResponseUefiSettings? = null)

SecurityProfile - Specifies the security settings for the virtual machine instance.

StorageProfile - contains information about the disks and storage information for the virtual machine instance

data class VirtualMachineInstancePropertiesResponseWindowsConfiguration(val enableAutomaticUpdates: Boolean? = null, val provisionVMAgent: Boolean? = null, val provisionVMConfigAgent: Boolean? = null, val ssh: SshConfigurationResponse? = null, val timeZone: String? = null)

Windows Configuration for the virtual machine instance

Link copied to clipboard
data class VirtualMachineInstanceStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val powerState: String? = null, val provisioningStatus: VirtualMachineInstanceStatusResponseProvisioningStatus? = null)

The observed state of virtual machine instances

data class VirtualMachineInstanceStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
Link copied to clipboard

The instance view of a virtual machine.

data class VirtualMachinePropertiesResponseDynamicMemoryConfig(val maximumMemoryMB: Double? = null, val minimumMemoryMB: Double? = null, val targetMemoryBuffer: Int? = null)
data class VirtualMachinePropertiesResponseHardwareProfile(val dynamicMemoryConfig: VirtualMachinePropertiesResponseDynamicMemoryConfig? = null, val memoryMB: Double? = null, val processors: Int? = null, val vmSize: String? = null)

HardwareProfile - Specifies the hardware settings for the virtual machine.

Which Image to use for the virtual machine

data class VirtualMachinePropertiesResponseLinuxConfiguration(val disablePasswordAuthentication: Boolean? = null, val provisionVMAgent: Boolean? = null, val ssh: VirtualMachinePropertiesResponseSsh? = null)

LinuxConfiguration - linux specific configuration values for the virtual machine

NetworkProfile - describes the network configuration the virtual machine

Link copied to clipboard

VHD to attach as OS disk

data class VirtualMachinePropertiesResponseOsProfile(val adminUsername: String? = null, val computerName: String? = null, val linuxConfiguration: VirtualMachinePropertiesResponseLinuxConfiguration? = null, val osType: String? = null, val windowsConfiguration: VirtualMachinePropertiesResponseWindowsConfiguration? = null)

OsProfile - describes the configuration of the operating system and sets login data

data class VirtualMachinePropertiesResponsePublicKeys(val keyData: String? = null, val path: String? = null)
data class VirtualMachinePropertiesResponsePublicKeysPublicKeys(val keyData: String? = null, val path: String? = null)

SecurityProfile - Specifies the security settings for the virtual machine.

Link copied to clipboard

SSH - contains settings related to ssh configuration

data class VirtualMachinePropertiesResponseStorageProfile(val dataDisks: List<VirtualMachinePropertiesResponseDataDisks>? = null, val imageReference: VirtualMachinePropertiesResponseImageReference? = null, val osDisk: VirtualMachinePropertiesResponseOsDisk? = null, val vmConfigStoragePathId: String? = null)

StorageProfile - contains information about the disks and storage information for the virtual machine

data class VirtualMachinePropertiesResponseUefiSettings(val secureBootEnabled: Boolean? = null)
data class VirtualMachinePropertiesResponseWindowsConfiguration(val enableAutomaticUpdates: Boolean? = null, val provisionVMAgent: Boolean? = null, val ssh: VirtualMachinePropertiesResponseSshSsh? = null, val timeZone: String? = null)

Windows Configuration for the virtual machine

Link copied to clipboard
data class VirtualMachineStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val powerState: String? = null, val provisioningStatus: VirtualMachineStatusResponseProvisioningStatus? = null)

The observed state of virtual machines

data class VirtualMachineStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
data class VirtualMachineVMConfigAgentInstanceViewResponse(val statuses: List<InstanceViewStatusResponse>? = null, val vmVMConfigAgentVersion: String? = null)

The instance view of the VM Config Agent running on the virtual machine.

data class VirtualNetworkPropertiesResponseDhcpOptions(val dnsServers: List<String>? = null)

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

IPConfigurationReference - Describes a IPConfiguration under the virtual network

Link copied to clipboard
data class VirtualNetworkPropertiesResponseRoutes(val addressPrefix: String? = null, val name: String? = null, val nextHopIpAddress: String? = null)

Route is associated with a subnet.

data class VirtualNetworkPropertiesResponseRouteTable(val id: String? = null, val name: String? = null, val routes: List<VirtualNetworkPropertiesResponseRoutes>? = null, val type: String? = null)

RouteTable for the subnet

Link copied to clipboard
data class VirtualNetworkPropertiesResponseSubnets(val addressPrefix: String? = null, val addressPrefixes: List<String>? = null, val ipAllocationMethod: String? = null, val ipConfigurationReferences: List<VirtualNetworkPropertiesResponseIpConfigurationReferences>? = null, val ipPools: List<IPPoolResponse>? = null, val name: String? = null, val routeTable: VirtualNetworkPropertiesResponseRouteTable? = null, val vlan: Int? = null)

Subnet subnet in a virtual network resource.

Link copied to clipboard
data class VirtualNetworkStatusResponse(val errorCode: String? = null, val errorMessage: String? = null, val provisioningStatus: VirtualNetworkStatusResponseProvisioningStatus? = null)

The observed state of virtual networks

data class VirtualNetworkStatusResponseProvisioningStatus(val operationId: String? = null, val status: String? = null)
data class VirtualSwitchConfigurationOverridesResponse(val enableIov: String? = null, val loadBalancingAlgorithm: String? = null)

The VirtualSwitchConfigurationOverrides of a cluster.