Get-AzMonitorWorkspace

Reference

Module:: Az.Monitor

Returns the specific Azure Monitor workspace

Syntax

Get-AzMonitorWorkspace
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzMonitorWorkspace
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzMonitorWorkspace
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzMonitorWorkspace
   -InputObject <IMonitorWorkspaceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns the specific Azure Monitor workspace

Examples

Example 1: List the specific Azure Monitor workspace.

Get-AzMonitorWorkspace

Name                   Location ProvisioningState PublicNetworkAccess ResourceGroupName
----                   -------- ----------------- ------------------- -----------------
azps-monitor-workspace eastus   Succeeded         Enabled             azps_test_group

List the specific Azure Monitor workspace.

Example 2: List the specific Azure Monitor workspace by Resource Groupy.

Get-AzMonitorWorkspace -ResourceGroupName azps_test_group

Name                   Location ProvisioningState PublicNetworkAccess ResourceGroupName
----                   -------- ----------------- ------------------- -----------------
azps-monitor-workspace eastus   Succeeded         Enabled             azps_test_group

List the specific Azure Monitor workspace by Resource Groupy.

Example 3: Get the specific Azure Monitor workspace by monitor workspace name.

Get-AzMonitorWorkspace -ResourceGroupName azps_test_group -Name azps-monitor-workspace

Name                   Location ProvisioningState PublicNetworkAccess ResourceGroupName
----                   -------- ----------------- ------------------- -----------------
azps-monitor-workspace eastus   Succeeded         Enabled             azps_test_group

Get the specific Azure Monitor workspace by monitor workspace name.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IMonitorWorkspaceIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the Azure Monitor workspace. The name is case insensitive

Type:	String
Aliases:	AzureMonitorWorkspaceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IMonitorWorkspaceIdentity

Outputs

IAzureMonitorWorkspaceResource