@azure/arm-azurestackhci package

Classes

AzureStackHCIClient

Interfaces

ArcConnectivityProperties	Connectivity related configuration required by arc server.
ArcIdentityResponse	ArcIdentity details.
ArcIdentityResponseProperties	model interface ArcIdentityResponseProperties
ArcSetting	ArcSetting details.
ArcSettingProperties	ArcSetting properties.
ArcSettingsConsentAndInstallDefaultExtensionsOptionalParams	Optional parameters.
ArcSettingsCreateIdentityOptionalParams	Optional parameters.
ArcSettingsCreateOptionalParams	Optional parameters.
ArcSettingsDeleteOptionalParams	Optional parameters.
ArcSettingsGeneratePasswordOptionalParams	Optional parameters.
ArcSettingsGetOptionalParams	Optional parameters.
ArcSettingsInitializeDisableProcessOptionalParams	Optional parameters.
ArcSettingsListByClusterOptionalParams	Optional parameters.
ArcSettingsOperations	Interface representing a ArcSettings operations.
ArcSettingsPatch	ArcSetting details to update.
ArcSettingsPatchProperties	ArcSettings properties.
ArcSettingsReconcileOptionalParams	Optional parameters.
ArcSettingsUpdateOptionalParams	Optional parameters.
AssemblyInfo	Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster
AssemblyInfoPayload	Payload properties for Validated Solution Recipe for AzureStackHCI Cluster
AzureStackHCIClientOptionalParams	Optional parameters for the client.
Cluster	Cluster details.
ClusterDesiredProperties	Desired properties of the cluster.
ClusterIdentityResponse	Cluster Identity details.
ClusterIdentityResponseProperties	model interface ClusterIdentityResponseProperties
ClusterNode	Cluster node details.
ClusterPatch	Cluster details to update.
ClusterPatchProperties	Cluster properties.
ClusterProperties	Cluster properties.
ClusterReportedProperties	Properties reported by cluster agent.
ClustersConfigureRemoteSupportOptionalParams	Optional parameters.
ClustersCreateIdentityOptionalParams	Optional parameters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersExtendSoftwareAssuranceBenefitOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListBySubscriptionOptionalParams	Optional parameters.
ClustersOperations	Interface representing a Clusters operations.
ClustersTriggerLogCollectionOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	Optional parameters.
ClustersUpdateSecretsLocationsOptionalParams	Optional parameters.
ClustersUploadCertificateOptionalParams	Optional parameters.
DefaultExtensionDetails	Properties for a particular default extension category.
DeploymentCluster	AzureStackHCI Cluster deployment properties.
DeploymentConfiguration	Deployment Configuration
DeploymentData	The Deployment data of AzureStackHCI Cluster.
DeploymentSecuritySettings	The SecuritySettings of AzureStackHCI Cluster.
DeploymentSetting	Edge device resource
DeploymentSettingAdapterPropertyOverrides	The AdapterPropertyOverrides of a cluster.
DeploymentSettingHostNetwork	The HostNetwork of a cluster.
DeploymentSettingIntents	The Intents of a cluster.
DeploymentSettingStorageAdapterIPInfo	The StorageAdapter physical nodes of a cluster.
DeploymentSettingStorageNetworks	The StorageNetworks of a cluster.
DeploymentSettingVirtualSwitchConfigurationOverrides	The VirtualSwitchConfigurationOverrides of a cluster.
DeploymentSettingsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentSettingsDeleteOptionalParams	Optional parameters.
DeploymentSettingsGetOptionalParams	Optional parameters.
DeploymentSettingsListByClustersOptionalParams	Optional parameters.
DeploymentSettingsOperations	Interface representing a DeploymentSettings operations.
DeploymentSettingsProperties	DeploymentSetting properties
DeploymentStep	The Step of AzureStackHCI Cluster.
DeviceConfiguration	The device Configuration for edge device.
DnsZones	Details of the DNS Zones to be configured.
EceActionStatus	The ECE action plan deployment status for AzureStackHCI Cluster.
EceDeploymentSecrets	Protected parameters list stored in keyvault.
EceReportedProperties	The DeploymentStatus of AzureStackHCI Cluster.
EdgeDevice	Edge device resource.
EdgeDeviceJob	EdgeDevice Jobs resource
EdgeDeviceJobsCreateOrUpdateOptionalParams	Optional parameters.
EdgeDeviceJobsDeleteOptionalParams	Optional parameters.
EdgeDeviceJobsGetOptionalParams	Optional parameters.
EdgeDeviceJobsListByEdgeDeviceOptionalParams	Optional parameters.
EdgeDeviceJobsOperations	Interface representing a EdgeDeviceJobs operations.
EdgeDeviceProperties	Edge Device properties
EdgeDevicesCreateOrUpdateOptionalParams	Optional parameters.
EdgeDevicesDeleteOptionalParams	Optional parameters.
EdgeDevicesGetOptionalParams	Optional parameters.
EdgeDevicesListOptionalParams	Optional parameters.
EdgeDevicesOperations	Interface representing a EdgeDevices operations.
EdgeDevicesValidateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
Extension	Details of a particular extension in HCI Cluster.
ExtensionInstanceView	Describes the Extension Instance View.
ExtensionInstanceViewStatus	Instance view status.
ExtensionParameters	Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.
ExtensionPatch	Extension Details to update
ExtensionPatchParameters	Describes the properties of a Machine Extension that can be updated.
ExtensionPatchProperties	Describes Machine Extension Properties that can be updated.
ExtensionProfile	Extensions details for edge device.
ExtensionProperties	Status of Arc Extension for a particular node in HCI Cluster.
ExtensionResource	The base extension resource.
ExtensionUpgradeParameters	Describes the parameters for Extension upgrade.
ExtensionsCreateOptionalParams	Optional parameters.
ExtensionsDeleteOptionalParams	Optional parameters.
ExtensionsGetOptionalParams	Optional parameters.
ExtensionsListByArcSettingOptionalParams	Optional parameters.
ExtensionsOperations	Interface representing a Extensions operations.
ExtensionsUpdateOptionalParams	Optional parameters.
ExtensionsUpgradeOptionalParams	Optional parameters.
HciCollectLogJobProperties	Represents the properties of an HCI Collect Log job.
HciEdgeDevice	Arc-enabled edge device with HCI OS.
HciEdgeDeviceAdapterPropertyOverrides	The AdapterPropertyOverrides of a cluster.
HciEdgeDeviceArcExtension	Arc extension installed on 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
HciEdgeDeviceProperties	properties for Arc-enabled edge device with HCI OS.
HciEdgeDeviceStorageAdapterIPInfo	The StorageAdapter physical nodes of a cluster.
HciEdgeDeviceStorageNetworks	The StorageNetworks of a cluster.
HciEdgeDeviceVirtualSwitchConfigurationOverrides	The VirtualSwitchConfigurationOverrides of a cluster.
HciHardwareProfile	Hardware configurations for HCI device.
HciNetworkProfile	The network profile of a device.
HciNicDetail	The NIC Detail of a device.
HciOsProfile	OS configurations for HCI device.
HciRemoteSupportJobProperties	Represents the properties of a remote support job for HCI.
HciReportedProperties	The device Configuration for HCI device.
HciStorageProfile	Storage configurations for HCI device.
HciValidationFailureDetail	details of validation failure
InfrastructureNetwork	The InfrastructureNetwork of a AzureStackHCI Cluster.
IpPools	The dnsServers of a device.
IsolatedVmAttestationConfiguration	Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.
LocalAvailabilityZones	Local Availability Zone information for HCI cluster
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.
LogCollectionRequest	Log Collection Request
LogCollectionRequestProperties	Properties for Log Collection Request
LogCollectionSession	Log Collection Session details of the cluster.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NetworkController	network controller config for SDN Integration to deploy AzureStackHCI Cluster.
NicDetail	The NIC Detail of a device.
Observability	The Observability of AzureStackHCI Cluster.
Offer	Offer details.
OfferProperties	Publisher properties.
OffersGetOptionalParams	Optional parameters.
OffersListByClusterOptionalParams	Optional parameters.
OffersListByPublisherOptionalParams	Optional parameters.
OffersOperations	Interface representing a Offers operations.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OptionalServices	The OptionalServices of AzureStackHCI Cluster.
PackageVersionInfo	Current version of each updatable component.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PasswordCredential	model interface PasswordCredential
PerNodeExtensionState	Status of Arc Extension for a particular node in HCI Cluster.
PerNodeRemoteSupportSession	Remote Support Node Session Details on the Node.
PerNodeState	Status of Arc agent for a particular node in HCI Cluster.
PhysicalNodes	The PhysicalNodes of a cluster.
PrecheckResult	model interface PrecheckResult
PrecheckResultTags	Key-value pairs that allow grouping/filtering individual tests.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QosPolicyOverrides	The QoSPolicyOverrides of a cluster.
RawCertificateData	model interface RawCertificateData
ReconcileArcSettingsRequest	Request for reconciling Arc Settings.
ReconcileArcSettingsRequestProperties	List of Arc Nodes in the cluster
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.
RemoteSupportRequest	Remote Support Request
RemoteSupportRequestProperties	Properties for Remote Support Request
RemoteSupportSession	Represents a remote support session.
ReportedProperties	Reported properties pushed from edge device.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
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.
ScaleUnits	Scale units will contains list of deployment data
SdnIntegration	SDN Integration config to deploy AzureStackHCI Cluster.
SecretsLocationDetails	Secrets location details
SecretsLocationsChangeRequest	Update secrets locations change Request.
SecurityComplianceStatus	Security compliance properties of the resource
SecurityProperties	Security properties of the resource
SecuritySetting	Security settings proxy resource
SecuritySettingsCreateOrUpdateOptionalParams	Optional parameters.
SecuritySettingsDeleteOptionalParams	Optional parameters.
SecuritySettingsGetOptionalParams	Optional parameters.
SecuritySettingsListByClustersOptionalParams	Optional parameters.
SecuritySettingsOperations	Interface representing a SecuritySettings operations.
ServiceConfiguration	Service configuration details
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	Sku details.
SkuMappings	SKU Mapping details.
SkuProperties	SKU properties.
SkusGetOptionalParams	Optional parameters.
SkusListByOfferOptionalParams	Optional parameters.
SkusOperations	Interface representing a Skus operations.
SoftwareAssuranceChangeRequest	model interface SoftwareAssuranceChangeRequest
SoftwareAssuranceChangeRequestProperties	model interface SoftwareAssuranceChangeRequestProperties
SoftwareAssuranceProperties	Software Assurance properties of the cluster.
Step	Progress representation of the update run steps.
Storage	The Storage config of AzureStackHCI Cluster.
SwitchDetail	List of switch details for edge device.
SwitchExtension	This represents extensions installed on virtualSwitch.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
Update	Update details
UpdatePrerequisite	If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
UpdateProperties	Details of a singular Update in HCI Cluster
UpdateRun	Details of an Update run
UpdateRunProperties	Details of an Update run
UpdateRunsDeleteOptionalParams	Optional parameters.
UpdateRunsGetOptionalParams	Optional parameters.
UpdateRunsListOptionalParams	Optional parameters.
UpdateRunsOperations	Interface representing a UpdateRuns operations.
UpdateRunsPutOptionalParams	Optional parameters.
UpdateStateProperties	Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.
UpdateSummaries	Get the update summaries for the cluster
UpdateSummariesDeleteOptionalParams	Optional parameters.
UpdateSummariesGetOptionalParams	Optional parameters.
UpdateSummariesListOptionalParams	Optional parameters.
UpdateSummariesOperations	Interface representing a UpdateSummaries operations.
UpdateSummariesProperties	Properties of Update summaries
UpdateSummariesPutOptionalParams	Optional parameters.
UpdatesDeleteOptionalParams	Optional parameters.
UpdatesGetOptionalParams	Optional parameters.
UpdatesListOptionalParams	Optional parameters.
UpdatesOperations	Interface representing a Updates operations.
UpdatesPostOptionalParams	Optional parameters.
UpdatesPutOptionalParams	Optional parameters.
UploadCertificateRequest	model interface UploadCertificateRequest
UserAssignedIdentity	User assigned identity properties
ValidateRequest	The validate request for Edge Device.
ValidateResponse	An Accepted response with an Operation-Location header.
ValidatedSolutionRecipe	Represents a validated solution recipe resource.
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.
ValidatedSolutionRecipesGetOptionalParams	Optional parameters.
ValidatedSolutionRecipesListBySubscriptionLocationResourceOptionalParams	Optional parameters.
ValidatedSolutionRecipesOperations	Interface representing a ValidatedSolutionRecipes operations.

