ArmNetworkCloudModelFactory.NetworkCloudKubernetesClusterData Method
Definition
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.NetworkCloudKubernetesClusterData NetworkCloudKubernetesClusterData(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.AdministratorConfiguration administratorConfiguration = default, Azure.ResourceManager.NetworkCloud.Models.ControlPlaneNodeConfiguration controlPlaneNodeConfiguration = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.InitialAgentPoolConfiguration> initialAgentPoolConfigurations = default, string kubernetesVersion = default, Azure.ResourceManager.NetworkCloud.Models.ManagedResourceGroupConfiguration managedResourceGroupConfiguration = default, Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterNetworkConfiguration networkConfiguration = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceIdentifier> attachedNetworkIds = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.AvailableUpgrade> availableUpgrades = default, Azure.Core.ResourceIdentifier clusterId = default, Azure.Core.ResourceIdentifier connectedClusterId = default, string controlPlaneKubernetesVersion = default, Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterDetailedStatus? detailedStatus = default, string detailedStatusMessage = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.FeatureStatus> featureStatuses = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterNode> nodes = default, Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterProvisioningState? provisioningState = default, System.Collections.Generic.IEnumerable<string> aadAdminGroupObjectIds = default, Azure.ETag? eTag = default, Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation extendedLocation = default);
static member NetworkCloudKubernetesClusterData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Azure.ResourceManager.NetworkCloud.Models.AdministratorConfiguration * Azure.ResourceManager.NetworkCloud.Models.ControlPlaneNodeConfiguration * seq<Azure.ResourceManager.NetworkCloud.Models.InitialAgentPoolConfiguration> * string * Azure.ResourceManager.NetworkCloud.Models.ManagedResourceGroupConfiguration * Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterNetworkConfiguration * seq<Azure.Core.ResourceIdentifier> * seq<Azure.ResourceManager.NetworkCloud.Models.AvailableUpgrade> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * Nullable<Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterDetailedStatus> * string * seq<Azure.ResourceManager.NetworkCloud.Models.FeatureStatus> * seq<Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterNode> * Nullable<Azure.ResourceManager.NetworkCloud.Models.KubernetesClusterProvisioningState> * seq<string> * Nullable<Azure.ETag> * Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation -> Azure.ResourceManager.NetworkCloud.NetworkCloudKubernetesClusterData
Public Shared Function NetworkCloudKubernetesClusterData (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 administratorConfiguration As AdministratorConfiguration = Nothing, Optional controlPlaneNodeConfiguration As ControlPlaneNodeConfiguration = Nothing, Optional initialAgentPoolConfigurations As IEnumerable(Of InitialAgentPoolConfiguration) = Nothing, Optional kubernetesVersion As String = Nothing, Optional managedResourceGroupConfiguration As ManagedResourceGroupConfiguration = Nothing, Optional networkConfiguration As KubernetesClusterNetworkConfiguration = Nothing, Optional attachedNetworkIds As IEnumerable(Of ResourceIdentifier) = Nothing, Optional availableUpgrades As IEnumerable(Of AvailableUpgrade) = Nothing, Optional clusterId As ResourceIdentifier = Nothing, Optional connectedClusterId As ResourceIdentifier = Nothing, Optional controlPlaneKubernetesVersion As String = Nothing, Optional detailedStatus As Nullable(Of KubernetesClusterDetailedStatus) = Nothing, Optional detailedStatusMessage As String = Nothing, Optional featureStatuses As IEnumerable(Of FeatureStatus) = Nothing, Optional nodes As IEnumerable(Of KubernetesClusterNode) = Nothing, Optional provisioningState As Nullable(Of KubernetesClusterProvisioningState) = Nothing, Optional aadAdminGroupObjectIds As IEnumerable(Of String) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing) As NetworkCloudKubernetesClusterData
Parameters
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.
- administratorConfiguration
- AdministratorConfiguration
The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
- controlPlaneNodeConfiguration
- ControlPlaneNodeConfiguration
The defining characteristics of the control plane for this Kubernetes Cluster.
- initialAgentPoolConfigurations
- IEnumerable<InitialAgentPoolConfiguration>
The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.
- kubernetesVersion
- String
The Kubernetes version for this cluster.
- managedResourceGroupConfiguration
- ManagedResourceGroupConfiguration
The configuration of the managed resource group associated with the resource.
- networkConfiguration
- KubernetesClusterNetworkConfiguration
The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
- attachedNetworkIds
- IEnumerable<ResourceIdentifier>
The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
- availableUpgrades
- IEnumerable<AvailableUpgrade>
The list of versions that this Kubernetes cluster can be upgraded to.
- clusterId
- ResourceIdentifier
The resource ID of the Network Cloud cluster.
- connectedClusterId
- ResourceIdentifier
The resource ID of the connected cluster set up when this Kubernetes cluster is created.
- controlPlaneKubernetesVersion
- String
The current running version of Kubernetes on the control plane.
- detailedStatus
- Nullable<KubernetesClusterDetailedStatus>
The current status of the Kubernetes cluster.
- detailedStatusMessage
- String
The descriptive message about the current detailed status.
- featureStatuses
- IEnumerable<FeatureStatus>
The current feature settings.
- nodes
- IEnumerable<KubernetesClusterNode>
The details of the nodes in this cluster.
- provisioningState
- Nullable<KubernetesClusterProvisioningState>
The provisioning state of the Kubernetes cluster resource.
- aadAdminGroupObjectIds
- IEnumerable<String>
The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.
"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.
Returns
A new NetworkCloudKubernetesClusterData instance for mocking.
Exceptions
controlPlaneNodeConfiguration, initialAgentPoolConfigurations, kubernetesVersion or networkConfiguration is null.