@azure/arm-networkcloud package

AadConfiguration represents the Azure Active Directory Integration properties.

AccessBridge represents a managed access bridge resource.

AccessBridgeEndpoint describes a single advertised service endpoint.

AccessBridgePatchParameters represents the payload for a PATCH request to an access bridge.

AccessBridgePatchProperties identifies the mutable properties for patch operations.

AccessBridgeProperties captures the input and status for an access bridge.

AccessBridgeSecurityRule captures an individual access rule enforced by the bridge.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AccessBridges operations.

Optional parameters.

ActionState represents the state of an action taken against a resource. This can be used to represent both explicitly and implicitly defined action types.

AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.

AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.

AdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.

AgentOptions are configurations that will be applied to each agent in an agent pool.

AgentPool represents the agent pool of Kubernetes cluster.

AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool.

AgentPoolPatchProperties represents the properties of an agent pool that can be modified.

AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.

AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AgentPools operations.

Optional parameters.

AnalyticsOutputSettings represents the settings for the log analytics workspace used for output of logs from this cluster.

AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.

AvailableUpgrade represents an upgrade available for a Kubernetes cluster.

BareMetalMachine represents the physical machine in the rack.

BareMetalMachineCommandSpecification represents the command and optional arguments to exercise against the bare metal machine.

BareMetalMachineConfigurationData represents configuration for the bare metal machine.

BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine.

BareMetalMachineKeySet represents the bare metal machine key set.

BareMetalMachineKeySetPatchParameters represents the body of the request to patch the bare metal machine key set.

BareMetalMachineKeySetPatchProperties represents the properties of bare metal machine key set that can be patched.

BareMetalMachineKeySetProperties represents the properties of bare metal machine key set.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BareMetalMachineKeySets operations.

Optional parameters.

BareMetalMachineMonitoringConfigurationStatus represents the monitoring configuration status of the bare metal machine.

BareMetalMachinePatchParameters represents the body of the request to patch bare metal machine properties.

BareMetalMachinePatchProperties represents the properties of the bare metal machine that can be patched.

BareMetalMachinePowerOffParameters represents the body of the request to power off bare metal machine.

BareMetalMachineProperties represents the properties of a bare metal machine.

BareMetalMachineReimageParameters represents the body of the request to reimage a bare metal machine.

BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another.

BareMetalMachineRunCommandParameters represents the body of the request to execute a script on the bare metal machine.

BareMetalMachineRunDataExtractsParameters represents the body of request containing list of curated data extraction commands to run on the bare metal machine.

BareMetalMachineRunReadCommandsParameters represents the body of request containing list of read-only commands to run on the bare metal machine.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BareMetalMachines operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

BgpAdvertisement represents the association of IP address pools to the communities and peers.

BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.

BmcKeySet represents the baseboard management controller key set.

BmcKeySetPatchParameters represents the body of the request to patch the baseboard management controller key set.

BmcKeySetPatchProperties represents the properties of baseboard management controller key set that are patchable.

BmcKeySetProperties represents the properties of baseboard management controller key set.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BmcKeySets operations.

Optional parameters.

CertificateInfo represents the non-private information of an X.509 Certificate.

Upon creation, the additional services that are provided by the platform will be allocated and represented in the status of this resource. All resources associated with this cloud services network will be part of the same layer 2 (L2) isolation domain. At least one service network must be created but may be reused across many virtual machines and/or Hybrid AKS clusters.

CloudServicesNetworkPatchParameters represents the body of the request to patch the cloud services network.

CloudServicesNetworkPatchProperties represents the properties of the cloud services network that can be updated using a patch request.

CloudServicesNetworkProperties represents properties of the cloud services network.

CloudServicesNetworkStorageOptions represents the storage options for the cloud services network.

CloudServicesNetworkStorageOptionsPatch represents the patchable storage options for the cloud services network.

CloudServicesNetworkStorageStatus represents the storage status of the cloud services network.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CloudServicesNetworks operations.

Optional parameters.

Cluster represents the on-premises Network Cloud cluster.

ClusterAvailableUpgradeVersion represents the various cluster upgrade parameters.

ClusterAvailableVersion represents the cluster version that the cluster manager can be asked to create and manage.

ClusterCapacity represents various details regarding compute capacity.

ClusterContinueUpdateVersionParameters represents the body of the request to continue the update of a cluster version.

ClusterDeployParameters represents the body of the request to deploy cluster.

ClusterInspectParameters represents the body of the request to inspect the cluster.

ClusterManager represents a control-plane to manage one or more on-premises clusters.

ClusterManagerPatchParameters represents the body of the request to patch the cluster properties.

ClusterManagerProperties represents the properties of a cluster manager.

ClusterManagerRelayConfiguration represents the relay configuration for the cluster manager.

ClusterManagerUpdateRelayPrivateEndpointConnectionParameters represents the body of the request to approve or reject the relay private endpoint connection for the private relay managed by a cluster manager.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ClusterManagers operations.

Optional parameters.

Optional parameters.

ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster.

ClusterMetricsConfigurationPatchParameters represents the body of the request to patch the metrics configuration of cluster.

ClusterMetricsConfigurationPatchProperties represents the properties of metrics configuration for the cluster for patching.

ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster.

ClusterPatchParameters represents the body of the request to patch the cluster properties.

ClusterPatchProperties represents the properties of the cluster for patching.

ClusterProperties represents the properties of a cluster.

ClusterRotateCredentialParameters represents the body of the request to rotate cluster credentials.

ClusterScanRuntimeParameters defines the parameters for the cluster scan runtime operation.

ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.

ClusterUpdateStrategy represents the strategy for updating the cluster.

ClusterUpdateVersionParameters represents the body of the request to update cluster version.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Clusters operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

CommandOutputOverride represents an overridden value for the command output settings.

CommandOutputSettings represents the settings for commands run within the cluster such as bare metal machine run read-only commands.

Console represents the console of an on-premises Network Cloud virtual machine.

ConsolePatchParameters represents the body of the request to patch the virtual machine console.

ConsolePatchProperties represents the properties of the virtual machine console that can be patched.

ConsoleProperties represents the properties of the virtual machine console.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Consoles operations.

Optional parameters.

ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.

ControlPlaneNodePatchConfiguration represents the properties of the control plane that can be patched for this Kubernetes cluster.

EgressEndpoint represents the connection from a cloud services network to the specified endpoint for a common purpose.

EndpointDependency represents the definition of an endpoint, including the domain and details.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

The complex type of the extended location.

FeatureStatus contains information regarding a Kubernetes cluster feature.

FilterDevices defines the filtered target of the inspection.

HardwareInventory represents the hardware configuration of this machine as exposed to the customer, including information acquired from the model/sku information and from the ironic inspector.

HardwareInventoryNetworkInterface represents the network interface details as part of a hardware inventory.

