Get-AzOperationalInsightsWorkspace

  • Reference
Module:
Az.OperationalInsights

Gets information about a workspace.

Syntax

Get-AzOperationalInsightsWorkspace
   [[-ResourceGroupName] <String>]
   [[-Name] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzOperationalInsightsWorkspace cmdlet gets information about an existing workspace. If you specify a workspace name, this cmdlet gets information about that workspace. If you do not specify a name, this cmdlet gets information about all workspaces in a resource group. If you do not specify a name and resource group, this cmdlet gets information about all workspaces in a subscription.

Examples

Example 1: Get a workspace by name

Get-AzOperationalInsightsWorkspace -Name "MyWorkspace" -ResourceGroupName "ContosoResourceGroup"

This command gets a workspace named MyWorkspace in the resource group named ContosoResourceGroup.

Parameters

-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

-Name

Specifies the workspace name.

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

-ResourceGroupName

Specifies the name of an Azure resource group.

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

Inputs

String

Outputs

PSWorkspace