< Back

Get-AzureRmOperationalInsightsWorkspace

Thu Apr 04, 2019 5:39 am

NAME Get-AzureRmOperationalInsightsWorkspace



SYNOPSIS

Gets information about a workspace.





SYNTAX

Get-AzureRmOperationalInsightsWorkspace [[-ResourceGroupName] <String>] [[-Name] <String>] [-DefaultProfile <IAzureContextContainer>]

[<CommonParameters>]





DESCRIPTION

The Get-AzureRmOperationalInsightsWorkspace 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.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the workspace name.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of an Azure resource group.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Collections.Generic.List`1[Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace]





Microsoft.Azure.Commands.OperationalInsights.Models.PSWorkspace







NOTES









Example 1: Get a workspace by name



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



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







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... sworkspace

Azure Operational Insights Cmdlets