HardwareValidationStatus represents the latest hardware validation details performed for this bare metal machine.

IdentitySelector represents the selection of a managed identity for use.

ImageRepositoryCredentials represents the credentials used to login to the image repository.

InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.

IpAddressPool represents a pool of IP addresses that can be allocated to a service.

KeySetUser represents the properties of the user in the key set.

KeySetUserStatus represents the status of the key set user.

KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.

KubernetesClusterFeature represents the feature of a Kubernetes cluster.

KubernetesClusterFeaturePatchParameters represents the body of the request to patch the Kubernetes cluster feature.

KubernetesClusterFeaturePatchProperties represents the Kubernetes cluster feature properties for patching.

KubernetesClusterFeatureProperties represents the properties of a Kubernetes cluster feature.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a KubernetesClusterFeatures operations.

Optional parameters.

KubernetesClusterNode represents the details of a node in a Kubernetes cluster.

KubernetesClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster.

KubernetesClusterPatchProperties represents the properties of the Kubernetes cluster that can be patched.

KubernetesClusterProperties represents the properties of Kubernetes cluster resource.

KubernetesClusterRestartNodeParameters represents the body of the request to restart the node of a Kubernetes cluster.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a KubernetesClusters operations.

Optional parameters.

Optional parameters.

KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.

KubernetesVersion represents the available Kubernetes versions for a cluster.

KubernetesVersionPatchParameters represents the body of the request to patch Kubernetes version tags.

KubernetesVersionProperties contains the read-only properties describing available versions.

KubernetesVersionValue describes a specific Kubernetes version that can be deployed.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a KubernetesVersions operations.

Optional parameters.

L2Network represents a network that utilizes a single isolation domain set up for layer-2 resources.

L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.

L2NetworkPatchParameters represents the body of the request to patch the L2 network.

L2NetworkProperties represents properties of the L2 network.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a L2Networks operations.

Optional parameters.

L2ServiceLoadBalancerConfiguration represents the configuration of a layer 2 service load balancer.

L3Network represents a network that utilizes a single isolation domain set up for layer-3 resources.

L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.

L3NetworkPatchParameters represents the body of the request to patch the cloud services network.

L3NetworkProperties represents properties of the L3 network.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a L3Networks operations.

Optional parameters.

Type Deprecated. Will be removed in an upcoming version. LldpNeighbor represents the details about the device connected to the NIC.

MachineDisk represents the properties of the disk.

MachineSkuProperties represents the properties of the machine SKU.

MachineSkuSlot represents a single SKU and rack slot associated with the machine.

ManagedResourceGroupConfiguration represents the configuration of the resource group managed by Azure.

Managed service identity (system assigned and/or user assigned identities)

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a MetricsConfigurations operations.

Optional parameters.

NetworkAttachment represents the single network attachment.

Optional parameters for the client.

NetworkConfiguration specifies the Kubernetes cluster network related configuration.

NetworkInterface represents properties of the network interface.

Type Deprecated. Will be removed in an upcoming version. Nic represents the network interface card details.

NodePoolAdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for an operation.

The current status of an async operation.

OperationStatusResultProperties represents additional properties of the operation status result.

Optional parameters.

Interface representing a Operations operations.

OsDisk represents configuration of the boot disk.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Rack represents the hardware of the rack and is dependent upon the cluster for lifecycle.

RackDefinition represents details regarding the rack.

RackPatchParameters represents the body of the request to patch the rack properties.

RackProperties represents the properties of the rack.

RackSku represents the SKU information of the rack.

RackSkuProperties represents the properties of compute-related hardware for a rack. This supports both aggregator and compute racks.

Optional parameters.

Optional parameters.

Interface representing a RackSkus operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Racks operations.

RacksPatchProperties represents the properties of the rack during patching.

Optional parameters.

Common fields that are returned in the response for all Azure Resource Manager resources

RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.

RuntimeProtectionStatus represents the runtime protection status of the bare metal machine.

SecretArchiveReference represents the reference to a secret in a key vault.

SecretArchiveSettings represents the settings for the secret archive used to hold credentials for the cluster.

SecretRotationStatus represents the status of a secret rotation.

ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.

ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.

A simple poller that can be used to poll a long running operation.

SshPublicKey represents the public key used to authenticate with a resource through SSH.

StepState represents the state of a step in an action.

StorageAppliance represents on-premises Network Cloud storage appliance.

StorageApplianceCommandSpecification represents the command and optional arguments to run.

StorageApplianceConfigurationData represents configuration for the storage application.

StorageApplianceEnableRemoteVendorManagementParameters represents the body of the request to enable remote vendor management of a storage appliance.

StorageApplianceExpansionShelf represents an expansion shelf connected to a storage appliance.

The monitoring configuration status of the storage appliance.

StorageAppliancePatchParameters represents the body of the request to patch storage appliance properties.

StorageAppliancePatchProperties represents the properties of the storage appliance that can be patched.

StorageApplianceProperties represents the properties of the storage appliance.

StorageApplianceRunReadCommandsParameters represents the body of request containing list of read-only commands to run on the storage appliance.

StorageApplianceSkuProperties represents the properties of the storage appliance SKU.

StorageApplianceSkuSlot represents the single SKU and rack slot associated with the storage appliance.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a StorageAppliances operations.

Optional parameters.

Optional parameters.

StorageProfile represents information about a disk.

StringKeyValuePair represents a single entry in a mapping of keys to values.

Metadata pertaining to creation and last modification of the resource.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

TrunkedNetwork represents a network that utilizes multiple isolation domains and specified VLANs to create a trunked network.

TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.

TrunkedNetworkPatchParameters represents the body of the request to patch the Trunked network.

TrunkedNetworkProperties represents properties of the trunked network.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a TrunkedNetworks operations.

Optional parameters.

User assigned identity properties

ValidationThreshold indicates allowed machine and node hardware and deployment failures.

VirtualMachine represents the on-premises Network Cloud virtual machine.

VirtualMachineAssignRelayParameters represents the body of the request to update the relay used for a Microsoft.HybridCompute machine associated with the virtual machine.

VirtualMachinePatchParameters represents the body of the request to patch the virtual machine.

VirtualMachinePatchProperties represents the properties of the virtual machine that can be patched.

VirtualMachinePlacementHint represents a single scheduling hint of the virtual machine.

VirtualMachinePowerOffParameters represents the body of the request to power off virtual machine.

VirtualMachineProperties represents the properties of the virtual machine.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachines operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Volume represents storage made available for use by resources running on the cluster.

VolumePatchParameters represents the body of the request to patch the volume resource.

VolumeProperties represents properties of the volume resource.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Volumes operations.

Optional parameters.

VulnerabilityScanningSettings represents the settings for how security vulnerability scanning is applied to the cluster.

