@azure/arm-azurestackhci package

Classes

AzureStackHCIClient

Interfaces

ArcConnectivityProperties	Connectivity related configuration required by arc server.
ArcIdentityResponse	ArcIdentity details.
ArcSetting	ArcSetting details.
ArcSettingList	List of ArcSetting proxy resources for the HCI cluster.
ArcSettings	Interface representing a ArcSettings.
ArcSettingsConsentAndInstallDefaultExtensionsOptionalParams	Optional parameters.
ArcSettingsCreateIdentityOptionalParams	Optional parameters.
ArcSettingsCreateOptionalParams	Optional parameters.
ArcSettingsDeleteOptionalParams	Optional parameters.
ArcSettingsGeneratePasswordOptionalParams	Optional parameters.
ArcSettingsGetOptionalParams	Optional parameters.
ArcSettingsInitializeDisableProcessOptionalParams	Optional parameters.
ArcSettingsListByClusterNextOptionalParams	Optional parameters.
ArcSettingsListByClusterOptionalParams	Optional parameters.
ArcSettingsPatch	ArcSetting details to update.
ArcSettingsUpdateOptionalParams	Optional parameters.
AzureStackHCIClientOptionalParams	Optional parameters.
Cluster	Cluster details.
ClusterDesiredProperties	Desired properties of the cluster.
ClusterIdentityResponse	Cluster Identity details.
ClusterList	List of clusters.
ClusterNode	Cluster node details.
ClusterPatch	Cluster details to update.
ClusterReportedProperties	Properties reported by cluster agent.
Clusters	Interface representing a Clusters.
ClustersConfigureRemoteSupportHeaders	Defines headers for Clusters_configureRemoteSupport operation.
ClustersConfigureRemoteSupportOptionalParams	Optional parameters.
ClustersCreateIdentityOptionalParams	Optional parameters.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteOptionalParams	Optional parameters.
ClustersExtendSoftwareAssuranceBenefitOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupNextOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListBySubscriptionNextOptionalParams	Optional parameters.
ClustersListBySubscriptionOptionalParams	Optional parameters.
ClustersTriggerLogCollectionHeaders	Defines headers for Clusters_triggerLogCollection operation.
ClustersTriggerLogCollectionOptionalParams	Optional parameters.
ClustersUpdateOptionalParams	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.
DeploymentSettingListResult	The response of a DeploymentSetting list operation.
DeploymentSettingStorageAdapterIPInfo	The StorageAdapter physical nodes of a cluster.
DeploymentSettingStorageNetworks	The StorageNetworks of a cluster.
DeploymentSettingVirtualSwitchConfigurationOverrides	The VirtualSwitchConfigurationOverrides of a cluster.
DeploymentSettings	Interface representing a DeploymentSettings.
DeploymentSettingsCreateOrUpdateHeaders	Defines headers for DeploymentSettings_createOrUpdate operation.
DeploymentSettingsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentSettingsDeleteHeaders	Defines headers for DeploymentSettings_delete operation.
DeploymentSettingsDeleteOptionalParams	Optional parameters.
DeploymentSettingsGetOptionalParams	Optional parameters.
DeploymentSettingsListByClustersNextOptionalParams	Optional parameters.
DeploymentSettingsListByClustersOptionalParams	Optional parameters.
DeploymentStep	The Step of AzureStackHCI Cluster.
DeviceConfiguration	The device Configuration for edge device.
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.
EdgeDeviceListResult	The response of a EdgeDevice list operation.
EdgeDeviceProperties	Edge Device properties
EdgeDevices	Interface representing a EdgeDevices.
EdgeDevicesCreateOrUpdateHeaders	Defines headers for EdgeDevices_createOrUpdate operation.
EdgeDevicesCreateOrUpdateOptionalParams	Optional parameters.
EdgeDevicesDeleteHeaders	Defines headers for EdgeDevices_delete operation.
EdgeDevicesDeleteOptionalParams	Optional parameters.
EdgeDevicesGetOptionalParams	Optional parameters.
EdgeDevicesListNextOptionalParams	Optional parameters.
EdgeDevicesListOptionalParams	Optional parameters.
EdgeDevicesValidateHeaders	Defines headers for EdgeDevices_validate operation.
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. (This also follows the OData error response format.).
Extension	Details of a particular extension in HCI Cluster.
ExtensionInstanceView	Describes the Extension Instance View.
ExtensionInstanceViewStatus	Instance view status.
ExtensionList	List of Extensions in HCI cluster.
ExtensionPatch	Extension Details to update
ExtensionPatchParameters	Describes the properties of a Machine Extension that can be updated.
ExtensionProfile	Extensions details for edge device.
ExtensionUpgradeParameters	Describes the parameters for Extension upgrade.
Extensions	Interface representing a Extensions.
ExtensionsCreateOptionalParams	Optional parameters.
ExtensionsDeleteOptionalParams	Optional parameters.
ExtensionsGetOptionalParams	Optional parameters.
ExtensionsListByArcSettingNextOptionalParams	Optional parameters.
ExtensionsListByArcSettingOptionalParams	Optional parameters.
ExtensionsUpdateOptionalParams	Optional parameters.
ExtensionsUpgradeOptionalParams	Optional parameters.
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.
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.
HciNetworkProfile	The network profile of a device.
HciNicDetail	The NIC Detail of a device.
HciOsProfile	OS configurations for HCI device.
HciReportedProperties	The device Configuration 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.
LogCollectionError	Log Collection Error details of the cluster.
LogCollectionProperties	Log Collection properties of the cluster.
LogCollectionRequest	Log Collection Request
LogCollectionRequestProperties	Properties for Log Collection Request
LogCollectionSession	Log Collection Session details of the cluster.
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.
OfferList	List of Offer proxy resources for the HCI cluster.
Offers	Interface representing a Offers.
OffersGetOptionalParams	Optional parameters.
OffersListByClusterNextOptionalParams	Optional parameters.
OffersListByClusterOptionalParams	Optional parameters.
OffersListByPublisherNextOptionalParams	Optional parameters.
OffersListByPublisherOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
OptionalServices	The OptionalServices of AzureStackHCI Cluster.
PackageVersionInfo	Current version of each updatable component.
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
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
Publisher	Publisher details.
PublisherList	List of Publisher proxy resources for the HCI cluster.
Publishers	Interface representing a Publishers.
PublishersGetOptionalParams	Optional parameters.
PublishersListByClusterNextOptionalParams	Optional parameters.
PublishersListByClusterOptionalParams	Optional parameters.
QosPolicyOverrides	The QoSPolicyOverrides of a cluster.
RawCertificateData
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
ReportedProperties	Reported properties pushed from edge device.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
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.
SecurityComplianceStatus	Security compliance properties of the resource
SecuritySetting	Security settings proxy resource
SecuritySettingListResult	The response of a SecuritySetting list operation.
SecuritySettings	Interface representing a SecuritySettings.
SecuritySettingsCreateOrUpdateHeaders	Defines headers for SecuritySettings_createOrUpdate operation.
SecuritySettingsCreateOrUpdateOptionalParams	Optional parameters.
SecuritySettingsDeleteHeaders	Defines headers for SecuritySettings_delete operation.
SecuritySettingsDeleteOptionalParams	Optional parameters.
SecuritySettingsGetOptionalParams	Optional parameters.
SecuritySettingsListByClustersNextOptionalParams	Optional parameters.
SecuritySettingsListByClustersOptionalParams	Optional parameters.
ServiceConfiguration	Service configuration details
Sku	Sku details.
SkuList	List of SKU proxy resources for the HCI cluster.
SkuMappings	SKU Mapping details.
Skus	Interface representing a Skus.
SkusGetOptionalParams	Optional parameters.
SkusListByOfferNextOptionalParams	Optional parameters.
SkusListByOfferOptionalParams	Optional parameters.
SoftwareAssuranceChangeRequest
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
UpdateList	List of Updates
UpdatePrerequisite	If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
UpdateRun	Details of an Update run
UpdateRunList	List of Update runs
UpdateRuns	Interface representing a UpdateRuns.
UpdateRunsDeleteHeaders	Defines headers for UpdateRuns_delete operation.
UpdateRunsDeleteOptionalParams	Optional parameters.
UpdateRunsGetOptionalParams	Optional parameters.
UpdateRunsListNextOptionalParams	Optional parameters.
UpdateRunsListOptionalParams	Optional parameters.
UpdateRunsPutOptionalParams	Optional parameters.
UpdateSummaries	Get the update summaries for the cluster
UpdateSummariesDeleteHeaders	Defines headers for UpdateSummaries_delete operation.
UpdateSummariesDeleteOptionalParams	Optional parameters.
UpdateSummariesGetOptionalParams	Optional parameters.
UpdateSummariesList	List of Update Summaries
UpdateSummariesListNextOptionalParams	Optional parameters.
UpdateSummariesListOptionalParams	Optional parameters.
UpdateSummariesOperations	Interface representing a UpdateSummariesOperations.
UpdateSummariesPutOptionalParams	Optional parameters.
Updates	Interface representing a Updates.
UpdatesDeleteHeaders	Defines headers for Updates_delete operation.
UpdatesDeleteOptionalParams	Optional parameters.
UpdatesGetOptionalParams	Optional parameters.
UpdatesListNextOptionalParams	Optional parameters.
UpdatesListOptionalParams	Optional parameters.
UpdatesPostHeaders	Defines headers for Updates_post operation.
UpdatesPostOptionalParams	Optional parameters.
UpdatesPutOptionalParams	Optional parameters.
UploadCertificateRequest
UserAssignedIdentity	User assigned identity properties
ValidateRequest	The validate request for Edge Device.
ValidateResponse	An Accepted response with an Operation-Location header.

