ArmNetworkCloudModelFactory.NetworkCloudClusterData Method

Definition

Namespace:: Azure.ResourceManager.NetworkCloud.Models

Assembly:: Azure.ResourceManager.NetworkCloud.dll

Package:: Azure.ResourceManager.NetworkCloud v1.4.0-beta.1

Source:: ArmNetworkCloudModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

public static Azure.ResourceManager.NetworkCloud.NetworkCloudClusterData NetworkCloudClusterData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.NetworkCloud.Models.NetworkCloudRackDefinition aggregatorOrSingleRackDefinition = default, Azure.ResourceManager.NetworkCloud.Models.AnalyticsOutputSettings analyticsOutputSettings = default, Azure.Core.ResourceIdentifier analyticsWorkspaceId = default, string clusterLocation = default, Azure.ResourceManager.NetworkCloud.Models.ServicePrincipalInformation clusterServicePrincipal = default, Azure.ResourceManager.NetworkCloud.Models.ClusterType clusterType = default, string clusterVersion = default, Azure.ResourceManager.NetworkCloud.Models.CommandOutputSettings commandOutputSettings = default, Azure.ResourceManager.NetworkCloud.Models.ValidationThreshold computeDeploymentThreshold = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudRackDefinition> computeRackDefinitions = default, Azure.ResourceManager.NetworkCloud.Models.ManagedResourceGroupConfiguration managedResourceGroupConfiguration = default, Azure.Core.ResourceIdentifier networkFabricId = default, Azure.ResourceManager.NetworkCloud.Models.RuntimeProtectionConfiguration runtimeProtectionConfiguration = default, Azure.ResourceManager.NetworkCloud.Models.ClusterSecretArchive secretArchive = default, Azure.ResourceManager.NetworkCloud.Models.SecretArchiveSettings secretArchiveSettings = default, Azure.ResourceManager.NetworkCloud.Models.ClusterUpdateStrategy updateStrategy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudActionState> actionStates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.ClusterAvailableUpgradeVersion> availableUpgradeVersions = default, Azure.ResourceManager.NetworkCloud.Models.ClusterCapacity clusterCapacity = default, Azure.ResourceManager.NetworkCloud.Models.ClusterConnectionStatus? clusterConnectionStatus = default, Azure.ResourceManager.Resources.Models.ExtendedLocation clusterExtendedLocation = default, Azure.ResourceManager.NetworkCloud.Models.ClusterManagerConnectionStatus? clusterManagerConnectionStatus = default, Azure.Core.ResourceIdentifier clusterManagerId = default, Azure.ResourceManager.NetworkCloud.Models.ClusterDetailedStatus? detailedStatus = default, string detailedStatusMessage = default, Azure.ResourceManager.Resources.Models.ExtendedLocation hybridAksExtendedLocation = default, long? manualActionCount = default, DateTimeOffset? supportExpireOn = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceIdentifier> workloadResourceIds = default, Azure.ResourceManager.NetworkCloud.Models.ClusterProvisioningState? provisioningState = default, Azure.ResourceManager.NetworkCloud.Models.VulnerabilityScanningSettingsContainerScan? vulnerabilityScanningContainerScan = default, Azure.ETag? eTag = default, Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation extendedLocation = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ResourceManager.NetworkCloud.Models.NetworkCloudDeploymentType? kind = default);