VulnerabilityScanningSettingsPatch represents the settings for how security vulnerability scanning is applied to the cluster.

The allowed names for the access bridge.
KnownAccessBridgeAllowedName can be used interchangeably with AccessBridgeAllowedName, this enum contains the known values that the service supports.

Known values supported by the service

Bastion: The access bridge for bare metal machine bastion access.
PrivateVault: The access bridge for cluster access to private vault.
StorageDashboard: The access bridge for access to the storage dashboard.

The detailed status reported by the access bridge.
KnownAccessBridgeDetailedStatus can be used interchangeably with AccessBridgeDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Running: The access bridge is healthy and operating normally.
Degraded: The access bridge is experiencing degraded performance or partial outages.
Failed: The access bridge is not operational.

The provisioning state of the access bridge.
KnownAccessBridgeProvisioningState can be used interchangeably with AccessBridgeProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Failed: The Failed status.
Provisioning: The Provisioning status.
Succeeded: The Succeeded status.

The status of the action.
KnownActionStateStatus can be used interchangeably with ActionStateStatus, this enum contains the known values that the service supports.

Known values supported by the service

Completed: The completed status.
InProgress: The in-progress status.
Failed: The failed status.

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.

The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.
KnownAdvertiseToFabric can be used interchangeably with AdvertiseToFabric, this enum contains the known values that the service supports.

Known values supported by the service

True: Advertise to fabric
False: Do not advertise to fabric

The current status of the agent pool.
KnownAgentPoolDetailedStatus can be used interchangeably with AgentPoolDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The Available status.
Error: The Error status.
Provisioning: The Provisioning status.

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
KnownAgentPoolMode can be used interchangeably with AgentPoolMode, this enum contains the known values that the service supports.

Known values supported by the service

System: System agent pool
User: User agent pool
NotApplicable: Not applicable

The provisioning state of the agent pool.
KnownAgentPoolProvisioningState can be used interchangeably with AgentPoolProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Deleting: The Deleting status.
Failed: The Failed status.
InProgress: The InProgress status.
Succeeded: The Succeeded status.
Updating: The Updating status.

The version lifecycle indicator.
KnownAvailabilityLifecycle can be used interchangeably with AvailabilityLifecycle, this enum contains the known values that the service supports.

Known values supported by the service

Preview: Preview availability
GenerallyAvailable: Generally available

The supported values for cloud setting as a string literal type

The cordon status of the bare metal machine.
KnownBareMetalMachineCordonStatus can be used interchangeably with BareMetalMachineCordonStatus, this enum contains the known values that the service supports.

Known values supported by the service

Cordoned: The bare metal machine is cordoned.
Uncordoned: The bare metal machine is uncordoned.

The more detailed status of the bare metal machine.
KnownBareMetalMachineDetailedStatus can be used interchangeably with BareMetalMachineDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Preparing: The Preparing status.
Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.
Provisioned: The Provisioned status.
Deprovisioning: The Deprovisioning status.

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.
KnownBareMetalMachineEvacuate can be used interchangeably with BareMetalMachineEvacuate, this enum contains the known values that the service supports.

Known values supported by the service

True: Evacuate workloads from the node when the bare metal machine is cordoned.
False: Do not evacuate workloads from the node when the bare metal machine is cordoned.

The outcome of the hardware validation.
KnownBareMetalMachineHardwareValidationResult can be used interchangeably with BareMetalMachineHardwareValidationResult, this enum contains the known values that the service supports.

Known values supported by the service

Pass: The hardware validation passed.
Fail: The hardware validation failed.

The more detailed status of the key set.
KnownBareMetalMachineKeySetDetailedStatus can be used interchangeably with BareMetalMachineKeySetDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

AllActive: All users in the key set are active.
SomeInvalid: Some users in the key set are invalid.
AllInvalid: All users in the key set are invalid.
Validating: Key set is being validated.

The access level allowed for the users in this key set.
KnownBareMetalMachineKeySetPrivilegeLevel can be used interchangeably with BareMetalMachineKeySetPrivilegeLevel, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard access level.
Superuser: Superuser access level.
Other: Other access level.

The provisioning state of the bare metal machine key set.
KnownBareMetalMachineKeySetProvisioningState can be used interchangeably with BareMetalMachineKeySetProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
Provisioning: The Provisioning status.

The indicator of whether the user is currently deployed for access.
KnownBareMetalMachineKeySetUserSetupStatus can be used interchangeably with BareMetalMachineKeySetUserSetupStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: The user is currently active.
Invalid: The user is not valid and has no access.

The log level for the monitoring configuration status of the bare metal machine.
KnownBareMetalMachineMetricsConfigurationStatusLogLevel can be used interchangeably with BareMetalMachineMetricsConfigurationStatusLogLevel, this enum contains the known values that the service supports.

Known values supported by the service

Default: Logs are emitted at the default log level.
Nexus: Logs are emitted at the Nexus log level.

The metrics level for the monitoring configuration status of the bare metal machine.
KnownBareMetalMachineMetricsConfigurationStatusMetricsLevel can be used interchangeably with BareMetalMachineMetricsConfigurationStatusMetricsLevel, this enum contains the known values that the service supports.

Known values supported by the service

Default: Metrics are emitted at the default metrics level.
Nexus: Metrics are emitted at the Nexus metrics level.

The power state derived from the baseboard management controller.
KnownBareMetalMachinePowerState can be used interchangeably with BareMetalMachinePowerState, this enum contains the known values that the service supports.

Known values supported by the service

On: The bare metal machine was marked as powered on in the latest check of the baseboard management controller.
Off: The bare metal machine was marked as powered off in the latest check of the baseboard management controller.

The provisioning state of the bare metal machine.
KnownBareMetalMachineProvisioningState can be used interchangeably with BareMetalMachineProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The indicator of whether the bare metal machine is ready to receive workloads.
KnownBareMetalMachineReadyState can be used interchangeably with BareMetalMachineReadyState, this enum contains the known values that the service supports.

Known values supported by the service

True: The bare metal machine is ready to receive workloads.
False: The bare metal machine is not ready to receive workloads.

The safeguard mode to use for the reimage action, where None indicates to bypass safeguards and All indicates to utilize all safeguards.
KnownBareMetalMachineReimageSafeguardMode can be used interchangeably with BareMetalMachineReimageSafeguardMode, this enum contains the known values that the service supports.

Known values supported by the service

All: Run all pre‑operation validation checks before performing the reimage. If any check fails, the request is rejected and no changes are made.
None: Skip all safeguards and perform the reimage without running pre‑operation validation checks.

The safeguard mode to use for the replace action, where None indicates to bypass safeguards and All indicates to utilize all safeguards.
KnownBareMetalMachineReplaceSafeguardMode can be used interchangeably with BareMetalMachineReplaceSafeguardMode, this enum contains the known values that the service supports.