Type Aliases

AccessLevel	Defines values for AccessLevel. KnownAccessLevel can be used interchangeably with AccessLevel, this enum contains the known values that the service supports. Known values supported by the service Diagnostics DiagnosticsAndRepair
ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
ArcExtensionState	Defines values for ArcExtensionState. 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	Defines values for ArcSettingAggregateState. KnownArcSettingAggregateState can be used interchangeably with ArcSettingAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress Accepted Provisioning DisableInProgress
ArcSettingsConsentAndInstallDefaultExtensionsResponse	Contains response data for the consentAndInstallDefaultExtensions operation.
ArcSettingsCreateIdentityResponse	Contains response data for the createIdentity operation.
ArcSettingsCreateResponse	Contains response data for the create operation.
ArcSettingsGeneratePasswordResponse	Contains response data for the generatePassword operation.
ArcSettingsGetResponse	Contains response data for the get operation.
ArcSettingsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ArcSettingsListByClusterResponse	Contains response data for the listByCluster operation.
ArcSettingsUpdateResponse	Contains response data for the update operation.
AvailabilityType	Defines values for AvailabilityType. KnownAvailabilityType can be used interchangeably with AvailabilityType, this enum contains the known values that the service supports. Known values supported by the service Local Online Notify
ClusterNodeType	Defines values for ClusterNodeType. KnownClusterNodeType can be used interchangeably with ClusterNodeType, this enum contains the known values that the service supports. Known values supported by the service FirstParty ThirdParty
ClustersConfigureRemoteSupportResponse	Contains response data for the configureRemoteSupport operation.
ClustersCreateIdentityResponse	Contains response data for the createIdentity operation.
ClustersCreateResponse	Contains response data for the create operation.
ClustersExtendSoftwareAssuranceBenefitResponse	Contains response data for the extendSoftwareAssuranceBenefit operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ClustersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClustersListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ClustersListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ClustersTriggerLogCollectionResponse	Contains response data for the triggerLogCollection operation.
ClustersUpdateResponse	Contains response data for the update operation.
ComplianceAssignmentType	Defines values for ComplianceAssignmentType. 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	Defines values for ComplianceStatus. 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	Defines values for ConnectivityStatus. KnownConnectivityStatus can be used interchangeably with ConnectivityStatus, this enum contains the known values that the service supports. Known values supported by the service NotYetRegistered Connected NotConnectedRecently PartiallyConnected Disconnected NotSpecified
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeploymentMode	Defines values for DeploymentMode. 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.
DeploymentSettingsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DeploymentSettingsDeleteResponse	Contains response data for the delete operation.
DeploymentSettingsGetResponse	Contains response data for the get operation.
DeploymentSettingsListByClustersNextResponse	Contains response data for the listByClustersNext operation.
DeploymentSettingsListByClustersResponse	Contains response data for the listByClusters operation.
DeviceKind	Defines values for DeviceKind. 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.
DeviceState	Defines values for DeviceState. 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	Defines values for DiagnosticLevel. KnownDiagnosticLevel can be used interchangeably with DiagnosticLevel, this enum contains the known values that the service supports. Known values supported by the service Off Basic Enhanced
EceSecrets	Defines values for EceSecrets. 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.
EdgeDeviceUnion
EdgeDevicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
EdgeDevicesDeleteResponse	Contains response data for the delete operation.
EdgeDevicesGetResponse	Contains response data for the get operation.
EdgeDevicesListNextResponse	Contains response data for the listNext operation.
EdgeDevicesListResponse	Contains response data for the list operation.
EdgeDevicesValidateResponse	Contains response data for the validate operation.
ExtensionAggregateState	Defines values for ExtensionAggregateState. KnownExtensionAggregateState can be used interchangeably with ExtensionAggregateState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress Accepted Provisioning UpgradeFailedRollbackSucceeded
ExtensionManagedBy	Defines values for ExtensionManagedBy. KnownExtensionManagedBy can be used interchangeably with ExtensionManagedBy, this enum contains the known values that the service supports. Known values supported by the service User Azure
ExtensionsCreateResponse	Contains response data for the create operation.
ExtensionsGetResponse	Contains response data for the get operation.
ExtensionsListByArcSettingNextResponse	Contains response data for the listByArcSettingNext operation.
ExtensionsListByArcSettingResponse	Contains response data for the listByArcSetting operation.
ExtensionsUpdateResponse	Contains response data for the update operation.
HealthState	Defines values for HealthState. KnownHealthState can be used interchangeably with HealthState, this enum contains the known values that the service supports. Known values supported by the service Unknown Success Failure Warning Error InProgress
ImdsAttestation	Defines values for ImdsAttestation. KnownImdsAttestation can be used interchangeably with ImdsAttestation, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
LogCollectionJobType	Defines values for LogCollectionJobType. KnownLogCollectionJobType can be used interchangeably with LogCollectionJobType, this enum contains the known values that the service supports. Known values supported by the service OnDemand Scheduled
LogCollectionStatus	Defines values for LogCollectionStatus. KnownLogCollectionStatus can be used interchangeably with LogCollectionStatus, this enum contains the known values that the service supports. Known values supported by the service None InProgress Failed Succeeded
ManagedServiceIdentityType	Defines values for ManagedServiceIdentityType. KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned, UserAssigned
NodeArcState	Defines values for NodeArcState. KnownNodeArcState can be used interchangeably with NodeArcState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress Accepted Provisioning DisableInProgress
NodeExtensionState	Defines values for NodeExtensionState. KnownNodeExtensionState can be used interchangeably with NodeExtensionState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Canceled Failed Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress Accepted Provisioning
OemActivation	Defines values for OemActivation. KnownOemActivation can be used interchangeably with OemActivation, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
OffersGetResponse	Contains response data for the get operation.
OffersListByClusterNextResponse	Contains response data for the listByClusterNext operation.
OffersListByClusterResponse	Contains response data for the listByCluster operation.
OffersListByPublisherNextResponse	Contains response data for the listByPublisherNext operation.
OffersListByPublisherResponse	Contains response data for the listByPublisher operation.
OperationType	Defines values for OperationType. 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.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Error Succeeded Failed Canceled Connected Disconnected Deleted Creating Updating Deleting Moving PartiallySucceeded PartiallyConnected InProgress Accepted Provisioning DisableInProgress
PublishersGetResponse	Contains response data for the get operation.
PublishersListByClusterNextResponse	Contains response data for the listByClusterNext operation.
PublishersListByClusterResponse	Contains response data for the listByCluster operation.
RebootRequirement	Defines values for RebootRequirement. KnownRebootRequirement can be used interchangeably with RebootRequirement, this enum contains the known values that the service supports. Known values supported by the service Unknown True False
RemoteSupportType	Defines values for RemoteSupportType. KnownRemoteSupportType can be used interchangeably with RemoteSupportType, this enum contains the known values that the service supports. Known values supported by the service Enable Revoke
SecuritySettingsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SecuritySettingsDeleteResponse	Contains response data for the delete operation.
SecuritySettingsGetResponse	Contains response data for the get operation.
SecuritySettingsListByClustersNextResponse	Contains response data for the listByClustersNext operation.
SecuritySettingsListByClustersResponse	Contains response data for the listByClusters operation.
ServiceName	Defines values for ServiceName. KnownServiceName can be used interchangeably with ServiceName, this enum contains the known values that the service supports. Known values supported by the service WAC
Severity	Defines values for Severity. KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports. Known values supported by the service Critical Warning Informational Hidden
SkusGetResponse	Contains response data for the get operation.
SkusListByOfferNextResponse	Contains response data for the listByOfferNext operation.
SkusListByOfferResponse	Contains response data for the listByOffer operation.
SoftwareAssuranceIntent	Defines values for SoftwareAssuranceIntent. KnownSoftwareAssuranceIntent can be used interchangeably with SoftwareAssuranceIntent, this enum contains the known values that the service supports. Known values supported by the service Enable Disable
SoftwareAssuranceStatus	Defines values for SoftwareAssuranceStatus. KnownSoftwareAssuranceStatus can be used interchangeably with SoftwareAssuranceStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
State	Defines values for State. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service HasPrerequisite Obsolete Ready NotApplicableBecauseAnotherUpdateIsInProgress Preparing Installing Installed PreparationFailed InstallationFailed Invalid Recalled Downloading DownloadFailed HealthChecking HealthCheckFailed ReadyToInstall ScanInProgress ScanFailed AdditionalContentRequired
Status	Defines values for Status. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service NotYetRegistered ConnectedRecently NotConnectedRecently Disconnected Error NotSpecified ValidationInProgress ValidationSuccess ValidationFailed DeploymentInProgress DeploymentFailed DeploymentSuccess Succeeded Failed InProgress
StatusLevelTypes	Defines values for StatusLevelTypes. KnownStatusLevelTypes can be used interchangeably with StatusLevelTypes, this enum contains the known values that the service supports. Known values supported by the service Info Warning Error
UpdateRunPropertiesState	Defines values for UpdateRunPropertiesState. KnownUpdateRunPropertiesState can be used interchangeably with UpdateRunPropertiesState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded InProgress Failed
UpdateRunsGetResponse	Contains response data for the get operation.
UpdateRunsListNextResponse	Contains response data for the listNext operation.
UpdateRunsListResponse	Contains response data for the list operation.
UpdateRunsPutResponse	Contains response data for the put operation.
UpdateSummariesGetResponse	Contains response data for the get operation.
UpdateSummariesListNextResponse	Contains response data for the listNext operation.
UpdateSummariesListResponse	Contains response data for the list operation.
UpdateSummariesPropertiesState	Defines values for UpdateSummariesPropertiesState. KnownUpdateSummariesPropertiesState can be used interchangeably with UpdateSummariesPropertiesState, this enum contains the known values that the service supports. Known values supported by the service Unknown AppliedSuccessfully UpdateAvailable UpdateInProgress UpdateFailed NeedsAttention PreparationInProgress PreparationFailed
UpdateSummariesPutResponse	Contains response data for the put operation.
UpdatesGetResponse	Contains response data for the get operation.
UpdatesListNextResponse	Contains response data for the listNext operation.
UpdatesListResponse	Contains response data for the list operation.
UpdatesPutResponse	Contains response data for the put operation.
WindowsServerSubscription	Defines values for WindowsServerSubscription. KnownWindowsServerSubscription can be used interchangeably with WindowsServerSubscription, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled

Enums

KnownAccessLevel	Known values of AccessLevel that the service accepts.
KnownActionType	Known values of ActionType that the service accepts.
KnownArcExtensionState	Known values of ArcExtensionState that the service accepts.
KnownArcSettingAggregateState	Known values of ArcSettingAggregateState that the service accepts.
KnownAvailabilityType	Known values of AvailabilityType that the service accepts.
KnownClusterNodeType	Known values of ClusterNodeType that the service accepts.
KnownComplianceAssignmentType	Known values of ComplianceAssignmentType that the service accepts.
KnownComplianceStatus	Known values of ComplianceStatus that the service accepts.
KnownConnectivityStatus	Known values of ConnectivityStatus that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDeploymentMode	Known values of DeploymentMode that the service accepts.
KnownDeviceKind	Known values of DeviceKind that the service accepts.
KnownDeviceState	Known values of DeviceState that the service accepts.
KnownDiagnosticLevel	Known values of DiagnosticLevel that the service accepts.
KnownEceSecrets	Known values of EceSecrets that the service accepts.
KnownExtensionAggregateState	Known values of ExtensionAggregateState that the service accepts.
KnownExtensionManagedBy	Known values of ExtensionManagedBy that the service accepts.
KnownHealthState	Known values of HealthState that the service accepts.
KnownImdsAttestation	Known values of ImdsAttestation that the service accepts.
KnownLogCollectionJobType	Known values of LogCollectionJobType that the service accepts.
KnownLogCollectionStatus	Known values of LogCollectionStatus that the service accepts.
KnownManagedServiceIdentityType	Known values of ManagedServiceIdentityType that the service accepts.
KnownNodeArcState	Known values of NodeArcState that the service accepts.
KnownNodeExtensionState	Known values of NodeExtensionState that the service accepts.
KnownOemActivation	Known values of OemActivation that the service accepts.
KnownOperationType	Known values of OperationType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownRebootRequirement	Known values of RebootRequirement that the service accepts.
KnownRemoteSupportType	Known values of RemoteSupportType that the service accepts.
KnownServiceName	Known values of ServiceName that the service accepts.
KnownSeverity	Known values of Severity that the service accepts.
KnownSoftwareAssuranceIntent	Known values of SoftwareAssuranceIntent that the service accepts.
KnownSoftwareAssuranceStatus	Known values of SoftwareAssuranceStatus that the service accepts.
KnownState	Known values of State that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownStatusLevelTypes	Known values of StatusLevelTypes that the service accepts.
KnownUpdateRunPropertiesState	Known values of UpdateRunPropertiesState that the service accepts.
KnownUpdateSummariesPropertiesState	Known values of UpdateSummariesPropertiesState that the service accepts.
KnownWindowsServerSubscription	Known values of WindowsServerSubscription that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.