Edit

Share via

Set-AzureRmOperationalInsightsStorageInsight

  • Reference
Module:
AzureRM.OperationalInsights

Updates a Storage Insight.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmOperationalInsightsStorageInsight
   [-ResourceGroupName] <String>
   [-WorkspaceName] <String>
   [-Name] <String>
   [[-StorageAccountKey] <String>]
   [[-Tables] <String[]>]
   [[-Containers] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzureRmOperationalInsightsStorageInsight
   [-Workspace] <PSWorkspace>
   [-Name] <String>
   [[-StorageAccountKey] <String>]
   [[-Tables] <String[]>]
   [[-Containers] <String[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzureRmOperationalInsightsStorageInsight cmdlet changes the configuration of a Storage Insight.

Examples

Example 1: Modify a Storage Insight by name

PS C:\>Set-AzureRmOperationalInsightsStorageInsight -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "MyWorkspace" -Name "MyStorageInsight" -Tables @("WADWindowsEventLogsTable")

This command modifies the tables from which the Storage Insight named MyStorageInsight reads.

Example 2: Modify a Storage Insight by using a workspace object

PS C:\>$Workspace = Get-AzureRmOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace"

PS C:\>Set-AzureRmOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight" -Containers @("wad-iis-logfiles")

The first command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the workspace named MyWorkspace, and then stores it in the $Workspace variable. The second command modifies the containers from which the Storage Insight named MyStorageInsight reads.

Parameters

-Containers

Specifies the list of containers that provide the data.

Type:String[]
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

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

-Name

Specifies the name of a Storage Insight.

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

-ResourceGroupName

Specifies the name of an Azure resource group that contains a workspace.

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

-StorageAccountKey

Specifies the access key for the storage account.

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

-Tables

Specifies the list of tables that contain the data.

Type:String[]
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Workspace

Specifies the workspace that contains the Storage Insight.

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

-WorkspaceName

Specifies the name of a workspace.

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

Inputs

PSWorkspace

Parameters: Workspace (ByValue)

String

String[]

Outputs

PSStorageInsight