Update-AzOperationalInsightsCluster
Syntax
UpdateByNameParameterSet (Default)
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>]
AllParameterSet
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>]
UpdateByResourceIdParameterSet
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
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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-BillingType
Billing type can be set as 'Cluster' or 'Workspaces'
Parameter properties
Type: String
Default value: None Accepted values: Cluster, Workspaces Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClusterName
The cluster name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityType
the identity type, value can be 'SystemAssigned', 'None', 'UserAssigned'.
Parameter properties
Type: String
Default value: None Accepted values: SystemAssigned, None, UserAssigned Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Specifies the cluster to be updated.
Type: PSCluster
Default value: None Supports wildcards: False DontShow: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyName
Key Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultUri
Key Vault Uri, "Purge Protection" and "Soft Delete" have to be enabled for this keyvault
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVersion
Key Version
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
The destination resource ID.
This can be copied from the Properties entry of the destination resource in Azure.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuCapacity
Sku Capacity
Parameter properties
Type: Nullable<T> [ Int64 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuName
Sku Name, now can be 'CapacityReservation' only
Parameter properties
Type: String
Default value: None Accepted values: CapacityReservation Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Tags of the cluster
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateByNameParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
AllParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateByResourceIdParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
