Update-AzNetworkCloudCluster
Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
Update-AzNetworkCloudCluster
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AggregatorOrSingleRackDefinitionAvailabilityZone <String>]
[-AggregatorOrSingleRackDefinitionBareMetalMachineConfiguration <IBareMetalMachineConfigurationData[]>]
[-AggregatorOrSingleRackDefinitionNetworkRackId <String>]
[-AggregatorOrSingleRackDefinitionRackLocation <String>]
[-AggregatorOrSingleRackDefinitionRackSerialNumber <String>]
[-AggregatorOrSingleRackDefinitionRackSkuId <String>]
[-AggregatorOrSingleRackDefinitionStorageApplianceConfiguration <IStorageApplianceConfigurationData[]>]
[-ClusterLocation <String>]
[-ClusterServicePrincipalApplicationId <String>]
[-ClusterServicePrincipalId <String>]
[-ClusterServicePrincipalPassword <SecureString>]
[-ClusterServicePrincipalTenantId <String>]
[-ComputeDeploymentThresholdGrouping <ValidationThresholdGrouping>]
[-ComputeDeploymentThresholdType <ValidationThresholdType>]
[-ComputeDeploymentThresholdValue <Int64>]
[-ComputeRackDefinition <IRackDefinition[]>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzNetworkCloudCluster
-InputObject <INetworkCloudIdentity>
[-AggregatorOrSingleRackDefinitionAvailabilityZone <String>]
[-AggregatorOrSingleRackDefinitionBareMetalMachineConfiguration <IBareMetalMachineConfigurationData[]>]
[-AggregatorOrSingleRackDefinitionNetworkRackId <String>]
[-AggregatorOrSingleRackDefinitionRackLocation <String>]
[-AggregatorOrSingleRackDefinitionRackSerialNumber <String>]
[-AggregatorOrSingleRackDefinitionRackSkuId <String>]
[-AggregatorOrSingleRackDefinitionStorageApplianceConfiguration <IStorageApplianceConfigurationData[]>]
[-ClusterLocation <String>]
[-ClusterServicePrincipalApplicationId <String>]
[-ClusterServicePrincipalId <String>]
[-ClusterServicePrincipalPassword <SecureString>]
[-ClusterServicePrincipalTenantId <String>]
[-ComputeDeploymentThresholdGrouping <ValidationThresholdGrouping>]
[-ComputeDeploymentThresholdType <ValidationThresholdType>]
[-ComputeDeploymentThresholdValue <Int64>]
[-ComputeRackDefinition <IRackDefinition[]>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
$storageapplianceconfigurationdata = @()
$baremetalmachineconfigurationdata = @()
$computerackdefinition = @(@{IRackDefinition = "The list of rack definitions for the compute racks in a multi-rackcluster, or an empty list in a single-rack cluster."})
$tagHash = @{
tag = "tag"
tagUpdate = "tagUpdate"
}
$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force
Update-AzNetworkCloudCluster -ResourceGroupName resourceGroup -Name clusterName -SubscriptionId subscriptionId -AggregatorOrSingleRackDefinitionNetworkRackId rackId -AggregatorOrSingleRackDefinitionRackSerialNumber sr1234 -AggregatorOrSingleRackDefinitionRackSkuId rackSku -AggregatorOrSingleRackDefinitionAvailabilityZone availabilityzone -AggregatorOrSingleRackDefinitionBareMetalMachineConfiguration $baremetalmachineconfigurationdata -AggregatorOrSingleRackDefinitionRackLocation rackLocation -AggregatorOrSingleRackDefinitionStorageApplianceConfiguration $storageapplianceconfigurationdata -ClusterServicePrincipalApplicationId clusterServicePrincipalAppId -ClusterServicePrincipalId ClusterServicePrincipalId -ClusterServicePrincipalPassword $securePassword -ClusterServicePrincipalTenantId tenantId -ComputeRackDefinition $computerackdefinition -Tag $tagHash
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ResourceGro
upName
-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- -----------
eastus clusterName 08/09/2023 18:33:54 user User 08/09/2023 19:45:35 user User RGName
Patch the properties of the provided cluster, or update the tags associated with the cluster. Properties and tag updates can be done independently.
The zone name used for this rack when created. Availability zones are used for workload placement.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The unordered list of bare metal machine configuration. To construct, see NOTES section for AGGREGATORORSINGLERACKDEFINITIONBAREMETALMACHINECONFIGURATION properties and create a hash table.
Type: | IBareMetalMachineConfigurationData[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The resource ID of the network rack that matches this rack definition.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The free-form description of the rack's location.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The resource ID of the sku for the rack being added.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The list of storage appliance configuration data for this rack. To construct, see NOTES section for AGGREGATORORSINGLERACKDEFINITIONSTORAGEAPPLIANCECONFIGURATION properties and create a hash table.
Type: | IStorageApplianceConfigurationData[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The customer-provided location information to identify where the cluster resides.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The application ID, also known as client ID, of the service principal.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The principal ID, also known as the object ID, of the service principal.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The password of the service principal.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The tenant ID, also known as the directory ID, of the tenant in which the service principal is created.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Selection of how the type evaluation is applied to the cluster calculation.
Type: | ValidationThresholdGrouping |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Selection of how the threshold should be evaluated.
Type: | ValidationThresholdType |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The numeric threshold value.
Type: | Int64 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The list of rack definitions for the compute racks in a multi-rackcluster, or an empty list in a single-rack cluster. To construct, see NOTES section for COMPUTERACKDEFINITION properties and create a hash table.
Type: | IRackDefinition[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | INetworkCloudIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The name of the cluster.
Type: | String |
Aliases: | ClusterName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The ID of the target subscription. The value must be an UUID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The Azure resource tags that will replace the existing ones.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Azure PowerShell feedback
Azure PowerShell is an open source project. Select a link to provide feedback: