Cluster Interface

Package:
com.azure.resourcemanager.networkcloud.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-networkcloud:2.1.0

public interface Cluster

An immutable client-side representation of Cluster.

Method Summary

Modifier and Type Method and Description
abstract List<ActionState> actionStates()

Gets the actionStates property: The current state of any in progress or completed actions.
abstract RackDefinition aggregatorOrSingleRackDefinition()

Gets the aggregatorOrSingleRackDefinition property: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.
abstract AnalyticsOutputSettings analyticsOutputSettings()

Gets the analyticsOutputSettings property: The settings for the log analytics workspace used for output of logs from this cluster.
abstract String analyticsWorkspaceId()

Gets the analyticsWorkspaceId property: Field Deprecated.
abstract List<ClusterAvailableUpgradeVersion> availableUpgradeVersions()

Gets the availableUpgradeVersions property: The list of cluster runtime version upgrades available for this cluster.
abstract ClusterCapacity clusterCapacity()

Gets the clusterCapacity property: The capacity supported by this cluster.
abstract ClusterConnectionStatus clusterConnectionStatus()

Gets the clusterConnectionStatus property: The latest heartbeat status between the cluster manager and the cluster.
abstract ExtendedLocation clusterExtendedLocation()

Gets the clusterExtendedLocation property: The extended location (custom location) that represents the cluster's control plane location.
abstract String clusterLocation()

Gets the clusterLocation property: The customer-provided location information to identify where the cluster resides.
abstract ClusterManagerConnectionStatus clusterManagerConnectionStatus()

Gets the clusterManagerConnectionStatus property: The latest connectivity status between cluster manager and the cluster.
abstract String clusterManagerId()

Gets the clusterManagerId property: The resource ID of the cluster manager that manages this cluster.
abstract ServicePrincipalInformation clusterServicePrincipal()

Gets the clusterServicePrincipal property: Field Deprecated: Use managed identity to provide cluster privileges.
abstract ClusterType clusterType()

Gets the clusterType property: The type of rack configuration for the cluster.
abstract String clusterVersion()

Gets the clusterVersion property: The current runtime version of the cluster.
abstract CommandOutputSettings commandOutputSettings()

Gets the commandOutputSettings property: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.
abstract ValidationThreshold computeDeploymentThreshold()

Gets the computeDeploymentThreshold property: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.
abstract List<RackDefinition> computeRackDefinitions()