Known values supported by the service

All: All safeguards will be utilized during the replace action.
None: No safeguards will be utilized during the replace action.

The indicator of whether to bypass clearing storage while replacing a bare metal machine.
KnownBareMetalMachineReplaceStoragePolicy can be used interchangeably with BareMetalMachineReplaceStoragePolicy, this enum contains the known values that the service supports.

Known values supported by the service

Preserve: Storage will be preserved and not cleared during the replace action.
DiscardAll: Storage will be cleared during the replace action.

The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.
KnownBareMetalMachineSkipShutdown can be used interchangeably with BareMetalMachineSkipShutdown, this enum contains the known values that the service supports.

Known values supported by the service

True: Skip the graceful OS shutdown and power off the bare metal machine immediately.
False: Do not skip the graceful OS shutdown and power off the bare metal machine immediately.

The indicator to determine if automatic allocation from the pool should occur.
KnownBfdEnabled can be used interchangeably with BfdEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: BFD is enabled for this BGP peer.
False: BFD is disabled for this BGP peer.

The indicator to enable multi-hop peering support.
KnownBgpMultiHop can be used interchangeably with BgpMultiHop, this enum contains the known values that the service supports.

Known values supported by the service

True: Enable multi-hop peering support.
False: Disable multi-hop peering support.

The more detailed status of the key set.
KnownBmcKeySetDetailedStatus can be used interchangeably with BmcKeySetDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

AllActive: The AllActive status.
SomeInvalid: The SomeInvalid status.
AllInvalid: The AllInvalid status.
Validating: The Validating status.

The access level allowed for the users in this key set.
KnownBmcKeySetPrivilegeLevel can be used interchangeably with BmcKeySetPrivilegeLevel, this enum contains the known values that the service supports.

Known values supported by the service

ReadOnly: ReadOnly privilege level
Administrator: Administrator privilege level

The provisioning state of the baseboard management controller key set.
KnownBmcKeySetProvisioningState can be used interchangeably with BmcKeySetProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
Provisioning: The Provisioning status.

The type of bootstrap protocol used.
KnownBootstrapProtocol can be used interchangeably with BootstrapProtocol, this enum contains the known values that the service supports.

Known values supported by the service

PXE: PXE bootstrap protocol

The more detailed status of the cloud services network.
KnownCloudServicesNetworkDetailedStatus can be used interchangeably with CloudServicesNetworkDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.

The indicator of whether the platform default endpoints are allowed for the egress traffic.
KnownCloudServicesNetworkEnableDefaultEgressEndpoints can be used interchangeably with CloudServicesNetworkEnableDefaultEgressEndpoints, this enum contains the known values that the service supports.

Known values supported by the service

True: Enable default egress endpoints.
False: Disable default egress endpoints.

The provisioning state of the cloud services network.
KnownCloudServicesNetworkProvisioningState can be used interchangeably with CloudServicesNetworkProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The indicator to enable shared storage on the cloud services network. If not specified, the allocation will align with the standard storage enablement.
KnownCloudServicesNetworkStorageMode can be used interchangeably with CloudServicesNetworkStorageMode, this enum contains the known values that the service supports.

Known values supported by the service

None: No shared storage.
Standard: Standard shared storage.

The status of the storage allocation for the cloud services network.
KnownCloudServicesNetworkStorageStatusStatus can be used interchangeably with CloudServicesNetworkStorageStatusStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The storage allocation is available
ExpandingVolume: The storage allocation is expanding the volume.
ExpansionFailed: The expansion of the storage allocation has failed.
Initializing: The storage allocation is initializing.
None: The storage allocation has no status.
Repairing: The storage allocation is being repaired.

The latest heartbeat status between the cluster manager and the cluster.
KnownClusterConnectionStatus can be used interchangeably with ClusterConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Connected: The latest heartbeat status is healthy.
Disconnected: The latest heartbeat status is unhealthy.
Timeout: Too many of the latest heartbeats were missed.
Undefined: Could not determine the latest heartbeat status.

The mode by which the cluster will target the next grouping of servers to continue the update.
KnownClusterContinueUpdateVersionMachineGroupTargetingMode can be used interchangeably with ClusterContinueUpdateVersionMachineGroupTargetingMode, this enum contains the known values that the service supports.

Known values supported by the service

AlphaByRack: Racks will be targeted for update in alphabetical order based on the rack name.

ClusterContinueUpdateVersionSafeguardMode represents the mode of the cluster continue update safeguards.
KnownClusterContinueUpdateVersionSafeguardMode can be used interchangeably with ClusterContinueUpdateVersionSafeguardMode, this enum contains the known values that the service supports.

Known values supported by the service

All: Run all pre‑operation validation checks before continuing the version update. If any check fails, the request is rejected and no changes are made.
None: Skip all safeguards and continue the version update without running pre‑operation validation checks.

The current detailed status of the cluster.
KnownClusterDetailedStatus can be used interchangeably with ClusterDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

PendingDeployment: The PendingDeployment status.
Deploying: The Deploying status.
Running: The Running status.
Updating: The Updating status.
UpdatePaused: The UpdatePaused status.
Degraded: The Degraded status.
Deleting: The Deleting status.
Disconnected: The Disconnected status.
Failed: The Failed status.

Additional actions supplement the default non-disruptive cluster inspection. Additional actions may be disallowed if the cluster is in a deployed and running state.
KnownClusterInspectAdditionalAction can be used interchangeably with ClusterInspectAdditionalAction, this enum contains the known values that the service supports.

Known values supported by the service

ResetHardware: Indicates that hardware reset should be performed during inspection.

The latest connectivity status between cluster manager and the cluster.
KnownClusterManagerConnectionStatus can be used interchangeably with ClusterManagerConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Connected: The latest connectivity status is healthy.
Unreachable: Connectivity could not be established.

The detailed status that provides additional information about the cluster manager.
KnownClusterManagerDetailedStatus can be used interchangeably with ClusterManagerDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.
ProvisioningFailed: The ProvisioningFailed status.
Updating: The Updating status.
UpdateFailed: The UpdateFailed status.

The provisioning state of the cluster manager.
KnownClusterManagerProvisioningState can be used interchangeably with ClusterManagerProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.
Updating: The Updating status.

The more detailed status of the metrics configuration.
KnownClusterMetricsConfigurationDetailedStatus can be used interchangeably with ClusterMetricsConfigurationDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Processing: The Processing status.
Applied: The Applied status.
Error: The Error status.

The provisioning state of the metrics configuration.
KnownClusterMetricsConfigurationProvisioningState can be used interchangeably with ClusterMetricsConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
Provisioning: The Provisioning status.

The provisioning state of the cluster.
KnownClusterProvisioningState can be used interchangeably with ClusterProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
Validating: The Validating status.
Updating: The Updating status.

