Get-AzSentinelDataConnector
Gets a data connector.
Syntax
Get-AzSentinelDataConnector
-ResourceGroupName <String>
-WorkspaceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelDataConnector
-Id <String>
-ResourceGroupName <String>
-WorkspaceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzSentinelDataConnector
-InputObject <ISecurityInsightsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets a data connector.
Examples
Example 1: List all Data Connectors
Get-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName"
Kind : AzureActiveDirectory
Name : 8207e1f9-a793-4869-afb1-5ad4540d66d1
Kind : AzureAdvancedThreatProtection
Name : 1d75aada-a558-4461-986b-c6822182e81d
Kind : Office365
Name : 6323c716-83ae-4cfd-bf93-58235c8beb23
This command lists all DataConnectors under a Microsoft Sentinel workspace.
Example 2: Get a specific Data Connector
Get-AzSentinelDataConnector -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | Where-Object {$_.kind -eq "Office365"}
Kind : Office365
Name : 6323c716-83ae-4cfd-bf93-58235c8beb23
SharePointState : enabled
This command gets a specific DataConnector based on kind
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 |
-Id
Connector ID
Type: | String |
Aliases: | DataConnectorId |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-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
Outputs
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <ISecurityInsightsIdentity>
: Identity Parameter
[ActionId <String>]
: Action ID[AlertRuleTemplateId <String>]
: Alert rule template ID[AutomationRuleId <String>]
: Automation rule ID[BookmarkId <String>]
: Bookmark ID[ConsentId <String>]
: consent ID[DataConnectorId <String>]
: Connector ID[EntityId <String>]
: entity ID[EntityQueryId <String>]
: entity query ID[EntityQueryTemplateId <String>]
: entity query template ID[Id <String>]
: Resource identity path[IncidentCommentId <String>]
: Incident comment ID[IncidentId <String>]
: Incident ID[MetadataName <String>]
: The Metadata name.[Name <String>]
: Threat intelligence indicator name field.[RelationName <String>]
: Relation Name[ResourceGroupName <String>]
: The name of the resource group. The name is case insensitive.[RuleId <String>]
: Alert rule ID[SentinelOnboardingStateName <String>]
: The Sentinel onboarding state name. Supports - default[SettingsName <String>]
: The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba[SourceControlId <String>]
: Source control Id[SubscriptionId <String>]
: The ID of the target subscription.[WorkspaceName <String>]
: The name of the workspace.