Type Aliases

AccessLevel	Remote Support Access Level KnownAccessLevel can be used interchangeably with AccessLevel, this enum contains the known values that the service supports. Known values supported by the service Diagnostics: Allows remote diagnostics operations only. DiagnosticsAndRepair: Allows both remote diagnostics and repair operations.
ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
ArcExtensionState	Arc extension installation state. KnownArcExtensionState can be used interchangeably with ArcExtensionState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: Arc extension state is not specified. Succeeded: Arc extension state is Succeeded. Failed: Arc extension state is Failed. Canceled: Arc extension state is Canceled. Accepted: Arc extension state is Accepted when extension installation triggered. Creating: Arc extension is in Creating State. Updating: Arc extension is in Updating State. Moving: Arc extension is in Moving State. Deleting: Arc extension is in Deleting State. Deleted: Arc extension is in Deleted State.
ArcSettingAggregateState	Aggregate state of Arc agent across the nodes in this HCI cluster. KnownArcSettingAggregateState can be used interchangeably with ArcSettingAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The aggregate state is not specified. Error: An error occurred in the aggregate state. Succeeded: The operation successfully completed across all nodes. Canceled: The operation was canceled across the nodes. Failed: The operation failed on all or most nodes. Connected: All nodes are connected. Disconnected: All nodes are disconnected. Deleted: The Arc agent has been deleted from all nodes. Creating: The Arc agent is being created across the nodes. Updating: The Arc agent is being updated across the nodes. Deleting: The Arc agent is being deleted across the nodes. Moving: The Arc agent is being moved across the nodes. PartiallySucceeded: The operation succeeded on some nodes. PartiallyConnected: Some nodes are connected, others are not. InProgress: The operation is currently in progress across the nodes. Accepted: The operation has been accepted and is pending execution. Provisioning: The Arc agent is being provisioned across the nodes. DisableInProgress: The Arc agent is being disabled across the nodes.
AvailabilityType	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. KnownAvailabilityType can be used interchangeably with AvailabilityType, this enum contains the known values that the service supports. Known values supported by the service Local: The update content is available locally within the environment. Online: The update content is available from an online source. Notify: The system will notify the user when update content becomes available.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
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. KnownClusterNodeType can be used interchangeably with ClusterNodeType, this enum contains the known values that the service supports. Known values supported by the service FirstParty: All nodes in the cluster are provided and managed by Microsoft. ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor.
ClusterPattern	Supported Storage Pattern for HCI Cluster KnownClusterPattern can be used interchangeably with ClusterPattern, this enum contains the known values that the service supports. Known values supported by the service Standard: Standard cluster. RackAware: RackAware cluster.
ComplianceAssignmentType	Represents the compliance assignment type of a resource. KnownComplianceAssignmentType can be used interchangeably with ComplianceAssignmentType, this enum contains the known values that the service supports. Known values supported by the service Audit: Report on the state of the machine, but don't make changes. ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation.
ComplianceStatus	Represents the compliance status of a resource. KnownComplianceStatus can be used interchangeably with ComplianceStatus, this enum contains the known values that the service supports. Known values supported by the service Compliant: The resource is compliant NonCompliant: The resource is non-compliant Pending: The resource compliance status is pending
ConnectivityStatus	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. KnownConnectivityStatus can be used interchangeably with ConnectivityStatus, this enum contains the known values that the service supports. Known values supported by the service NotYetRegistered: The cluster has not yet registered with Azure. Connected: The cluster is fully connected to Azure. NotConnectedRecently: The cluster has not connected to Azure recently. PartiallyConnected: Some components of the cluster are connected, while others are not. Disconnected: The cluster is not connected to Azure. NotSpecified: The connectivity status is not specified.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DeploymentMode	Deployment mode to trigger job. KnownDeploymentMode can be used interchangeably with DeploymentMode, this enum contains the known values that the service supports. Known values supported by the service Validate: Validate ECE action deployment for a cluster. Deploy: Deploy ECE action deployment for a cluster.
DeviceKind	Edge device kind. KnownDeviceKind can be used interchangeably with DeviceKind, this enum contains the known values that the service supports. Known values supported by the service HCI: Arc-enabled edge device with HCI OS.
DeviceLogCollectionStatus	Represents the status of a log collection operation. KnownDeviceLogCollectionStatus can be used interchangeably with DeviceLogCollectionStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: Log collection operation has not been initiated. Running: Indicates that the log collection operation is currently running. Failed: Indicates that the log collection operation has failed. Succeeded: Indicates that the log collection operation has completed successfully. Canceled: Indicates that the log collection operation has completed successfully.
DeviceState	The edge device state. KnownDeviceState can be used interchangeably with DeviceState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The edge device state is not specified. Connected: The edge device state is in connected state. Disconnected: The edge device state is in disconnected state. Repairing: The edge device state is in repairing state. Draining: The edge device state is in draining state. InMaintenance: The edge device state is in maintenance state. Resuming: The edge device state is in resuming state. Processing: The edge device state is in processing state.
DiagnosticLevel	Desired level of diagnostic data emitted by the cluster. KnownDiagnosticLevel can be used interchangeably with DiagnosticLevel, this enum contains the known values that the service supports. Known values supported by the service Off: No diagnostic data will be emitted. Basic: Basic diagnostic data will be emitted, including essential health metrics. Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics.
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. KnownDnsServerConfig can be used interchangeably with DnsServerConfig, this enum contains the known values that the service supports. Known values supported by the service UseDnsServer: Use the provided DNS servers for the infrastructure network. UseForwarder: Use DNS forwarders for the infrastructure network.
EceSecrets	Secret names allowed for Enterprise Cloud Engine (ECE) deployment. KnownEceSecrets can be used interchangeably with EceSecrets, this enum contains the known values that the service supports. Known values supported by the service AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster.
EdgeDeviceJobUnion	Alias for EdgeDeviceJobUnion
EdgeDeviceKind	Edge device kind. KnownEdgeDeviceKind can be used interchangeably with EdgeDeviceKind, this enum contains the known values that the service supports. Known values supported by the service HCI: Arc-enabled edge device with HCI OS.
EdgeDeviceUnion	Alias for EdgeDeviceUnion
ExtensionAggregateState	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. KnownExtensionAggregateState can be used interchangeably with ExtensionAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The aggregate state is not specified. Error: An error occurred in the aggregate state. Succeeded: The operation succeeded across all nodes. Canceled: The operation was canceled across the nodes. Failed: The operation failed on all or most nodes. Connected: All nodes are connected. Disconnected: All nodes are disconnected. Deleted: The extension has been deleted from all nodes. Creating: The extension is being created across the nodes. Updating: The extension is being updated across the nodes. Deleting: The extension is being deleted across the nodes. Moving: The extension is being moved across the nodes. PartiallySucceeded: The operation succeeded on some nodes. PartiallyConnected: Some nodes are connected, others are not. InProgress: The operation is currently in progress across the nodes. Accepted: The operation has been accepted and is pending execution. Provisioning: The extension is currently being provisioned across the nodes. UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes.
ExtensionManagedBy	Indicates whether the extension is managed by the user or by Azure. KnownExtensionManagedBy can be used interchangeably with ExtensionManagedBy, this enum contains the known values that the service supports. Known values supported by the service User: The extension is managed by the user. Azure: The extension is managed by Azure.
HardwareClass	Hardware class of the cluster. KnownHardwareClass can be used interchangeably with HardwareClass, this enum contains the known values that the service supports. Known values supported by the service Small: The hardware class is small. Medium: The hardware class is medium. This corresponds to the default Large: The hardware class is large.
HciEdgeDeviceJobPropertiesUnion	Alias for HciEdgeDeviceJobPropertiesUnion
HciEdgeDeviceJobType	Job Type supported. KnownHciEdgeDeviceJobType can be used interchangeably with HciEdgeDeviceJobType, this enum contains the known values that the service supports. Known values supported by the service CollectLog: Job to collect logs from the device. RemoteSupport: Job to provide remote support to the device.
HealthState	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. KnownHealthState can be used interchangeably with HealthState, this enum contains the known values that the service supports. Known values supported by the service Unknown: The health state is not known or cannot be determined. Success: The health check completed successfully and the system is healthy. Failure: The health check failed, indicating a critical issue. Warning: The health check detected a non-critical issue that may require attention. Error: An error occurred during the health check process. InProgress: The health check is currently in progress.
IdentityProvider	Identity Provider for the cluster KnownIdentityProvider can be used interchangeably with IdentityProvider, this enum contains the known values that the service supports. Known values supported by the service ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required.
ImdsAttestation	IMDS attestation status of the cluster. KnownImdsAttestation can be used interchangeably with ImdsAttestation, this enum contains the known values that the service supports. Known values supported by the service Disabled: IMDS attestation is disabled for the cluster. Enabled: IMDS attestation is enabled for the cluster.
JobStatus	Represents the various statuses a job can have throughout its lifecycle. KnownJobStatus can be used interchangeably with JobStatus, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The job status has not been specified. ValidationInProgress: The job is currently undergoing validation. ValidationSuccess: The job has successfully passed validation. ValidationFailed: The job has failed validation. DeploymentInProgress: The job's deployment is currently in progress. DeploymentFailed: The job's deployment has failed. DeploymentSuccess: The job has been successfully deployed. Succeeded: The job has succeeded. Failed: The job has failed. Canceled: The job has been canceled. Paused: The job is paused. Scheduled: The job is scheduled to run.
LogCollectionJobType	Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. KnownLogCollectionJobType can be used interchangeably with LogCollectionJobType, this enum contains the known values that the service supports. Known values supported by the service OnDemand: Log collection is triggered manually and executed immediately. Scheduled: Log collection is scheduled to run at a predefined time or interval.
LogCollectionStatus	LogCollection status KnownLogCollectionStatus can be used interchangeably with LogCollectionStatus, this enum contains the known values that the service supports. Known values supported by the service None: No log collection has been initiated. InProgress: Log collection is currently in progress. Failed: Log collection has failed. Succeeded: Log collection completed successfully.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
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. KnownNodeArcState can be used interchangeably with NodeArcState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The state is not specified. Error: An error occurred during the agent's lifecycle. Succeeded: The operation completed successfully. Canceled: The operation was canceled before completion. Failed: The operation failed. Connected: The Arc agent is connected on this node. Disconnected: The Arc agent is disconnected on this node. Deleted: The Arc agent has been deleted from this node. Creating: The Arc agent is being created on this node. Updating: The Arc agent is being updated on this node. Deleting: The Arc agent is being deleted from this node. Moving: The Arc agent is being moved on this node. PartiallySucceeded: The operation partially succeeded. PartiallyConnected: The Arc agent is partially connected on this node. InProgress: The operation is currently in progress. Accepted: The operation has been accepted and is pending execution. Provisioning: The Arc agent is currently being provisioned on this node. DisableInProgress: The Arc agent is in the process of being disabled on this node.
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. KnownNodeExtensionState can be used interchangeably with NodeExtensionState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The state is not specified. Error: An error occurred during the extension lifecycle. Succeeded: The extension operation completed successfully. Canceled: The extension operation was canceled. Failed: The extension operation failed. Connected: The extension is connected on the node. Disconnected: The extension is disconnected on the node. Deleted: The extension has been deleted from the node. Creating: The extension is being created on the node. Updating: The extension is being updated on the node. Deleting: The extension is being deleted from the node. Moving: The extension is being moved on the node. PartiallySucceeded: The extension operation partially succeeded. PartiallyConnected: The extension is partially connected on the node. InProgress: The extension operation is currently in progress. Accepted: The extension operation has been accepted and is pending execution. Provisioning: The extension is currently being provisioned on the node.
OemActivation	OEM activation status of the cluster. KnownOemActivation can be used interchangeably with OemActivation, this enum contains the known values that the service supports. Known values supported by the service Disabled: OEM activation is disabled for the cluster. Enabled: OEM activation is enabled for the cluster.
OperationType	The intended operation for a cluster. KnownOperationType can be used interchangeably with OperationType, this enum contains the known values that the service supports. Known values supported by the service ClusterProvisioning: Cluster provisioning operation. ClusterUpgrade: Cluster upgrade operation.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	Provisioning state of the ArcSetting proxy resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The provisioning state is not specified. Error: An error occurred during provisioning. Succeeded: Provisioning completed successfully. Failed: Provisioning failed. Canceled: Provisioning was canceled. Connected: The resource is connected. Disconnected: The resource is disconnected. Deleted: The resource has been deleted. Creating: The resource is being created. Updating: The resource is being updated. Deleting: The resource is being deleted. Moving: The resource is being moved. PartiallySucceeded: Provisioning partially succeeded. PartiallyConnected: The resource is partially connected. InProgress: Provisioning is in progress. Accepted: Provisioning request has been accepted. Provisioning: The resource is currently provisioning. DisableInProgress: The resource is being disabled.
RdmaCapability	Describes the RDMA capability of the network adapter. KnownRdmaCapability can be used interchangeably with RdmaCapability, this enum contains the known values that the service supports. Known values supported by the service Enabled: Network Adapter on the device is RDMA Capable Disabled: Network Adapter on the device is RDMA Capable
RebootRequirement	Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. KnownRebootRequirement can be used interchangeably with RebootRequirement, this enum contains the known values that the service supports. Known values supported by the service Unknown: It is not known whether a reboot is required. True: A reboot is required to complete the operation. False: No reboot is required after the operation.
RemoteSupportAccessLevel	Defines the level of remote support access granted. KnownRemoteSupportAccessLevel can be used interchangeably with RemoteSupportAccessLevel, this enum contains the known values that the service supports. Known values supported by the service None: No remote support access is granted. Diagnostics: Access is limited to diagnostics information only. DiagnosticsAndRepair: Access includes diagnostics information and the ability to perform repairs.
RemoteSupportType	Remote Support Type for cluster KnownRemoteSupportType can be used interchangeably with RemoteSupportType, this enum contains the known values that the service supports. Known values supported by the service Enable: Enable remote support for the cluster. Revoke: Revoke previously enabled remote support for the cluster.
SecretsType	Type of secrets to store KnownSecretsType can be used interchangeably with SecretsType, this enum contains the known values that the service supports. Known values supported by the service BackupSecrets: Backup secrets type
ServiceName	Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. KnownServiceName can be used interchangeably with ServiceName, this enum contains the known values that the service supports. Known values supported by the service WAC: Windows Admin Center (WAC) is the service associated with this operation.
Severity	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. KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports. Known values supported by the service Critical: A critical issue that blocks updates and requires immediate attention. Warning: A warning that may indicate a potential issue but does not block updates. Informational: General information that does not indicate any issue. Hidden: The result is hidden and not shown in the output.
SoftwareAssuranceIntent	Customer Intent for Software Assurance Benefit. KnownSoftwareAssuranceIntent can be used interchangeably with SoftwareAssuranceIntent, this enum contains the known values that the service supports. Known values supported by the service Enable: Customer intends to enable the Software Assurance benefit. Disable: Customer intends to disable the Software Assurance benefit.
SoftwareAssuranceStatus	Status of the Software Assurance for the cluster. KnownSoftwareAssuranceStatus can be used interchangeably with SoftwareAssuranceStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: Software Assurance is enabled for the cluster. Disabled: Software Assurance is disabled for the cluster.
State	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. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. Obsolete: The update is obsolete and no longer applicable. Ready: The update is ready to be installed. NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. Preparing: The update is currently in the preparation phase. Installing: The update is currently being installed. Installed: The update has been successfully installed. PreparationFailed: The update preparation phase failed. InstallationFailed: The update installation failed. Invalid: The update is invalid and cannot be applied. Recalled: The update has been recalled and should not be applied. Downloading: The update is currently being downloaded. DownloadFailed: The update download failed. HealthChecking: A health check is being performed before applying the update. HealthCheckFailed: The health check failed, preventing the update from proceeding. ReadyToInstall: The update is ready to be installed after successful preparation and checks. ScanInProgress: The system is scanning for updates. ScanFailed: The scan for updates failed. AdditionalContentRequired: Additional content is required to proceed with the update.
Status	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service NotYetRegistered: The cluster agent has not yet registered with Azure. ConnectedRecently: The cluster agent has connected to Azure recently. NotConnectedRecently: The cluster agent has not connected to Azure recently. Disconnected: The cluster agent is currently disconnected from Azure. Error: An error occurred in the cluster agent's operation. NotSpecified: The status of the cluster agent is not specified. ValidationInProgress: Validation of the cluster agent is currently in progress. ValidationSuccess: Validation of the cluster agent completed successfully. ValidationFailed: Validation of the cluster agent failed. DeploymentInProgress: Deployment of the cluster agent is currently in progress. DeploymentFailed: Deployment of the cluster agent failed. DeploymentSuccess: Deployment of the cluster agent completed successfully.
StatusLevelTypes	The level code. Indicates the severity or importance of the status message. KnownStatusLevelTypes can be used interchangeably with StatusLevelTypes, this enum contains the known values that the service supports. Known values supported by the service Info: Informational message indicating normal operation. Warning: Warning message indicating a potential issue or non-critical problem. Error: Error message indicating a failure or critical issue.
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. KnownUpdateRunPropertiesState can be used interchangeably with UpdateRunPropertiesState, this enum contains the known values that the service supports. Known values supported by the service Unknown: The state of the update run is not known. Succeeded: The update run completed successfully. InProgress: The update run is currently in progress. Failed: The update run failed to complete successfully.
UpdateSummariesPropertiesState	Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. KnownUpdateSummariesPropertiesState can be used interchangeably with UpdateSummariesPropertiesState, this enum contains the known values that the service supports. Known values supported by the service Unknown: The update state is not known. AppliedSuccessfully: Updates have been successfully applied to the stamp. UpdateAvailable: Updates are available but have not yet been applied. UpdateInProgress: Updates are currently being applied to the stamp. UpdateFailed: The update process failed. NeedsAttention: The update process requires user intervention or has encountered issues needing attention. PreparationInProgress: Preparation for the update is currently in progress. PreparationFailed: Preparation for the update failed.
WindowsServerSubscription	Desired state of Windows Server Subscription. KnownWindowsServerSubscription can be used interchangeably with WindowsServerSubscription, this enum contains the known values that the service supports. Known values supported by the service Disabled: Windows Server Subscription is disabled. Enabled: Windows Server Subscription is enabled.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessLevel	Remote Support Access Level
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownArcExtensionState	Arc extension installation state.
KnownArcSettingAggregateState	Aggregate state of Arc agent across the nodes in this HCI cluster.
KnownAvailabilityType	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.
KnownClusterNodeType	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.
KnownClusterPattern	Supported Storage Pattern for HCI Cluster
KnownComplianceAssignmentType	Represents the compliance assignment type of a resource.
KnownComplianceStatus	Represents the compliance status of a resource.
KnownConnectivityStatus	Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeploymentMode	Deployment mode to trigger job.
KnownDeviceKind	Edge device kind.
KnownDeviceLogCollectionStatus	Represents the status of a log collection operation.
KnownDeviceState	The edge device state.
KnownDiagnosticLevel	Desired level of diagnostic data emitted by the cluster.
KnownDnsServerConfig	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.
KnownEceSecrets	Secret names allowed for Enterprise Cloud Engine (ECE) deployment.
KnownEdgeDeviceKind	Edge device kind.
KnownExtensionAggregateState	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.
KnownExtensionManagedBy	Indicates whether the extension is managed by the user or by Azure.
KnownHardwareClass	Hardware class of the cluster.
KnownHciEdgeDeviceJobType	Job Type supported.
KnownHealthState	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.
KnownIdentityProvider	Identity Provider for the cluster
KnownImdsAttestation	IMDS attestation status of the cluster.
KnownJobStatus	Represents the various statuses a job can have throughout its lifecycle.
KnownLogCollectionJobType	Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation.
KnownLogCollectionStatus	LogCollection status
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownNodeArcState	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.
KnownNodeExtensionState	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.
KnownOemActivation	OEM activation status of the cluster.
KnownOperationType	The intended operation for a cluster.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state of the ArcSetting proxy resource.
KnownRdmaCapability	Describes the RDMA capability of the network adapter.
KnownRebootRequirement	Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process.
KnownRemoteSupportAccessLevel	Defines the level of remote support access granted.
KnownRemoteSupportType	Remote Support Type for cluster
KnownSecretsType	Type of secrets to store
KnownServiceName	Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved.
KnownSeverity	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.
KnownSoftwareAssuranceIntent	Customer Intent for Software Assurance Benefit.
KnownSoftwareAssuranceStatus	Status of the Software Assurance for the cluster.
KnownState	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.
KnownStatus	Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster.
KnownStatusLevelTypes	The level code. Indicates the severity or importance of the status message.
KnownUpdateRunPropertiesState	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.
KnownUpdateSummariesPropertiesState	Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered.
KnownVersions	The available API versions.
KnownWindowsServerSubscription	Desired state of Windows Server Subscription.

Functions

restorePoller<TResponse, TResult>(AzureStackHCIClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AzureStackHCIClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AzureStackHCIClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AzureStackHCIClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>