The choice of if the scan operation should run the scan.
KnownClusterScanRuntimeParametersScanActivity can be used interchangeably with ClusterScanRuntimeParametersScanActivity, this enum contains the known values that the service supports.

Known values supported by the service

Scan: Scan the cluster.
Skip: Do not scan the cluster.

The indicator if the specified key vault should be used to archive the secrets of the cluster.
KnownClusterSecretArchiveEnabled can be used interchangeably with ClusterSecretArchiveEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: Enable the cluster secret archive with the specified key vault.
False: Disable use of the cluster secret archive even if a key vault is specified.

The type of rack configuration for the cluster.
KnownClusterType can be used interchangeably with ClusterType, this enum contains the known values that the service supports.

Known values supported by the service

SingleRack: Single rack configuration.
MultiRack: Multi-rack configuration.

The mode of operation for runtime protection.
KnownClusterUpdateStrategyType can be used interchangeably with ClusterUpdateStrategyType, this enum contains the known values that the service supports.

Known values supported by the service

Rack: Update the cluster in rack-by-rack increments.
PauseAfterRack: Pause after each rack is updated.

ClusterUpdateVersionSafeguardMode represents the mode of the cluster update safeguards.
KnownClusterUpdateVersionSafeguardMode can be used interchangeably with ClusterUpdateVersionSafeguardMode, this enum contains the known values that the service supports.

Known values supported by the service

All: Run all pre‑operation validation checks before performing the version update. If any check fails, the request is rejected and no changes are made.
None: Skip all safeguards and perform the version update without running pre‑operation validation checks.

The type of command output for the override.
KnownCommandOutputType can be used interchangeably with CommandOutputType, this enum contains the known values that the service supports.

Known values supported by the service

BareMetalMachineRunCommand: BareMetalMachineRunCommand output type
BareMetalMachineRunDataExtracts: BareMetalMachineRunDataExtracts output type
BareMetalMachineRunReadCommands: BareMetalMachineRunReadCommands output type
ClusterSupportAdministrativeActions: ClusterSupportAdministrativeActions output type supporting administrative actions that can be run on a cluster for support purposes.
StorageRunReadCommands: StorageRunReadCommands output type
BareMetalMachineRunDataExtractsRestricted: BareMetalMachineRunDataExtractsRestricted output type

The more detailed status of the console.
KnownConsoleDetailedStatus can be used interchangeably with ConsoleDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Ready: The Ready status.
Error: The Error status.

The indicator of whether the console access is enabled.
KnownConsoleEnabled can be used interchangeably with ConsoleEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: Console access enabled
False: Console access disabled

The provisioning state of the virtual machine console.
KnownConsoleProvisioningState can be used interchangeably with ConsoleProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
Provisioning: The Provisioning status.

An interface that describes a page of results.

The indicator of whether the control plane will be impacted during the upgrade.
KnownControlImpact can be used interchangeably with ControlImpact, this enum contains the known values that the service supports.

Known values supported by the service

True: The control plane will be impacted during the upgrade.
False: The control plane will not be impacted during the upgrade.

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.

The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.
KnownDefaultGateway can be used interchangeably with DefaultGateway, this enum contains the known values that the service supports.

Known values supported by the service

True: This is the default gateway.
False: This is not the default gateway.

The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager.
KnownDeploymentType can be used interchangeably with DeploymentType, this enum contains the known values that the service supports.

Known values supported by the service

Nexus: Azure Operator Nexus
AzureLocal: Azure Local

The connection type of the device.
KnownDeviceConnectionType can be used interchangeably with DeviceConnectionType, this enum contains the known values that the service supports.

Known values supported by the service

PCI: PCI connection type

The disk type of rack SKU resource.
KnownDiskType can be used interchangeably with DiskType, this enum contains the known values that the service supports.

Known values supported by the service

HDD: HDD disk type
SSD: SSD disk type

The supported ExtendedLocation types.
KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone: Azure Edge Zones location type
CustomLocation: Azure Custom Locations type

The indicator to specify if the load balancer peers with the network fabric.
KnownFabricPeeringEnabled can be used interchangeably with FabricPeeringEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: Enable fabric peering.
False: Disable fabric peering.

The status representing the state of this feature.
KnownFeatureDetailedStatus can be used interchangeably with FeatureDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Running: The Running status.
Failed: The Failed status.
Unknown: The Unknown status.

The size of the hugepages to allocate.
KnownHugepagesSize can be used interchangeably with HugepagesSize, this enum contains the known values that the service supports.

Known values supported by the service

2M: 2M hugepages
1G: 1G hugepages

Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
KnownHybridAksIpamEnabled can be used interchangeably with HybridAksIpamEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: Hybrid AKS IPAM allocation is enabled.
False: Hybrid AKS IPAM allocation is disabled.

Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
KnownHybridAksPluginType can be used interchangeably with HybridAksPluginType, this enum contains the known values that the service supports.

Known values supported by the service

DPDK: The DPDK plugin type.
SRIOV: The SRIOV plugin type.
OSDevice: The OSDevice plugin type.

The type of the IP address allocation, defaulted to "DualStack".
KnownIpAllocationType can be used interchangeably with IpAllocationType, this enum contains the known values that the service supports.

Known values supported by the service

IPV4: The IPV4 address allocation type.
IPV6: The IPV6 address allocation type.
DualStack: The DualStack address allocation type.

The current status of the Kubernetes cluster.
KnownKubernetesClusterDetailedStatus can be used interchangeably with KubernetesClusterDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The Available status.
Error: The Error status.
Provisioning: The Provisioning status.

The lifecycle indicator of the feature.
KnownKubernetesClusterFeatureAvailabilityLifecycle can be used interchangeably with KubernetesClusterFeatureAvailabilityLifecycle, this enum contains the known values that the service supports.

Known values supported by the service

Preview: Preview availability
GenerallyAvailable: Generally available

The detailed status of the feature.
KnownKubernetesClusterFeatureDetailedStatus can be used interchangeably with KubernetesClusterFeatureDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Provisioning: The Provisioning status.
Installed: The Installed status.

The provisioning state of the Kubernetes cluster feature.
KnownKubernetesClusterFeatureProvisioningState can be used interchangeably with KubernetesClusterFeatureProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Deleting: The Deleting status.
Failed: The Failed status.
Succeeded: The Succeeded status.
Updating: The Updating status.

The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle.
KnownKubernetesClusterFeatureRequired can be used interchangeably with KubernetesClusterFeatureRequired, this enum contains the known values that the service supports.

Known values supported by the service

True: A required feature.
False: An optional feature.

The detailed state of this node.
KnownKubernetesClusterNodeDetailedStatus can be used interchangeably with KubernetesClusterNodeDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The Available status.
Error: The Error status.
Provisioning: The Provisioning status.
Running: The Running status.
Scheduling: The Scheduling status.
Stopped: The Stopped status.
Terminating: The Terminating status.
Unknown: The Unknown status.

