Get-AzOperationalInsightsStorageInsight
Gets information about a Storage Insight.
Syntax
ByWorkspaceName (Default)
Get-AzOperationalInsightsStorageInsight
[-ResourceGroupName] <String>
[-WorkspaceName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByWorkspaceObject
Get-AzOperationalInsightsStorageInsight
[-Workspace] <PSWorkspace>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzOperationalInsightsStorageInsight cmdlet gets information about an existing Storage Insight. If a Storage Insight name is specified, this cmdlet gets information about that Storage Insight. If you do not specify a name, this cmdlet gets information about all storage insights in a workspace.
Examples
Example 1: Get a Storage Insight by name
Get-AzOperationalInsightsStorageInsight -Name "MyStorageInsight" -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace"
This command gets the storage insight named MyStorageInsight from the workspace named ContosoWorkspace.
Example 2: Get a Storage Insight by using a workspace object
$Workspace = Get-AzOperationalInsightsWorkspace -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace"
Get-AzOperationalInsightsStorageInsight -Workspace $Workspace -Name "MyStorageInsight"
The first command uses the Get-AzOperationalInsightsWorkspace cmdlet to get an Operational Insights workspace, and then stores it in the $Workspace variable. The second command gets the storage insight named MyStorageInsight for the workspace in $Workspace.
Parameters
-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 |
-Name
Specifies the Storage Insight name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of an Azure resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByWorkspaceName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Workspace
Specifies the workspace that contains the Storage Insights.
Parameter properties
| Type: | PSWorkspace |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByWorkspaceObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkspaceName
Specifies the name of the workspace that contains the Storage Insights.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByWorkspaceName
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| 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.
