Get-AzSentinelDataConnector

Gets a Data Connector.

Please note that automation support is only available for the following data connectors:

  • AADDataConnector
  • AATPDataConnector
  • ASCDataConnector
  • AwsCloudTrailDataConnector
  • MCASDataConnector
  • MDATPDataConnector
  • OfficeDataConnector
  • TIDataConnector

Syntax

Get-AzSentinelDataConnector
   -ResourceGroupName <String>
   -WorkspaceName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSentinelDataConnector
   -ResourceGroupName <String>
   -WorkspaceName <String>
   -DataConnectorId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSentinelDataConnector
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSentinelDataConnector cmdlet gets a Data Connector from the specified workspace. If you specify the DataConnectorId parameter, a single DataConnector object is returned. If you do not specify the DataConnectorId parameter, an array containing all of the Data Connectors in the specified workspace are returned. You can use the DataConnector object to update the Data Connector, for example you can disable the DataConnector.

Examples

Example 1

PS C:\> $DataConnectors = Get-AzSentinelDataConnector -ResourceGroupName "MyResourceGroup" -WorkspaceName "MyWorkspaceName"

This example gets all of the DataConnectors in the specified workspace, and then stores it in the $DataConnectors variable.

Example 2

PS C:\> $DataConnector = Get-AzSentinelDataConnector -ResourceGroupName "MyResourceGroup" -WorkspaceName "MyWorkspaceName" -DataConnectorId "MyDataConnectorId"

This example gets an DataConnector in the specified workspace, and then stores it in the $DataConnector variable.

Example 3

Get-AzSentinelDataConnector @SentinelConnection | Where-Object {$_.Kind -eq "Office365"}

This example (using a connection object) gets the Office365 data connector.

Parameters

-DataConnectorId

Data Connector Id.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Resource group name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Resource Id.

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

Workspace Name.

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

Inputs

String

Outputs

Microsoft.Azure.Commands.SecurityInsights.Models.DataConnectors.PSSentinelDataConnector