Gets the computeRackDefinitions property: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.
abstract OperationStatusResult continueUpdateVersion(ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

Continue a paused update to the cluster version.
abstract OperationStatusResult continueUpdateVersion(ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

Continue a paused update to the cluster version.
abstract OperationStatusResult deploy()

Deploy the cluster.
abstract OperationStatusResult deploy(ClusterDeployParameters clusterDeployParameters, Context context)

Deploy the cluster.
abstract ClusterDetailedStatus detailedStatus()

Gets the detailedStatus property: The current detailed status of the cluster.
abstract String detailedStatusMessage()

Gets the detailedStatusMessage property: The descriptive message about the detailed status.
abstract String etag()

Gets the etag property: Resource ETag.
abstract ExtendedLocation extendedLocation()

Gets the extendedLocation property: The extended location of the cluster manager associated with the cluster.
abstract ExtendedLocation hybridAksExtendedLocation()

Gets the hybridAksExtendedLocation property: Field Deprecated.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedServiceIdentity identity()

Gets the identity property: The identity for the resource.
abstract ClusterInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.ClusterInner object.
abstract String location()

Gets the location property: The geo-location where the resource lives.
abstract ManagedResourceGroupConfiguration managedResourceGroupConfiguration()

Gets the managedResourceGroupConfiguration property: The configuration of the managed resource group associated with the resource.
abstract Long manualActionCount()

Gets the manualActionCount property: The count of Manual Action Taken (MAT) events that have not been validated.
abstract String name()

Gets the name property: The name of the resource.
abstract String networkFabricId()

Gets the networkFabricId property: The resource ID of the Network Fabric associated with the cluster.
abstract ClusterProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the cluster.
abstract Cluster refresh()

Refreshes the resource to sync with Azure.
abstract Cluster refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract RuntimeProtectionConfiguration runtimeProtectionConfiguration()

Gets the runtimeProtectionConfiguration property: The settings for cluster runtime protection.
abstract OperationStatusResult scanRuntime()

Execute a runtime protection scan on the cluster.
abstract OperationStatusResult scanRuntime(ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

Execute a runtime protection scan on the cluster.
abstract ClusterSecretArchive secretArchive()

Gets the secretArchive property: The configuration for use of a key vault to store secrets for later retrieval by the operator.
abstract SecretArchiveSettings secretArchiveSettings()

Gets the secretArchiveSettings property: The settings for the secret archive used to hold credentials for the cluster.
abstract String supportExpiryDate()

Gets the supportExpiryDate property: The support end date of the runtime version of the cluster.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the Cluster resource.
abstract ClusterUpdateStrategy updateStrategy()

Gets the updateStrategy property: The strategy for updating the cluster.
abstract OperationStatusResult updateVersion(ClusterUpdateVersionParameters clusterUpdateVersionParameters)

Update the cluster version.
abstract OperationStatusResult updateVersion(ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

Update the cluster version.
abstract VulnerabilityScanningSettings vulnerabilityScanningSettings()

Gets the vulnerabilityScanningSettings property: The settings for how security vulnerability scanning is applied to the cluster.
abstract List<String> workloadResourceIds()

Gets the workloadResourceIds property: The list of workload resource IDs that are hosted within this cluster.

Method Details

actionStates

public abstract List<ActionState> actionStates()

Gets the actionStates property: The current state of any in progress or completed actions. The most recent known instance of each action type is shown.

Returns:

the actionStates value.

aggregatorOrSingleRackDefinition

public abstract RackDefinition aggregatorOrSingleRackDefinition()

Gets the aggregatorOrSingleRackDefinition property: The rack definition that is intended to reflect only a single rack in a single rack cluster, or an aggregator rack in a multi-rack cluster.

Returns:

the aggregatorOrSingleRackDefinition value.

analyticsOutputSettings

public abstract AnalyticsOutputSettings analyticsOutputSettings()

Gets the analyticsOutputSettings property: The settings for the log analytics workspace used for output of logs from this cluster.

Returns:

the analyticsOutputSettings value.

analyticsWorkspaceId

public abstract String analyticsWorkspaceId()

Gets the analyticsWorkspaceId property: Field Deprecated. The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.

Returns:

the analyticsWorkspaceId value.

availableUpgradeVersions

public abstract List<ClusterAvailableUpgradeVersion> availableUpgradeVersions()

Gets the availableUpgradeVersions property: The list of cluster runtime version upgrades available for this cluster.

Returns:

the availableUpgradeVersions value.

clusterCapacity

public abstract ClusterCapacity clusterCapacity()

Gets the clusterCapacity property: The capacity supported by this cluster.

Returns:

the clusterCapacity value.

clusterConnectionStatus

public abstract ClusterConnectionStatus clusterConnectionStatus()

Gets the clusterConnectionStatus property: The latest heartbeat status between the cluster manager and the cluster.

Returns:

the clusterConnectionStatus value.

clusterExtendedLocation

public abstract ExtendedLocation clusterExtendedLocation()

Gets the clusterExtendedLocation property: The extended location (custom location) that represents the cluster's control plane location. This extended location is used to route the requests of child objects of the cluster that are handled by the platform operator.

Returns:

the clusterExtendedLocation value.

clusterLocation

public abstract String clusterLocation()

Gets the clusterLocation property: The customer-provided location information to identify where the cluster resides.

Returns:

the clusterLocation value.

clusterManagerConnectionStatus

public abstract ClusterManagerConnectionStatus clusterManagerConnectionStatus()

Gets the clusterManagerConnectionStatus property: The latest connectivity status between cluster manager and the cluster.

Returns:

the clusterManagerConnectionStatus value.

clusterManagerId

public abstract String clusterManagerId()

Gets the clusterManagerId property: The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.

Returns:

the clusterManagerId value.

clusterServicePrincipal

public abstract ServicePrincipalInformation clusterServicePrincipal()

Gets the clusterServicePrincipal property: Field Deprecated: Use managed identity to provide cluster privileges. The service principal to be used by the cluster during Arc Appliance installation.

Returns:

the clusterServicePrincipal value.

clusterType

public abstract ClusterType clusterType()

Gets the clusterType property: The type of rack configuration for the cluster.

Returns:

the clusterType value.

clusterVersion

public abstract String clusterVersion()

Gets the clusterVersion property: The current runtime version of the cluster.

Returns:

the clusterVersion value.

commandOutputSettings

public abstract CommandOutputSettings commandOutputSettings()

Gets the commandOutputSettings property: The settings for commands run in this cluster, such as bare metal machine run read only commands and data extracts.

Returns:

the commandOutputSettings value.

computeDeploymentThreshold

public abstract ValidationThreshold computeDeploymentThreshold()

Gets the computeDeploymentThreshold property: The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

Returns:

the computeDeploymentThreshold value.

computeRackDefinitions

public abstract List<RackDefinition> computeRackDefinitions()

Gets the computeRackDefinitions property: The list of rack definitions for the compute racks in a multi-rack cluster, or an empty list in a single-rack cluster.

Returns:

the computeRackDefinitions value.

continueUpdateVersion

public abstract OperationStatusResult continueUpdateVersion(ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters)

Continue a paused update to the cluster version. Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

Parameters:

clusterContinueUpdateVersionParameters - The request body.

Returns:

the current status of an async operation.

continueUpdateVersion

public abstract OperationStatusResult continueUpdateVersion(ClusterContinueUpdateVersionParameters clusterContinueUpdateVersionParameters, Context context)

Continue a paused update to the cluster version. Trigger the continuation of an update for a cluster with a matching update strategy that has paused after completing a segment of the update.

Parameters:

clusterContinueUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

deploy

public abstract OperationStatusResult deploy()

Deploy the cluster. Deploy the cluster using the rack configuration provided during creation.

Returns:

the current status of an async operation.

deploy

public abstract OperationStatusResult deploy(ClusterDeployParameters clusterDeployParameters, Context context)

Deploy the cluster. Deploy the cluster using the rack configuration provided during creation.

Parameters:

clusterDeployParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

detailedStatus

public abstract ClusterDetailedStatus detailedStatus()

Gets the detailedStatus property: The current detailed status of the cluster.

Returns:

the detailedStatus value.

detailedStatusMessage

public abstract String detailedStatusMessage()

Gets the detailedStatusMessage property: The descriptive message about the detailed status.

Returns:

the detailedStatusMessage value.

etag

public abstract String etag()

Gets the etag property: Resource ETag.

Returns:

the etag value.

extendedLocation

public abstract ExtendedLocation extendedLocation()

Gets the extendedLocation property: The extended location of the cluster manager associated with the cluster.

Returns:

the extendedLocation value.

hybridAksExtendedLocation

public abstract ExtendedLocation hybridAksExtendedLocation()

Gets the hybridAksExtendedLocation property: Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).

Returns:

the hybridAksExtendedLocation value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: The identity for the resource.

Returns:

the identity value.

innerModel

public abstract ClusterInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.ClusterInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

managedResourceGroupConfiguration

public abstract ManagedResourceGroupConfiguration managedResourceGroupConfiguration()

Gets the managedResourceGroupConfiguration property: The configuration of the managed resource group associated with the resource.

Returns:

the managedResourceGroupConfiguration value.

manualActionCount

public abstract Long manualActionCount()

Gets the manualActionCount property: The count of Manual Action Taken (MAT) events that have not been validated.

Returns:

the manualActionCount value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkFabricId

public abstract String networkFabricId()

Gets the networkFabricId property: The resource ID of the Network Fabric associated with the cluster.

Returns:

the networkFabricId value.

provisioningState

public abstract ClusterProvisioningState provisioningState()

Gets the provisioningState property: The provisioning state of the cluster.

Returns:

the provisioningState value.

refresh

public abstract Cluster refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Cluster refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

runtimeProtectionConfiguration

public abstract RuntimeProtectionConfiguration runtimeProtectionConfiguration()

Gets the runtimeProtectionConfiguration property: The settings for cluster runtime protection.

Returns:

the runtimeProtectionConfiguration value.

scanRuntime

public abstract OperationStatusResult scanRuntime()

Execute a runtime protection scan on the cluster. Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

Returns:

the current status of an async operation.

scanRuntime

public abstract OperationStatusResult scanRuntime(ClusterScanRuntimeParameters clusterScanRuntimeParameters, Context context)

Execute a runtime protection scan on the cluster. Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.

Parameters:

clusterScanRuntimeParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

secretArchive

public abstract ClusterSecretArchive secretArchive()

Gets the secretArchive property: The configuration for use of a key vault to store secrets for later retrieval by the operator.

Returns:

the secretArchive value.

secretArchiveSettings

public abstract SecretArchiveSettings secretArchiveSettings()

Gets the secretArchiveSettings property: The settings for the secret archive used to hold credentials for the cluster.

Returns:

the secretArchiveSettings value.

supportExpiryDate

public abstract String supportExpiryDate()

Gets the supportExpiryDate property: The support end date of the runtime version of the cluster.

Returns:

the supportExpiryDate value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Cluster.Update update()

Begins update for the Cluster resource.

Returns:

the stage of resource update.

updateStrategy

public abstract ClusterUpdateStrategy updateStrategy()

Gets the updateStrategy property: The strategy for updating the cluster.

Returns:

the updateStrategy value.

updateVersion

public abstract OperationStatusResult updateVersion(ClusterUpdateVersionParameters clusterUpdateVersionParameters)

Update the cluster version. Update the version of the provided cluster to one of the available supported versions.

Parameters:

clusterUpdateVersionParameters - The request body.

Returns:

the current status of an async operation.

updateVersion

public abstract OperationStatusResult updateVersion(ClusterUpdateVersionParameters clusterUpdateVersionParameters, Context context)

Update the cluster version. Update the version of the provided cluster to one of the available supported versions.

Parameters:

clusterUpdateVersionParameters - The request body.
context - The context to associate with this operation.

Returns:

the current status of an async operation.

vulnerabilityScanningSettings

public abstract VulnerabilityScanningSettings vulnerabilityScanningSettings()

Gets the vulnerabilityScanningSettings property: The settings for how security vulnerability scanning is applied to the cluster.

Returns:

the vulnerabilityScanningSettings value.

workloadResourceIds

public abstract List<String> workloadResourceIds()

Gets the workloadResourceIds property: The list of workload resource IDs that are hosted within this cluster.

Returns:

the workloadResourceIds value.

Applies to