Get-AzSentinelOnboardingState

Reference

Module:: Az.SecurityInsights

Get Sentinel onboarding state

Syntax

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

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

Get-AzSentinelOnboardingState
   -InputObject <ISecurityInsightsIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get Sentinel onboarding state

Examples

Example 1: List all Onboarding States

Get-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"

Id   : /subscriptions/314b1a41-c53c-4092-8d4a-2810f6a44a0c/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/cybersecurity/providers/Microsoft.SecurityInsights/onboardingStates/default
Name : default

This command lists all Onboarding States under a Microsoft Sentinel workspace.

Example 2: Get an Onboarding State

Get-AzSentinelOnboardingState -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" -Name "default"

Id   : /subscriptions/314b1a41-c53c-4092-8d4a-2810f6a44a0c/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/cybersecurity/providers/Microsoft.SecurityInsights/onboardingStates/default
Name : default

This command gets an Onboarding State.

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:	ISecurityInsightsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The Sentinel onboarding state name. Supports - default

Type:	String
Aliases:	SentinelOnboardingStateName
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

-WorkspaceName

The name of the workspace.

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

Inputs

ISecurityInsightsIdentity

Outputs

ISentinelOnboardingState