Azure.ResourceManager.Hci.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| ArcDefaultExtensionDetails |
Properties for a particular default extension category. |
| ArcExtensionInstanceView |
Describes the Extension Instance View. |
| ArcExtensionInstanceViewStatus |
Instance view status. |
| ArcExtensionPatch |
Extension Details to update. |
| ArcExtensionPatchContent |
Describes the properties of a Machine Extension that can be updated. |
| ArcExtensionUpgradeContent |
Describes the parameters for Extension upgrade. |
| ArcIdentityResult |
ArcIdentity details. |
| ArcPasswordCredential |
The ArcPasswordCredential. |
| ArcSettingPatch |
ArcSetting details to update. |
| ArmHciModelFactory |
A factory class for creating instances of the models for mocking. |
| AssemblyInfoPayload |
Payload properties for Validated Solution Recipe for AzureStackHCI Cluster. |
| ChangeRingContent |
The ChangeRingContent. |
| CheckUpdatesContent |
Request body for the check updates action on update summaries. |
| ClaimDeviceContent |
Request for claiming devices of the pool. |
| ClusterJobProperties |
Cluster Job properties Please note this is the abstract base class. The derived classes available for instantiation are: HciConfigureSdnIntegrationJobProperties and HciConfigureCvmJobProperties. |
| ClusterSdnProperties |
Represents the Software Defined Networking (SDN) configuration state of the Azure Stack HCI cluster. |
| ConfidentialVmProfile |
Represents the Confidential Virtual Machine (CVM) configuration status for an edge device. It includes the current IGVM support state and detailed component-level status information. |
| ConfidentialVmProperties |
Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. |
| ContentPayload |
Represents details of a specific update content payload. |
| DeploymentSettingAdapterPropertyOverrides |
The AdapterPropertyOverrides of a cluster. |
| DeploymentSettingHostNetwork |
The HostNetwork of a cluster. |
| DeploymentSettingInfrastructureNetwork |
The InfrastructureNetwork of a AzureStackHCI Cluster. |
| DeploymentSettingIntents |
The Intents of a cluster. |
| DeploymentSettingIPPools |
The dnsServers of a device. |
| DeploymentSettingNetworkController |
network controller config for SDN Integration to deploy AzureStackHCI Cluster. |
| DeploymentSettingObservability |
The Observability of AzureStackHCI Cluster. |
| DeploymentSettingPhysicalNodes |
The PhysicalNodes of a cluster. |
| DeploymentSettingQosPolicyOverrides |
The QoSPolicyOverrides of a cluster. |
| DeploymentSettingScaleUnits |
Scale units will contains list of deployment data. |
| DeploymentSettingStorage |
The Storage config of AzureStackHCI Cluster. |
| DeploymentSettingStorageAdapterIPInfo |
The StorageAdapter physical nodes of a cluster. |
| DeploymentSettingStorageNetworks |
The StorageNetworks of a cluster. |
| DeploymentSettingVirtualSwitchConfigurationOverrides |
The VirtualSwitchConfigurationOverrides of a cluster. |
| DevicePoolPatch |
Properties for patching Device Pool. |
| DevicePoolProperties |
Properties for device pool. |
| DownloadContent |
Download Request properties. |
| DownloadOsJobProperties |
Represents the properties of Download Os job. |
| DownloadOsProfile |
Operating system profile. |
| EceActionStatus |
The ECE action plan deployment status for AzureStackHCI Cluster. |
| EceDeploymentSecrets |
Protected parameters list stored in keyvault. |
| EceReportedProperties |
The DeploymentStatus of AzureStackHCI Cluster. |
| EdgeDeviceDisks |
Represents a storage disk on the device. |
| EdgeMachineCollectLogJobProperties |
Properties for pausing a server in the cluster. |
| EdgeMachineCollectLogJobReportedProperties |
Represents the reported properties of a log collection job. |
| EdgeMachineJobProperties |
EdgeMachine Job properties Please note this is the abstract base class. The derived classes available for instantiation are: EdgeMachineRemoteSupportJobProperties, ProvisionOsJobProperties, DownloadOsJobProperties, and EdgeMachineCollectLogJobProperties. |
| EdgeMachineNetworkProfile |
NetworkProfile of edge machine. |
| EdgeMachineNicDetail |
Network Interface Card (NIC) Details of edge machine. |
| EdgeMachinePatch |
Model for patching edge machine. |
| EdgeMachineProperties |
Properties for edge machine. |
| EdgeMachineRemoteSupportJobProperties |
Properties for adding a server in the cluster. |
| EdgeMachineRemoteSupportJobReportedProperties |
Represents the reported properties of a remote support job. |
| EdgeMachineRemoteSupportNodeSettings |
Represents the settings of a remote support node. |
| EdgeMachineReportedProperties |
Reported properties for edge machine. |
| HciArcEnabledEdgeDevice |
Arc-enabled edge device with HCI OS. |
| HciArcEnabledEdgeDeviceProperties |
properties for Arc-enabled edge device with HCI OS. |
| HciAssemblyInfo |
Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster. |
| HciClusterCertificateContent |
The HciClusterCertificateContent. |
| HciClusterDeploymentConfiguration |
Deployment Configuration. |
| HciClusterDeploymentInfo |
The Deployment data of AzureStackHCI Cluster. |
| HciClusterDeploymentSecuritySettings |
The SecuritySettings of AzureStackHCI Cluster. |
| HciClusterDeploymentStep |
The Step of AzureStackHCI Cluster. |
| HciClusterDesiredProperties |
Desired properties of the cluster. |
| HciClusterIdentityResult |
Cluster Identity details. |
| HciClusterNode |
Cluster node details. |
| HciClusterPatch |
Cluster details to update. |
| HciClusterReportedProperties |
Properties reported by cluster agent. |
| HciClusterUpdatePrerequisite |
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. |
| HciCollectLogJobProperties |
Represents the properties of an HCI Collect Log job. |
| HciConfigureCvmJobProperties |
Defines the customer's intent for updating confidential VM properties. |
| HciConfigureSdnIntegrationJobProperties |
Properties for configuring SDN integration intent for the cluster. |
| HciDeploymentCluster |
AzureStackHCI Cluster deployment properties. |
| HciDeploymentHardwareProfile |
Hardware profile for the machine. |
| HciDeploymentOSProfile |
OS configurations for HCI device. |
| HciDeviceDetail |
Device details. |
| HciDnsZones |
Details of the DNS Zones to be configured. |
| HciEdgeDeviceAdapterPropertyOverrides |
The AdapterPropertyOverrides of a cluster. |
| HciEdgeDeviceArcExtension |
Arc extension installed on edge device. |
| HciEdgeDeviceConfiguration |
The device Configuration for edge device. |
| HciEdgeDeviceHostNetwork |
The HostNetwork of a cluster. |
| HciEdgeDeviceIntents |
The Intents of a cluster. |
| HciEdgeDeviceJob |
Edge device job for Azure Stack HCI solution. |
| HciEdgeDeviceJobProperties |
HCI Edge device job properties Please note this is the abstract base class. The derived classes available for instantiation are: HciCollectLogJobProperties and HciRemoteSupportJobProperties. |
| HciEdgeDeviceNicDetail |
The NIC Detail of a device. |
| HciEdgeDeviceProperties |
Edge Device properties. |
| HciEdgeDeviceReportedProperties |
Reported properties pushed from edge device. |
| HciEdgeDeviceStorageAdapterIPInfo |
The StorageAdapter physical nodes of a cluster. |
| HciEdgeDeviceStorageNetworks |
The StorageNetworks of a cluster. |
| HciEdgeDeviceSwitchDetail |
List of switch details for edge device. |
| HciEdgeDeviceValidateContent |
The validate request for Edge Device. |
| HciEdgeDeviceValidateResult |
An Accepted response with an Operation-Location header. |
| HciEdgeDeviceVirtualSwitchConfigurationOverrides |
The VirtualSwitchConfigurationOverrides of a cluster. |
| HciEdgeSwitchExtension |
This represents extensions installed on virtualSwitch. |
| HciIPAddressRange |
IP address range configuration. |
| HciKubernetesVersion |
Represents a kubernetes version resource. |
| HciNetworkAdapter |
Network adapter configuration. |
| HciNetworkProfile |
The network profile of a device. |
| HciNicDetail |
The NIC Detail of a device. |
| HciOperationDetail |
operation detail. |
| HciOSProfile |
OS configurations for HCI device. |
| HciPackageVersionInfo |
Current version of each updatable component. |
| HciPrecheckResult |
The HciPrecheckResult. |
| HciPrecheckResultTags |
Key-value pairs that allow grouping/filtering individual tests. |
| HciProvisioningDetails |
Details for device provisioning. |
| HciRemoteSupportJobProperties |
Represents the properties of a remote support job for HCI. |
| HciReportedProperties |
The device Configuration for HCI device. |
| HciSiteDetails |
Site Details consists of common configurations. |
| HciSkuMappings |
SKU Mapping details. |
| HciStorageProfile |
Storage configurations for HCI device. |
| HciTimeConfiguration |
Time configuration. |
| HciUpdateStep |
Progress representation of the update run steps. |
| HciUserDetails |
User configuration. |
| HciValidationFailureDetail |
details of validation failure. |
| HciWebProxyConfiguration |
Web proxy configuration. |
| IgvmStatusDetail |
Provides component-level status information related to IGVM enablement on the device. |
| IsolatedVmAttestationConfiguration |
Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. |
| JobReportedProperties |
Reported Properties for job triggered from cloud. |
| LocalAvailabilityZones |
Local Availability Zone information for HCI cluster. |
| LogCollectionContent |
Log Collection Request. |
| LogCollectionContentProperties |
Properties for Log Collection Request. |
| LogCollectionError |
Log Collection Error details of the cluster. |
| LogCollectionJobSession |
Represents a session for collecting logs from an edge device. |
| LogCollectionProperties |
Log Collection properties of the cluster. |
| LogCollectionReportedProperties |
Represents the reported properties of a log collection job. |
| LogCollectionSession |
Log Collection Session details of the cluster. |
| NextBillingModel |
Details of the next billing model for the cluster. |
| OnboardingConfiguration |
Onboarding configuration. |
| OsImageProperties |
Represents properties of a os image resource. |
| OsProvisionProfile |
Operating system profile. |
| OwnershipVoucherDetails |
Details for ownership voucher. |
| OwnershipVoucherValidationDetails |
Ownership Voucher Validation Details. |
| PerNodeArcState |
Status of Arc agent for a particular node in HCI Cluster. |
| PerNodeExtensionState |
Status of Arc Extension for a particular node in HCI Cluster. |
| PerNodeRemoteSupportSession |
Remote Support Node Session Details on the Node. |
| PlatformPayload |
Represents details of a specific platform update payload. |
| PlatformUpdateDetails |
Represents details of a specific platform update. |
| ProvisioningContent |
Represents a provisioning request. |
| ProvisionOsJobProperties |
Represents the properties of an Azure Linux restricted operating environment Provision Os job. |
| ProvisionOsReportedProperties |
Reported Properties for Provision Os job. |
| ReconcileArcSettingsContent |
Request for reconciling Arc Settings. |
| ReleaseDeviceContent |
Request for releasing devices of the pool. |
| RemoteSupportContent |
Remote Support Request. |
| RemoteSupportContentProperties |
Properties for Remote Support Request. |
| RemoteSupportJobNodeSettings |
Represents the settings of a remote support node. |
| RemoteSupportJobReportedProperties |
Represents the reported properties of a remote support job. |
| RemoteSupportNodeSettings |
Remote Support Node Settings of the cluster. |
| RemoteSupportProperties |
Remote Support properties of the cluster. |
| RemoteSupportSession |
Represents a remote support session. |
| SanAdapterIPConfig |
Per-adapter IP configuration for SAN cluster network. |
| SanAdapterProperties |
QoS and adapter property overrides for SAN cluster network traffic. |
| SanClusterNetworkConfig |
Cluster network configuration for SAN deployments (CSV/LiveMig traffic). |
| SbeCredentials |
secrets used for solution builder extension (SBE) partner extensibility. |
| SbeDeploymentInfo |
Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment. |
| SbeDeploymentPackageInfo |
Solution builder extension (SBE) deployment package information. |
| SbePartnerInfo |
The solution builder extension (SBE) partner deployment info for cluster. |
| SbePartnerProperties |
Solution builder extension (SBE) partner properties object. |
| SdnProperties |
Represents the Software Defined Networking (SDN) configuration state. |
| SecretsLocationDetails |
Secrets location details. |
| SecretsLocationsChangeContent |
Update secrets locations change Request. |
| SecurityComplianceStatus |
Security compliance properties of the resource. |
| SoftwareAssuranceChangeContent |
The SoftwareAssuranceChangeContent. |
| SoftwareAssuranceProperties |
Software Assurance properties of the cluster. |
| StorageS2dConfig |
The S2D (Storage Spaces Direct) configuration for AzureStackHCI Cluster storage. |
| StorageSanConfig |
The SAN (Storage Area Network) configuration for AzureStackHCI Cluster storage. |
| TargetDeviceConfiguration |
Device configuration. |
| ValidatedSolutionRecipeCapabilities |
Represents capabilities available in a validated solution recipe. |
| ValidatedSolutionRecipeCapability |
Represents capability available in a validated solution recipe. |
| ValidatedSolutionRecipeComponent |
Represents component available in a validated solution recipe. |
| ValidatedSolutionRecipeComponentMetadata |
Represents metadata associated with a component available in a validated solution recipe. |
| ValidatedSolutionRecipeComponentPayload |
Represents payloads associated with a component available in a validated solution recipe. |
| ValidatedSolutionRecipeContent |
Represents contents of a validated solution recipe resource. |
| ValidatedSolutionRecipeInfo |
Represents information about a validated solution recipe. |
| ValidatedSolutionRecipeProperties |
Represents properties of a validated solution recipe resource. |
| ValidateOwnershipVouchersContent |
Validate Ownership Voucher Request. |
| ValidateOwnershipVouchersResult |
Validate Ownership Voucher Response. |
Structs
| Name | Description |
|---|---|
| ArcExtensionAggregateState |
Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. |
| ArcExtensionManagedBy |
Indicates whether the extension is managed by the user or by Azure. |
| ArcExtensionState |
Arc extension installation state. |
| ArcSettingAggregateState |
Aggregate state of Arc agent across the nodes in this HCI cluster. |
| ClusterNodeType |
Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. |
| ClusterPattern |
Supported Storage Pattern for HCI Cluster. |
| ConfidentialVmIntent |
Captures the customer's intent to enable or disable Confidential Virtual Machine (CVM) support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). |
| ConfidentialVmStatus |
Captures the current status of Confidential Virtual Machine (CVM) support on the cluster. |
| DeviceLogCollectionStatus |
Represents the status of a log collection operation. |
| DnsServerConfig |
Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. |
| EceDeploymentMode |
Deployment mode to trigger job. |
| EceSecret |
Secret names allowed for Enterprise Cloud Engine (ECE) deployment. |
| EdgeMachineConnectivityStatus |
Overall connectivity status for the machine resource. |
| EdgeMachineKind |
Edge Machine Kind. |
| EdgeMachineState |
OS State. |
| HardwareClass |
Hardware class of the cluster. |
| HciAvailabilityType |
Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. |
| HciClusterAccessLevel |
Remote Support Access Level. |
| HciClusterComplianceAssignmentType |
Represents the compliance assignment type of a resource. |
| HciClusterComplianceStatus |
Represents the compliance status of a resource. |
| HciClusterConnectivityStatus |
Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. |
| HciClusterDiagnosticLevel |
Desired level of diagnostic data emitted by the cluster. |
| HciClusterOperationType |
The intended operation for a cluster. |
| HciClusterStatus |
Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. |
| HciClusterUpdateState |
Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. |
| HciEdgeDeviceState |
The edge device state. |
| HciHealthState |
Overall health state for update-specific health checks. Indicates whether the system is functioning correctly, has warnings or errors, or is undergoing a health evaluation. |
| HciIdentityProvider |
Identity Provider for the cluster. |
| HciJobStatus |
Represents the various statuses a job can have throughout its lifecycle. |
| HciNodeRebootRequirement |
Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. |
| HciProvisioningState |
Provisioning state of the ArcSetting proxy resource. |
| HciSecretsType |
Type of secrets to store. |
| HciSecretType |
Type of secret used for authentication. |
| HciStatusLevelType |
The level code. Indicates the severity or importance of the status message. |
| HciStorageType |
Storage type supported for HCI Cluster. |
| HciUpdateState |
Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. |
| HciVolumeType |
Volume provisioning type for S2D storage. |
| IgvmStatus |
Represents the IGVM support status for the device. |
| ImdsAttestationState |
IMDS attestation status of the cluster. |
| IpAssignmentType |
IP assignment types. |
| LogCollectionJobType |
Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. |
| LogCollectionStatus |
LogCollection status. |
| NodeArcState |
State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. |
| NodeExtensionState |
State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. |
| OemActivation |
OEM activation status of the cluster. |
| OnboardingResourceType |
Onboarding resource type. |
| OSOperationType |
OS Provision Operation type. |
| OverprovisioningRatio |
Overprovisioning ratio for S2D storage. |
| OwnerKeyType |
Type of owner key in the voucher. |
| OwnershipVoucherValidationStatus |
Ownership Voucher validation Status. |
| ProvisioningOsType |
Represents the provisioning operating system type. |
| RdmaCapability |
Describes the RDMA capability of the network adapter. |
| RemoteSupportAccessLevel |
Defines the level of remote support access granted. |
| RemoteSupportProvisioningState |
Remote Support Provisioning State. |
| RemoteSupportType |
Remote Support Type for cluster. |
| SdnIntegrationIntent |
Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. |
| SdnStatus |
Indicates the current Software Defined Networking (SDN) status of the resource, which may be an individual device or a cluster. |
| SoftwareAssuranceIntent |
Customer Intent for Software Assurance Benefit. |
| SoftwareAssuranceStatus |
Status of the Software Assurance for the cluster. |
| UpdateRunPropertiesState |
Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. |
| UpdateSeverity |
Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. |
| WindowsServerSubscription |
Desired state of Windows Server Subscription. |