The provisioning state of the Kubernetes cluster resource.
KnownKubernetesClusterProvisioningState can be used interchangeably with KubernetesClusterProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Accepted: The Accepted status.
InProgress: The InProgress status.
Created: The Created status.
Updating: The Updating status.
Deleting: The Deleting status.

The power state of this node.
KnownKubernetesNodePowerState can be used interchangeably with KubernetesNodePowerState, this enum contains the known values that the service supports.

Known values supported by the service

On: The node is powered on.
Off: The node is powered off.
Unknown: The node is in an unknown power state.

The role of this node in the cluster.
KnownKubernetesNodeRole can be used interchangeably with KubernetesNodeRole, this enum contains the known values that the service supports.

Known values supported by the service

ControlPlane: Control plane role
Worker: Worker role

The indicator of how this network will be utilized by the Kubernetes cluster.
KnownKubernetesPluginType can be used interchangeably with KubernetesPluginType, this enum contains the known values that the service supports.

Known values supported by the service

DPDK: DPDK plugin type
SRIOV: SRIOV plugin type
OSDevice: OSDevice plugin type
MACVLAN: MACVLAN plugin type
IPVLAN: IPVLAN plugin type

The provisioning state of the Kubernetes version resource.
KnownKubernetesVersionProvisioningState can be used interchangeably with KubernetesVersionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Failed: The Failed status.
Succeeded: The Succeeded status.

The more detailed status of the L2 network.
KnownL2NetworkDetailedStatus can be used interchangeably with L2NetworkDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.

The provisioning state of the L2 network.
KnownL2NetworkProvisioningState can be used interchangeably with L2NetworkProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
KnownL3NetworkConfigurationIpamEnabled can be used interchangeably with L3NetworkConfigurationIpamEnabled, this enum contains the known values that the service supports.

Known values supported by the service

True: IP address management enabled.
False: IP address management disabled.

The more detailed status of the L3 network.
KnownL3NetworkDetailedStatus can be used interchangeably with L3NetworkDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.

The provisioning state of the L3 network.
KnownL3NetworkProvisioningState can be used interchangeably with L3NetworkProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The connection type of the rack SKU resource.
KnownMachineSkuDiskConnectionType can be used interchangeably with MachineSkuDiskConnectionType, this enum contains the known values that the service supports.

Known values supported by the service

PCIE: PCIE connection type
SATA: SATA connection type
RAID: RAID connection type
SAS: SAS connection type

The type of managed identity that is being selected.
KnownManagedServiceIdentitySelectorType can be used interchangeably with ManagedServiceIdentitySelectorType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssignedIdentity: System assigned identity selection.
UserAssignedIdentity: User assigned identity selection.

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.

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.

The strategy for creating the OS disk.
KnownOsDiskCreateOption can be used interchangeably with OsDiskCreateOption, this enum contains the known values that the service supports.

Known values supported by the service

Ephemeral: The Os Disk will be created on ephemeral storage.
Persistent: The Os Disk is on persistent storage.

The strategy for deleting the OS disk.
KnownOsDiskDeleteOption can be used interchangeably with OsDiskDeleteOption, this enum contains the known values that the service supports.

Known values supported by the service

Delete: The Os Disk will be deleted when the virtual machine is deleted.

The more detailed status of the rack.
KnownRackDetailedStatus can be used interchangeably with RackDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.

The provisioning state of the rack resource.
KnownRackProvisioningState can be used interchangeably with RackProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The provisioning state of the rack SKU resource.
KnownRackSkuProvisioningState can be used interchangeably with RackSkuProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Canceled: The Canceled status.
Failed: The Failed status.
Succeeded: The Succeeded status.

The type of the rack.
KnownRackSkuType can be used interchangeably with RackSkuType, this enum contains the known values that the service supports.

Known values supported by the service

Aggregator: Aggregator Rack
Compute: Compute Rack
Single: Combination of Aggregator Rack and Compute Rack for a single rack cluster

The state to set for the private endpoint connection.
KnownRelayPrivateEndpointConnectionState can be used interchangeably with RelayPrivateEndpointConnectionState, this enum contains the known values that the service supports.

Known values supported by the service

Approved: The private endpoint connection is approved.
Rejected: The private endpoint connection is rejected.

The indicator of which relay type the machine should be assigned to use. Platform indicates the use of a platform-dedicated relay. Public indicates the use of the standard public relay for Arc services.
KnownRelayType can be used interchangeably with RelayType, this enum contains the known values that the service supports.

Known values supported by the service

Platform: Utilize the platform-dedicated relay for Arc services.
Public: Utilize the standard public relay for Arc services.

The indicator of whether the storage appliance supports remote vendor management.
KnownRemoteVendorManagementFeature can be used interchangeably with RemoteVendorManagementFeature, this enum contains the known values that the service supports.

Known values supported by the service

Supported: Remote vendor management is supported.
Unsupported: Remote vendor management is unsupported.

The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.
KnownRemoteVendorManagementStatus can be used interchangeably with RemoteVendorManagementStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Remote vendor management is enabled.
Disabled: Remote vendor management is disabled.
Unsupported: Remote vendor management is unsupported.

The runtime protection agent health status.
KnownRuntimeProtectionAgentHealthStatus can be used interchangeably with RuntimeProtectionAgentHealthStatus, this enum contains the known values that the service supports.

Known values supported by the service

Healthy: The runtime protection agent is healthy.
Unhealthy: The runtime protection agent has health issues.

The runtime protection agent license status.
KnownRuntimeProtectionAgentLicenseStatus can be used interchangeably with RuntimeProtectionAgentLicenseStatus, this enum contains the known values that the service supports.

Known values supported by the service

Licensed: The runtime protection agent license is valid.
Unlicensed: The runtime protection agent license is not valid.

The definition update mode for runtime protection.
KnownRuntimeProtectionDefinitionUpdateMode can be used interchangeably with RuntimeProtectionDefinitionUpdateMode, this enum contains the known values that the service supports.

Known values supported by the service

Automatic: Update definitions automatically through the connected runtime protection agent.
None: Do not update definitions.

The mode of operation for runtime protection.
KnownRuntimeProtectionEnforcementLevel can be used interchangeably with RuntimeProtectionEnforcementLevel, this enum contains the known values that the service supports.

Known values supported by the service

Audit: Real-time scans detect but do not remediate detected issues.
Disabled: Real-time scans are disabled and can not be triggered.
OnDemand: Real-time scans are disabled but can be triggered to remediate detected issues.
Passive: Real-time scans are disabled but can be triggered to detect issues without remediation.
RealTime: Real-time scans detect and remediate detected issues.

