Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzOperationalInsightsWorkspace

Gets information about a workspace.

Syntax

Default (Default) 

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

Specifies the workspace name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

Specifies the name of an Azure resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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.

Inputs

String

Outputs

PSWorkspace

Related Links

Feedback

Was this page helpful?