static member NetworkCloudClusterData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Azure.ResourceManager.NetworkCloud.Models.NetworkCloudRackDefinition * Azure.ResourceManager.NetworkCloud.Models.AnalyticsOutputSettings * Azure.Core.ResourceIdentifier * string * Azure.ResourceManager.NetworkCloud.Models.ServicePrincipalInformation * Azure.ResourceManager.NetworkCloud.Models.ClusterType * string * Azure.ResourceManager.NetworkCloud.Models.CommandOutputSettings * Azure.ResourceManager.NetworkCloud.Models.ValidationThreshold * seq<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudRackDefinition> * Azure.ResourceManager.NetworkCloud.Models.ManagedResourceGroupConfiguration * Azure.Core.ResourceIdentifier * Azure.ResourceManager.NetworkCloud.Models.RuntimeProtectionConfiguration * Azure.ResourceManager.NetworkCloud.Models.ClusterSecretArchive * Azure.ResourceManager.NetworkCloud.Models.SecretArchiveSettings * Azure.ResourceManager.NetworkCloud.Models.ClusterUpdateStrategy * seq<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudActionState> * seq<Azure.ResourceManager.NetworkCloud.Models.ClusterAvailableUpgradeVersion> * Azure.ResourceManager.NetworkCloud.Models.ClusterCapacity * Nullable<Azure.ResourceManager.NetworkCloud.Models.ClusterConnectionStatus> * Azure.ResourceManager.Resources.Models.ExtendedLocation * Nullable<Azure.ResourceManager.NetworkCloud.Models.ClusterManagerConnectionStatus> * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.NetworkCloud.Models.ClusterDetailedStatus> * string * Azure.ResourceManager.Resources.Models.ExtendedLocation * Nullable<int64> * Nullable<DateTimeOffset> * seq<Azure.Core.ResourceIdentifier> * Nullable<Azure.ResourceManager.NetworkCloud.Models.ClusterProvisioningState> * Nullable<Azure.ResourceManager.NetworkCloud.Models.VulnerabilityScanningSettingsContainerScan> * Nullable<Azure.ETag> * Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation * Azure.ResourceManager.Models.ManagedServiceIdentity * Nullable<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudDeploymentType> -> Azure.ResourceManager.NetworkCloud.NetworkCloudClusterData

Public Shared Function NetworkCloudClusterData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional aggregatorOrSingleRackDefinition As NetworkCloudRackDefinition = Nothing, Optional analyticsOutputSettings As AnalyticsOutputSettings = Nothing, Optional analyticsWorkspaceId As ResourceIdentifier = Nothing, Optional clusterLocation As String = Nothing, Optional clusterServicePrincipal As ServicePrincipalInformation = Nothing, Optional clusterType As ClusterType = Nothing, Optional clusterVersion As String = Nothing, Optional commandOutputSettings As CommandOutputSettings = Nothing, Optional computeDeploymentThreshold As ValidationThreshold = Nothing, Optional computeRackDefinitions As IEnumerable(Of NetworkCloudRackDefinition) = Nothing, Optional managedResourceGroupConfiguration As ManagedResourceGroupConfiguration = Nothing, Optional networkFabricId As ResourceIdentifier = Nothing, Optional runtimeProtectionConfiguration As RuntimeProtectionConfiguration = Nothing, Optional secretArchive As ClusterSecretArchive = Nothing, Optional secretArchiveSettings As SecretArchiveSettings = Nothing, Optional updateStrategy As ClusterUpdateStrategy = Nothing, Optional actionStates As IEnumerable(Of NetworkCloudActionState) = Nothing, Optional availableUpgradeVersions As IEnumerable(Of ClusterAvailableUpgradeVersion) = Nothing, Optional clusterCapacity As ClusterCapacity = Nothing, Optional clusterConnectionStatus As Nullable(Of ClusterConnectionStatus) = Nothing, Optional clusterExtendedLocation As ExtendedLocation = Nothing, Optional clusterManagerConnectionStatus As Nullable(Of ClusterManagerConnectionStatus) = Nothing, Optional clusterManagerId As ResourceIdentifier = Nothing, Optional detailedStatus As Nullable(Of ClusterDetailedStatus) = Nothing, Optional detailedStatusMessage As String = Nothing, Optional hybridAksExtendedLocation As ExtendedLocation = Nothing, Optional manualActionCount As Nullable(Of Long) = Nothing, Optional supportExpireOn As Nullable(Of DateTimeOffset) = Nothing, Optional workloadResourceIds As IEnumerable(Of ResourceIdentifier) = Nothing, Optional provisioningState As Nullable(Of ClusterProvisioningState) = Nothing, Optional vulnerabilityScanningContainerScan As Nullable(Of VulnerabilityScanningSettingsContainerScan) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional kind As Nullable(Of NetworkCloudDeploymentType) = Nothing) As NetworkCloudClusterData

