NetworkCloudClusterResource Class

Definition

A class representing a NetworkCloudCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a NetworkCloudClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetNetworkCloudClusters method.

public class NetworkCloudClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.NetworkCloud.NetworkCloudClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.NetworkCloud.NetworkCloudClusterData>
type NetworkCloudClusterResource = class
    inherit ArmResource
    interface IJsonModel<NetworkCloudClusterData>
    interface IPersistableModel<NetworkCloudClusterData>
Public Class NetworkCloudClusterResource
Inherits ArmResource
Implements IJsonModel(Of NetworkCloudClusterData), IPersistableModel(Of NetworkCloudClusterData)
Inheritance
NetworkCloudClusterResource
Implements

Constructors

Name Description
NetworkCloudClusterResource()

Initializes a new instance of NetworkCloudClusterResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
ContinueUpdateVersion(WaitUntil, ClusterContinueUpdateVersionContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/continueUpdateVersion.
  • Operation Id. : Clusters_ContinueUpdateVersion.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
ContinueUpdateVersionAsync(WaitUntil, ClusterContinueUpdateVersionContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/continueUpdateVersion.
  • Operation Id. : Clusters_ContinueUpdateVersion.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, MatchConditions, CancellationToken)

Delete the provided cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Delete.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
DeleteAsync(WaitUntil, MatchConditions, CancellationToken)

Delete the provided cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Delete.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
Deploy(WaitUntil, ClusterDeployContent, CancellationToken)

Deploy the cluster using the rack configuration provided during creation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy.
  • Operation Id. : Clusters_Deploy.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
DeployAsync(WaitUntil, ClusterDeployContent, CancellationToken)

Deploy the cluster using the rack configuration provided during creation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy.
  • Operation Id. : Clusters_Deploy.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
Get(CancellationToken)

Get properties of the provided cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Get.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
GetAsync(CancellationToken)

Get properties of the provided cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Get.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetNetworkCloudBareMetalMachineKeySet(String, CancellationToken)

Get bare metal machine key set of the provided cluster.

GetNetworkCloudBareMetalMachineKeySetAsync(String, CancellationToken)

Get bare metal machine key set of the provided cluster.

GetNetworkCloudBareMetalMachineKeySets()

Gets a collection of NetworkCloudBareMetalMachineKeySets in the NetworkCloudClusterResource.

GetNetworkCloudBmcKeySet(String, CancellationToken)

Get baseboard management controller key set of the provided cluster.

GetNetworkCloudBmcKeySetAsync(String, CancellationToken)

Get baseboard management controller key set of the provided cluster.

GetNetworkCloudBmcKeySets()

Gets a collection of NetworkCloudBmcKeySets in the NetworkCloudClusterResource.

GetNetworkCloudClusterMetricsConfiguration(String, CancellationToken)

Get metrics configuration of the provided cluster.

GetNetworkCloudClusterMetricsConfigurationAsync(String, CancellationToken)

Get metrics configuration of the provided cluster.

GetNetworkCloudClusterMetricsConfigurations()

Gets a collection of NetworkCloudClusterMetricsConfigurations in the NetworkCloudClusterResource.

GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
Inspect(WaitUntil, NetworkCloudClusterInspectContent, CancellationToken)

Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/inspect.
  • Operation Id. : Clusters_Inspect.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
InspectAsync(WaitUntil, NetworkCloudClusterInspectContent, CancellationToken)

Trigger an inspection of the cluster to perform validation and optional corrective actions based on the supplied additional actions and filters.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/inspect.
  • Operation Id. : Clusters_Inspect.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

ScanRuntime(WaitUntil, ClusterScanRuntimeContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime.
  • Operation Id. : Clusters_ScanRuntime.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
ScanRuntimeAsync(WaitUntil, ClusterScanRuntimeContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime.
  • Operation Id. : Clusters_ScanRuntime.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, NetworkCloudClusterPatch, MatchConditions, CancellationToken)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Update.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
UpdateAsync(WaitUntil, NetworkCloudClusterPatch, MatchConditions, CancellationToken)

Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}.
  • Operation Id. : Clusters_Update.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
UpdateVersion(WaitUntil, ClusterUpdateVersionContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion.
  • Operation Id. : Clusters_UpdateVersion.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.
UpdateVersionAsync(WaitUntil, ClusterUpdateVersionContent, CancellationToken)

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

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/updateVersion.
  • Operation Id. : Clusters_UpdateVersion.
  • Default Api Version. : 2026-01-01-preview.
  • Resource. : NetworkCloudClusterResource.

Explicit Interface Implementations

Name Description
IJsonModel<NetworkCloudClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<NetworkCloudClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<NetworkCloudClusterData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<NetworkCloudClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<NetworkCloudClusterData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to