Edit

Set-AzOperationalInsightsWorkspace

  • Reference
Module:
Az.OperationalInsights

Updates a workspace.

Syntax

Set-AzOperationalInsightsWorkspace
   [-ResourceGroupName] <String>
   [-Name] <String>
   [[-Sku] <String>]
   [-SkuCapacity <Int32>]
   [[-Tag] <Hashtable>]
   [-RetentionInDays <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-PublicNetworkAccessForIngestion <String>]
   [-PublicNetworkAccessForQuery <String>]
   [-DailyQuotaGb <Int32>]
   [[-ForceCmkForQuery] <Boolean>]
   [[-DisableLocalAuth] <Boolean>]
   [-DefaultDataCollectionRuleResourceId <String>]
   [<CommonParameters>]
Set-AzOperationalInsightsWorkspace
   [-Workspace] <PSWorkspace>
   [[-Sku] <String>]
   [-SkuCapacity <Int32>]
   [[-Tag] <Hashtable>]
   [-RetentionInDays <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-PublicNetworkAccessForIngestion <String>]
   [-PublicNetworkAccessForQuery <String>]
   [-DailyQuotaGb <Int32>]
   [[-ForceCmkForQuery] <Boolean>]
   [[-DisableLocalAuth] <Boolean>]
   [-DefaultDataCollectionRuleResourceId <String>]
   [<CommonParameters>]

Description

The Set-AzOperationalInsightsWorkspace cmdlet changes the configuration of a workspace.

Examples

Example 1: Modify a workspace by name

Set-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku Standard -Tag @{ "Department" = "IT" }

This command modifies the SKU and tags of the workspace named MyWorkspace in the resource group named ContosoResourceGroup.

Example 2: Update a workspace by using the pipeline

Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" | Set-AzOperationalInsightsWorkspace -Sku "Premium"

This command uses the Get-AzOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkSpace, and then passes it to the Set-AzOperationalInsightsWorkspace cmdlet by using the pipeline operator to set the SKU to Premium.

Parameters

-DailyQuotaGb

The daily volume cap for ingestion - number

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

-DefaultDataCollectionRuleResourceId

The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.

Type:String
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

-DisableLocalAuth

Allow to opt-out of local authentication and ensure customers can use only MSI and AAD for exclusive authentication

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

-ForceCmkForQuery

Gets or sets indicates whether customer managed storage is mandatory for query management

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

-Name

Specifies the workspace name.

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

-PublicNetworkAccessForIngestion

The network access type for accessing workspace ingestion. Value should be 'Enabled' or 'Disabled'

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

-PublicNetworkAccessForQuery

The network access type for accessing workspace query. Value should be 'Enabled' or 'Disabled'

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

-ResourceGroupName

Specifies the Azure resource group name.

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

-RetentionInDays

The workspace data retention in days. 730 days is the maximum allowed for all other Skus

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

-Sku

The service tier of the workspace.

Type:String
Accepted values:free, standard, premium, pernode, standalone, pergb2018, capacityreservation, lacluster
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SkuCapacity

Sku Capacity, value need to be multiple of 100 and above 0.

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

-Tag

The resource tags for the workspace.

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

-Workspace

Specifies the workspace to be updated.

Type:PSWorkspace
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSWorkspace

String

Hashtable

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

PSWorkspace