Parameters

id: ResourceIdentifier

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name: String

The name of the resource.

resourceType: ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

systemData: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags: IDictionary<String,String>

Resource tags.

location: AzureLocation

The geo-location where the resource lives.

aggregatorOrSingleRackDefinition: NetworkCloudRackDefinition

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.

analyticsOutputSettings: AnalyticsOutputSettings

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

analyticsWorkspaceId: ResourceIdentifier

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

clusterLocation: String

The customer-provided location information to identify where the cluster resides.

clusterServicePrincipal: ServicePrincipalInformation

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

clusterType: ClusterType

The type of rack configuration for the cluster.

clusterVersion: String

The current runtime version of the cluster.

commandOutputSettings: CommandOutputSettings

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

computeDeploymentThreshold: ValidationThreshold

The validation threshold indicating the allowable failures of compute machines during environment validation and deployment.

computeRackDefinitions: IEnumerable<NetworkCloudRackDefinition>

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

managedResourceGroupConfiguration: ManagedResourceGroupConfiguration

The configuration of the managed resource group associated with the resource.

networkFabricId: ResourceIdentifier

The resource ID of the Network Fabric associated with the cluster.

runtimeProtectionConfiguration: RuntimeProtectionConfiguration

The settings for cluster runtime protection.

secretArchive: ClusterSecretArchive

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

secretArchiveSettings: SecretArchiveSettings

The settings for the secret archive used to hold credentials for the cluster.

updateStrategy: ClusterUpdateStrategy

The strategy for updating the cluster.

actionStates: IEnumerable<NetworkCloudActionState>

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

availableUpgradeVersions: IEnumerable<ClusterAvailableUpgradeVersion>

The list of cluster runtime version upgrades available for this cluster.

clusterCapacity: ClusterCapacity

The capacity supported by this cluster.

clusterConnectionStatus: Nullable<ClusterConnectionStatus>

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

clusterExtendedLocation: ExtendedLocation

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.

clusterManagerConnectionStatus: Nullable<ClusterManagerConnectionStatus>

The latest connectivity status between cluster manager and the cluster.

clusterManagerId: ResourceIdentifier

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

detailedStatus: Nullable<ClusterDetailedStatus>

The current detailed status of the cluster.

detailedStatusMessage: String

The descriptive message about the detailed status.

hybridAksExtendedLocation: ExtendedLocation

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).

manualActionCount: Nullable<Int64>

The count of Manual Action Taken (MAT) events that have not been validated.

supportExpireOn: Nullable<DateTimeOffset>

The support end date of the runtime version of the cluster.

workloadResourceIds: IEnumerable<ResourceIdentifier>

The list of workload resource IDs that are hosted within this cluster.

provisioningState: Nullable<ClusterProvisioningState>

The provisioning state of the cluster.

vulnerabilityScanningContainerScan: Nullable<VulnerabilityScanningSettingsContainerScan>

The mode selection for container vulnerability scanning.

eTag: Nullable<ETag>

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").

extendedLocation: Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation

The extended location of the resource. This property is required when creating the resource.

identity: ManagedServiceIdentity

The managed service identities assigned to this resource.

kind: Nullable<NetworkCloudDeploymentType>

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.

Returns

NetworkCloudClusterData

A new NetworkCloudClusterData instance for mocking.

Exceptions

ArgumentNullException

aggregatorOrSingleRackDefinition, clusterVersion or networkFabricId is null.

Applies to

Feedback

Was this page helpful?