Edit

Share via

Get-AzOperationalInsightsWorkspaceSharedKey

  • Reference
Module:
Az.OperationalInsights

Gets the shared keys for a workspace.

Syntax

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

Description

The Get-AzOperationalInsightsWorkspaceSharedKey cmdlet lists the shared keys for a workspace. The keys are used to connect Operational Insights agents to the workspace.

Examples

Example 1: Get shared keys by workspace name

Get-AzOperationalInsightsWorkspaceSharedKey -ResourceGroupName "ContosoResourceGroup" -Name "MyWorkspace"

This command gets the shared keys for the workspace named MyWorkspace in the resource group named ContosoResourceGroup.

Example 2: Get shared keys by using the pipeline

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

This command gets the workspace named MyWorkspace using the Get-AzOperationalInsightsWorkspace cmdlet, and then passes the workspace to the Get-AzOperationalInsightsWorkspaceSharedKey cmdlet. The command gets the shared keys for that workspace.

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:True
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:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

PSWorkspaceKeys