< Back
Set-AzureRmOperationalInsightsWorkspace
Post
NAME Set-AzureRmOperationalInsightsWorkspace
SYNOPSIS
Updates a workspace.
SYNTAX
Set-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [[-Sku] {free | standard | premium | pernode | standalone}]
[[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-RetentionInDays <Int32>] [<CommonParameters>]
Set-AzureRmOperationalInsightsWorkspace [-Workspace] <PSWorkspace> [[-Sku] {free | standard | premium | pernode | standalone}] [[-Tag]
<Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-RetentionInDays <Int32>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmOperationalInsightsWorkspace cmdlet changes the configuration of a workspace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the workspace name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the Azure resource group name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RetentionInDays <Int32>
The workspace data retention in days. 730 days is the maximum allowed for all other Skus
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <String>
Specifies the service tier of the workspace. Valid values are:
- free
- standard
- premium
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <Hashtable>
The resource tags for the workspace.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Workspace <PSWorkspace>
Specifies the workspace to be updated.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSWorkspace
Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace
NOTES
Example 1: Modify a workspace by name
PS C:\\>Set-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku Standard -Tags @{ "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
PS C:\\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" |
Set-AzureRmOperationalInsightsWorkspace -Sku "Premium"
This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkSpace, and then passes it to the
Set-AzureRmOperationalInsightsWorkspace cmdlet by using the pipeline operator to set the SKU to Premium.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sworkspace
Azure Operational Insights Cmdlets
Get-AzureRmOperationalInsightsWorkspace
SYNOPSIS
Updates a workspace.
SYNTAX
Set-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] <String> [-Name] <String> [[-Sku] {free | standard | premium | pernode | standalone}]
[[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-RetentionInDays <Int32>] [<CommonParameters>]
Set-AzureRmOperationalInsightsWorkspace [-Workspace] <PSWorkspace> [[-Sku] {free | standard | premium | pernode | standalone}] [[-Tag]
<Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-RetentionInDays <Int32>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmOperationalInsightsWorkspace cmdlet changes the configuration of a workspace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the workspace name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the Azure resource group name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RetentionInDays <Int32>
The workspace data retention in days. 730 days is the maximum allowed for all other Skus
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <String>
Specifies the service tier of the workspace. Valid values are:
- free
- standard
- premium
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Tag <Hashtable>
The resource tags for the workspace.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Workspace <PSWorkspace>
Specifies the workspace to be updated.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSWorkspace
Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace
NOTES
Example 1: Modify a workspace by name
PS C:\\>Set-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" -Sku Standard -Tags @{ "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
PS C:\\>Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace" |
Set-AzureRmOperationalInsightsWorkspace -Sku "Premium"
This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkSpace, and then passes it to the
Set-AzureRmOperationalInsightsWorkspace cmdlet by using the pipeline operator to set the SKU to Premium.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sworkspace
Azure Operational Insights Cmdlets
Get-AzureRmOperationalInsightsWorkspace