Edit

Update-AzOperationalInsightsCluster

  • Reference
Module:
Az.OperationalInsights

update cluster

Syntax

Update-AzOperationalInsightsCluster
      -ResourceGroupName <String>
      -ClusterName <String>
      [-SkuName <String>]
      [-SkuCapacity <Int64>]
      [-KeyVaultUri <String>]
      [-KeyName <String>]
      [-KeyVersion <String>]
      [-Tag <Hashtable>]
      [-IdentityType <String>]
      [-BillingType <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzOperationalInsightsCluster
      [-ResourceGroupName <String>]
      [-ClusterName <String>]
      [-ResourceId <String>]
      [-InputCluster <PSCluster>]
      [-SkuName <String>]
      [-SkuCapacity <Int64>]
      [-KeyVaultUri <String>]
      [-KeyName <String>]
      [-KeyVersion <String>]
      [-Tag <Hashtable>]
      [-IdentityType <String>]
      [-BillingType <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzOperationalInsightsCluster
      -ResourceId <String>
      [-SkuName <String>]
      [-SkuCapacity <Int64>]
      [-KeyVaultUri <String>]
      [-KeyName <String>]
      [-KeyVersion <String>]
      [-Tag <Hashtable>]
      [-IdentityType <String>]
      [-BillingType <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzOperationalInsightsCluster
      -InputCluster <PSCluster>
      [-SkuName <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

update cluster

Examples

Example 1

Update-AzOperationalInsightsCluster -ResourceGroupName "rg-name" -ClusterName "cluster-name" -SkuName CapacityReservation -SkuCapacity 1200 -KeyVaultUri "uri" -KeyName "key-name" -KeyVersion "version"

Identity						: Microsoft.Azure.Commands.OperationalInsights.Models.PSIdentity
Sku								: Microsoft.Azure.Commands.OperationalInsights.Models.PSClusterSku
ClusterId						: {cluster-id}
ProvisioningState				: Succeeded
IsDoubleEncryptionEnabled		: True
IsAvailabilityZonesEnabled		: False
BillingType						: Cluster
KeyVaultProperties				: Microsoft.Azure.Commands.OperationalInsights.Models.PSKeyVaultProperties
LastModifiedDate				: 
CreatedDate						: 
AssociatedWorkspaces			: {workspaces}
CapacityReservationProperties	: Microsoft.Azure.Management.OperationalInsights.Models.CapacityReservationProperties
Location						: South Central US
Id								: /subscriptions/{subscription}/resourceGroups/{rg-name}/providers/Microsoft.OperationalInsights/clusters/{cluster-name}
Name							: {cluster-name}
Type							: Microsoft.OperationalInsights/clusters
Tags							: {}

update cluster with key vault properties and sku

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BillingType

Billing type can be set as 'Cluster' or 'Workspaces'

Type:String
Accepted values:Cluster, Workspaces
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClusterName

The cluster name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

the identity type, value can be 'SystemAssigned', 'None', 'UserAssigned'.

Type:String
Accepted values:SystemAssigned, None, UserAssigned
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputCluster

Specifies the cluster to be updated.

Type:PSCluster
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-KeyName

Key Name

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultUri

Key Vault Uri, "Purge Protection" and "Soft Delete" have to be enabled for this keyvault

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVersion

Key Version

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SkuCapacity

Sku Capacity

Type:Nullable<T>[Int64]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuName

Sku Name, now can be 'CapacityReservation' only

Type:String
Accepted values:CapacityReservation
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Tags of the cluster

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Inputs

String

PSCluster

Outputs

PSCluster