The direction of allowed network traffic based on the rule.
KnownSecurityRuleDirection can be used interchangeably with SecurityRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Inbound traffic toward the on-premsises cluster.
Outbound: Outbound traffic from the on-premises cluster.

The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately.
KnownSkipShutdown can be used interchangeably with SkipShutdown, this enum contains the known values that the service supports.

Known values supported by the service

True: Skip the graceful OS shutdown and power off the virtual machine immediately.
False: Do not skip the graceful OS shutdown.

The status of the step. A value of Completed or Failed indicates a terminal state for the step.
KnownStepStateStatus can be used interchangeably with StepStateStatus, this enum contains the known values that the service supports.

Known values supported by the service

Completed: The completed status.
InProgress: The in-progress status.
Failed: The failed status.
NotStarted: The not started status.

The detailed status of the storage appliance.
KnownStorageApplianceDetailedStatus can be used interchangeably with StorageApplianceDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The Available status.
Degraded: The Degraded status.
Error: The Error status.
Provisioning: The Provisioning status.

The log level for the monitoring configuration status of the storage appliance.
KnownStorageApplianceMetricsConfigurationStatusLogLevel can be used interchangeably with StorageApplianceMetricsConfigurationStatusLogLevel, this enum contains the known values that the service supports.

Known values supported by the service

Default: Logs are emitted at the default log level.
Nexus: Logs are emitted at the Nexus log level.

The metrics level for the monitoring configuration status of the storage appliance.
KnownStorageApplianceMetricsConfigurationStatusMetricsLevel can be used interchangeably with StorageApplianceMetricsConfigurationStatusMetricsLevel, this enum contains the known values that the service supports.

Known values supported by the service

Default: Metrics are emitted at the default metrics level.
Nexus: Metrics are emitted at the Nexus metrics level.

The provisioning state of the storage appliance.
KnownStorageApplianceProvisioningState can be used interchangeably with StorageApplianceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

The protocol advertised by the access bridge endpoints.
KnownTransportProtocol can be used interchangeably with TransportProtocol, this enum contains the known values that the service supports.

Known values supported by the service

TCP: The TCP transport protocol.
UDP: The UDP transport protocol.

The more detailed status of the trunked network.
KnownTrunkedNetworkDetailedStatus can be used interchangeably with TrunkedNetworkDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Error: The Error status.
Available: The Available status.
Provisioning: The Provisioning status.

The provisioning state of the trunked network.
KnownTrunkedNetworkProvisioningState can be used interchangeably with TrunkedNetworkProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The Succeeded status.
Failed: The Failed status.
Canceled: The Canceled status.
Provisioning: The Provisioning status.
Accepted: The Accepted status.

Selection of how the type evaluation is applied to the cluster calculation.
KnownValidationThresholdGrouping can be used interchangeably with ValidationThresholdGrouping, this enum contains the known values that the service supports.

Known values supported by the service

PerCluster: The threshold is calculated for the whole cluster.
PerRack: The threshold is calculated for each rack in the cluster.

Selection of how the threshold should be evaluated.
KnownValidationThresholdType can be used interchangeably with ValidationThresholdType, this enum contains the known values that the service supports.

Known values supported by the service

CountSuccess: The threshold is evaluated based on the count of successful operations.
PercentSuccess: The threshold is evaluated based on the percentage of successful operations.

Selects the boot method for the virtual machine.
KnownVirtualMachineBootMethod can be used interchangeably with VirtualMachineBootMethod, this enum contains the known values that the service supports.

Known values supported by the service

BIOS: BIOS boot mode.
UEFI: UEFI boot mode.

The more detailed status of the virtual machine.
KnownVirtualMachineDetailedStatus can be used interchangeably with VirtualMachineDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Available: The Available status.
Error: The Error status.
Provisioning: The Provisioning status.
Running: The Running status.
Scheduling: The Scheduling status.
Stopped: The Stopped status.
Terminating: The Terminating status.
Unknown: The Unknown status.

The type of the device model to use.
KnownVirtualMachineDeviceModelType can be used interchangeably with VirtualMachineDeviceModelType, this enum contains the known values that the service supports.

Known values supported by the service

T1: The T1 device model.
T2: The T2 device model.
T3: The T3 device model.

The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.
KnownVirtualMachineIPAllocationMethod can be used interchangeably with VirtualMachineIPAllocationMethod, this enum contains the known values that the service supports.

Known values supported by the service

Dynamic: Dynamic VM IP allocation.
Static: Static VM IP allocation.
Disabled: No VM IP allocation.

Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.
KnownVirtualMachineIsolateEmulatorThread can be used interchangeably with VirtualMachineIsolateEmulatorThread, this enum contains the known values that the service supports.

Known values supported by the service

False: Do not isolate the emulator thread.
True: Isolate the emulator thread.

The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.
KnownVirtualMachinePlacementHintPodAffinityScope can be used interchangeably with VirtualMachinePlacementHintPodAffinityScope, this enum contains the known values that the service supports.

Known values supported by the service

Machine: The virtual machine placement hint is scoped to the bare metal machine.
Rack: The virtual machine placement hint is scoped to the rack.

The specification of whether this hint supports affinity or anti-affinity with the referenced resources.
KnownVirtualMachinePlacementHintType can be used interchangeably with VirtualMachinePlacementHintType, this enum contains the known values that the service supports.

Known values supported by the service

Affinity: The virtual machine has affinity with the referenced resources.
AntiAffinity: The virtual machine has anti-affinity with the referenced resources.

The power state of the virtual machine.
KnownVirtualMachinePowerState can be used interchangeably with VirtualMachinePowerState, this enum contains the known values that the service supports.

Known values supported by the service

Off: The virtual machine is powered off.
On: The virtual machine is powered on.
Unknown: The virtual machine power state is unknown.

The provisioning state of the virtual machine.
KnownVirtualMachineProvisioningState can be used interchangeably with VirtualMachineProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Failed: The Failed status.
Provisioning: The Provisioning status.
Succeeded: The Succeeded status.

The indicator of whether the hint is a hard or soft requirement during scheduling.
KnownVirtualMachineSchedulingExecution can be used interchangeably with VirtualMachineSchedulingExecution, this enum contains the known values that the service supports.

Known values supported by the service

Hard: The hint is a requirement during scheduling.
Soft: The hint is applied using a best-effort approach during scheduling.

Field Deprecated, use virtualizationModel instead. The type of the virtio interface.
KnownVirtualMachineVirtioInterfaceType can be used interchangeably with VirtualMachineVirtioInterfaceType, this enum contains the known values that the service supports.

Known values supported by the service

Modern: Modern virtio interface.
Transitional: Transitional virtio interface.

The more detailed status of the volume.
KnownVolumeDetailedStatus can be used interchangeably with VolumeDetailedStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: The Active status.
Error: The Error status.
Provisioning: The Provisioning status.

The provisioning state of the volume.
KnownVolumeProvisioningState can be used interchangeably with VolumeProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The Accepted status.
Canceled: The Canceled status.
Failed: The Failed status.
Provisioning: The Provisioning status.
Succeeded: The Succeeded status.

The mode selection for container vulnerability scanning.
KnownVulnerabilityScanningSettingsContainerScan can be used interchangeably with VulnerabilityScanningSettingsContainerScan, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: Disable container vulnerability scanning for the cluster.
Enabled: Enable container vulnerability scanning for the cluster.

The indicator of whether the workload will be impacted during the upgrade.
KnownWorkloadImpact can be used interchangeably with WorkloadImpact, this enum contains the known values that the service supports.

Known values supported by the service

True: The workload will be impacted during the upgrade.
False: The workload will not be impacted during the upgrade.

An enum to describe Azure Cloud environments.

The allowed names for the access bridge.

The detailed status reported by the access bridge.

The provisioning state of the access bridge.

The status of the action.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.

The current status of the agent pool.

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

The provisioning state of the agent pool.

The version lifecycle indicator.

The cordon status of the bare metal machine.

The more detailed status of the bare metal machine.

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

The outcome of the hardware validation.

The more detailed status of the key set.

The access level allowed for the users in this key set.

The provisioning state of the bare metal machine key set.

The indicator of whether the user is currently deployed for access.

The log level for the monitoring configuration status of the bare metal machine.

The metrics level for the monitoring configuration status of the bare metal machine.

The power state derived from the baseboard management controller.

The provisioning state of the bare metal machine.

The indicator of whether the bare metal machine is ready to receive workloads.

The safeguard mode to use for the reimage action, where None indicates to bypass safeguards and All indicates to utilize all safeguards.

The safeguard mode to use for the replace action, where None indicates to bypass safeguards and All indicates to utilize all safeguards.

The indicator of whether to bypass clearing storage while replacing a bare metal machine.

The indicator of whether to skip the graceful OS shutdown and power off the bare metal machine immediately.

The indicator to determine if automatic allocation from the pool should occur.

The indicator to enable multi-hop peering support.

The more detailed status of the key set.

The access level allowed for the users in this key set.

The provisioning state of the baseboard management controller key set.

The type of bootstrap protocol used.

The more detailed status of the cloud services network.

The indicator of whether the platform default endpoints are allowed for the egress traffic.

The provisioning state of the cloud services network.

The indicator to enable shared storage on the cloud services network. If not specified, the allocation will align with the standard storage enablement.

The status of the storage allocation for the cloud services network.

The latest heartbeat status between the cluster manager and the cluster.

The mode by which the cluster will target the next grouping of servers to continue the update.

ClusterContinueUpdateVersionSafeguardMode represents the mode of the cluster continue update safeguards.

The current detailed status of the cluster.

Additional actions supplement the default non-disruptive cluster inspection. Additional actions may be disallowed if the cluster is in a deployed and running state.

The latest connectivity status between cluster manager and the cluster.

The detailed status that provides additional information about the cluster manager.

The provisioning state of the cluster manager.

The more detailed status of the metrics configuration.

The provisioning state of the metrics configuration.

The provisioning state of the cluster.

The choice of if the scan operation should run the scan.

The indicator if the specified key vault should be used to archive the secrets of the cluster.

The type of rack configuration for the cluster.

The mode of operation for runtime protection.

ClusterUpdateVersionSafeguardMode represents the mode of the cluster update safeguards.

The type of command output for the override.

The more detailed status of the console.

The indicator of whether the console access is enabled.

The provisioning state of the virtual machine console.

The indicator of whether the control plane will be impacted during the upgrade.

The kind of entity that created the resource.

The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.

The type (kind) of the cluster. When specified, the value must exactly match the kind configured on the cluster manager that manages the cluster. If omitted, the service will default the value to the kind value of the cluster manager.

The connection type of the device.

The disk type of rack SKU resource.

The supported ExtendedLocation types.

The indicator to specify if the load balancer peers with the network fabric.

The status representing the state of this feature.

The size of the hugepages to allocate.

Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.

Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.

The type of the IP address allocation, defaulted to "DualStack".

The current status of the Kubernetes cluster.

The lifecycle indicator of the feature.

The detailed status of the feature.

The provisioning state of the Kubernetes cluster feature.

The indicator of if the feature is required or optional. Optional features may be deleted by the user, while required features are managed with the kubernetes cluster lifecycle.

The detailed state of this node.

The provisioning state of the Kubernetes cluster resource.

The power state of this node.

The role of this node in the cluster.

The indicator of how this network will be utilized by the Kubernetes cluster.

The provisioning state of the Kubernetes version resource.

The more detailed status of the L2 network.

The provisioning state of the L2 network.

The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.

The more detailed status of the L3 network.

The provisioning state of the L3 network.

The connection type of the rack SKU resource.

The type of managed identity that is being selected.

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

The strategy for creating the OS disk.

The strategy for deleting the OS disk.

The more detailed status of the rack.

The provisioning state of the rack resource.

The provisioning state of the rack SKU resource.

The type of the rack.

The state to set for the private endpoint connection.

The indicator of which relay type the machine should be assigned to use. Platform indicates the use of a platform-dedicated relay. Public indicates the use of the standard public relay for Arc services.

The indicator of whether the storage appliance supports remote vendor management.

The indicator of whether the remote vendor management feature is enabled or disabled, or unsupported if it is an unsupported feature.

The runtime protection agent health status.

The runtime protection agent license status.

The definition update mode for runtime protection.

The mode of operation for runtime protection.

The direction of allowed network traffic based on the rule.

The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately.

The status of the step. A value of Completed or Failed indicates a terminal state for the step.

The detailed status of the storage appliance.

The log level for the monitoring configuration status of the storage appliance.

The metrics level for the monitoring configuration status of the storage appliance.

The provisioning state of the storage appliance.

The protocol advertised by the access bridge endpoints.

The more detailed status of the trunked network.

The provisioning state of the trunked network.

Selection of how the type evaluation is applied to the cluster calculation.

Selection of how the threshold should be evaluated.

The available API versions. Note: Order Matters more than naming. If you add a new version, please add it to the correct location based on the version date and which versions have preceded it.

Selects the boot method for the virtual machine.

The more detailed status of the virtual machine.

The type of the device model to use.

The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.

Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.

The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity.

The specification of whether this hint supports affinity or anti-affinity with the referenced resources.

The power state of the virtual machine.

The provisioning state of the virtual machine.

The indicator of whether the hint is a hard or soft requirement during scheduling.

Field Deprecated, use virtualizationModel instead. The type of the virtio interface.

The more detailed status of the volume.

The provisioning state of the volume.

The mode selection for container vulnerability scanning.

The indicator of whether the workload will be impacted during the upgrade.

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.