1. Packages
  2. Azure Classic
  3. API Docs
  4. sentinel
  5. DataConnectorAzureActiveDirectory

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

azure.sentinel.DataConnectorAzureActiveDirectory

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

    Manages a Azure Active Directory Data Connector.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-rg",
        location: "West Europe",
    });
    const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
        name: "example-workspace",
        location: example.location,
        resourceGroupName: example.name,
        sku: "PerGB2018",
    });
    const exampleLogAnalyticsWorkspaceOnboarding = new azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", {workspaceId: exampleAnalyticsWorkspace.id});
    const exampleDataConnectorAzureActiveDirectory = new azure.sentinel.DataConnectorAzureActiveDirectory("example", {
        name: "example",
        logAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.workspaceId,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-rg",
        location="West Europe")
    example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
        name="example-workspace",
        location=example.location,
        resource_group_name=example.name,
        sku="PerGB2018")
    example_log_analytics_workspace_onboarding = azure.sentinel.LogAnalyticsWorkspaceOnboarding("example", workspace_id=example_analytics_workspace.id)
    example_data_connector_azure_active_directory = azure.sentinel.DataConnectorAzureActiveDirectory("example",
        name="example",
        log_analytics_workspace_id=example_log_analytics_workspace_onboarding.workspace_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/operationalinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/sentinel"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
    			Name:              pulumi.String("example-workspace"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Sku:               pulumi.String("PerGB2018"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLogAnalyticsWorkspaceOnboarding, err := sentinel.NewLogAnalyticsWorkspaceOnboarding(ctx, "example", &sentinel.LogAnalyticsWorkspaceOnboardingArgs{
    			WorkspaceId: exampleAnalyticsWorkspace.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = sentinel.NewDataConnectorAzureActiveDirectory(ctx, "example", &sentinel.DataConnectorAzureActiveDirectoryArgs{
    			Name:                    pulumi.String("example"),
    			LogAnalyticsWorkspaceId: exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-rg",
            Location = "West Europe",
        });
    
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
        {
            Name = "example-workspace",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Sku = "PerGB2018",
        });
    
        var exampleLogAnalyticsWorkspaceOnboarding = new Azure.Sentinel.LogAnalyticsWorkspaceOnboarding("example", new()
        {
            WorkspaceId = exampleAnalyticsWorkspace.Id,
        });
    
        var exampleDataConnectorAzureActiveDirectory = new Azure.Sentinel.DataConnectorAzureActiveDirectory("example", new()
        {
            Name = "example",
            LogAnalyticsWorkspaceId = exampleLogAnalyticsWorkspaceOnboarding.WorkspaceId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
    import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboarding;
    import com.pulumi.azure.sentinel.LogAnalyticsWorkspaceOnboardingArgs;
    import com.pulumi.azure.sentinel.DataConnectorAzureActiveDirectory;
    import com.pulumi.azure.sentinel.DataConnectorAzureActiveDirectoryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-rg")
                .location("West Europe")
                .build());
    
            var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
                .name("example-workspace")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku("PerGB2018")
                .build());
    
            var exampleLogAnalyticsWorkspaceOnboarding = new LogAnalyticsWorkspaceOnboarding("exampleLogAnalyticsWorkspaceOnboarding", LogAnalyticsWorkspaceOnboardingArgs.builder()
                .workspaceId(exampleAnalyticsWorkspace.id())
                .build());
    
            var exampleDataConnectorAzureActiveDirectory = new DataConnectorAzureActiveDirectory("exampleDataConnectorAzureActiveDirectory", DataConnectorAzureActiveDirectoryArgs.builder()
                .name("example")
                .logAnalyticsWorkspaceId(exampleLogAnalyticsWorkspaceOnboarding.workspaceId())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-rg
          location: West Europe
      exampleAnalyticsWorkspace:
        type: azure:operationalinsights:AnalyticsWorkspace
        name: example
        properties:
          name: example-workspace
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku: PerGB2018
      exampleLogAnalyticsWorkspaceOnboarding:
        type: azure:sentinel:LogAnalyticsWorkspaceOnboarding
        name: example
        properties:
          workspaceId: ${exampleAnalyticsWorkspace.id}
      exampleDataConnectorAzureActiveDirectory:
        type: azure:sentinel:DataConnectorAzureActiveDirectory
        name: example
        properties:
          name: example
          logAnalyticsWorkspaceId: ${exampleLogAnalyticsWorkspaceOnboarding.workspaceId}
    

    Create DataConnectorAzureActiveDirectory Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataConnectorAzureActiveDirectory(name: string, args: DataConnectorAzureActiveDirectoryArgs, opts?: CustomResourceOptions);
    @overload
    def DataConnectorAzureActiveDirectory(resource_name: str,
                                          args: DataConnectorAzureActiveDirectoryArgs,
                                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataConnectorAzureActiveDirectory(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          log_analytics_workspace_id: Optional[str] = None,
                                          name: Optional[str] = None,
                                          tenant_id: Optional[str] = None)
    func NewDataConnectorAzureActiveDirectory(ctx *Context, name string, args DataConnectorAzureActiveDirectoryArgs, opts ...ResourceOption) (*DataConnectorAzureActiveDirectory, error)
    public DataConnectorAzureActiveDirectory(string name, DataConnectorAzureActiveDirectoryArgs args, CustomResourceOptions? opts = null)
    public DataConnectorAzureActiveDirectory(String name, DataConnectorAzureActiveDirectoryArgs args)
    public DataConnectorAzureActiveDirectory(String name, DataConnectorAzureActiveDirectoryArgs args, CustomResourceOptions options)
    
    type: azure:sentinel:DataConnectorAzureActiveDirectory
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DataConnectorAzureActiveDirectoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataConnectorAzureActiveDirectoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataConnectorAzureActiveDirectoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataConnectorAzureActiveDirectoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataConnectorAzureActiveDirectoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dataConnectorAzureActiveDirectoryResource = new Azure.Sentinel.DataConnectorAzureActiveDirectory("dataConnectorAzureActiveDirectoryResource", new()
    {
        LogAnalyticsWorkspaceId = "string",
        Name = "string",
        TenantId = "string",
    });
    
    example, err := sentinel.NewDataConnectorAzureActiveDirectory(ctx, "dataConnectorAzureActiveDirectoryResource", &sentinel.DataConnectorAzureActiveDirectoryArgs{
    	LogAnalyticsWorkspaceId: pulumi.String("string"),
    	Name:                    pulumi.String("string"),
    	TenantId:                pulumi.String("string"),
    })
    
    var dataConnectorAzureActiveDirectoryResource = new DataConnectorAzureActiveDirectory("dataConnectorAzureActiveDirectoryResource", DataConnectorAzureActiveDirectoryArgs.builder()
        .logAnalyticsWorkspaceId("string")
        .name("string")
        .tenantId("string")
        .build());
    
    data_connector_azure_active_directory_resource = azure.sentinel.DataConnectorAzureActiveDirectory("dataConnectorAzureActiveDirectoryResource",
        log_analytics_workspace_id="string",
        name="string",
        tenant_id="string")
    
    const dataConnectorAzureActiveDirectoryResource = new azure.sentinel.DataConnectorAzureActiveDirectory("dataConnectorAzureActiveDirectoryResource", {
        logAnalyticsWorkspaceId: "string",
        name: "string",
        tenantId: "string",
    });
    
    type: azure:sentinel:DataConnectorAzureActiveDirectory
    properties:
        logAnalyticsWorkspaceId: string
        name: string
        tenantId: string
    

    DataConnectorAzureActiveDirectory Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataConnectorAzureActiveDirectory resource accepts the following input properties:

    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    Name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    TenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    Name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    TenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name String
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId String

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name str
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenant_id str

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name String
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId String

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataConnectorAzureActiveDirectory resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DataConnectorAzureActiveDirectory Resource

    Get an existing DataConnectorAzureActiveDirectory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataConnectorAzureActiveDirectoryState, opts?: CustomResourceOptions): DataConnectorAzureActiveDirectory
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            log_analytics_workspace_id: Optional[str] = None,
            name: Optional[str] = None,
            tenant_id: Optional[str] = None) -> DataConnectorAzureActiveDirectory
    func GetDataConnectorAzureActiveDirectory(ctx *Context, name string, id IDInput, state *DataConnectorAzureActiveDirectoryState, opts ...ResourceOption) (*DataConnectorAzureActiveDirectory, error)
    public static DataConnectorAzureActiveDirectory Get(string name, Input<string> id, DataConnectorAzureActiveDirectoryState? state, CustomResourceOptions? opts = null)
    public static DataConnectorAzureActiveDirectory get(String name, Output<String> id, DataConnectorAzureActiveDirectoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    Name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    TenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    LogAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    Name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    TenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name String
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId String

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId string
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name string
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId string

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    log_analytics_workspace_id str
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name str
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenant_id str

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    logAnalyticsWorkspaceId String
    The ID of the Log Analytics Workspace that this Azure Active Directory Data Connector resides in. Changing this forces a new Azure Active Directory Data Connector to be created.
    name String
    The name which should be used for this Azure Active Directory Data Connector. Changing this forces a new Azure Active Directory Data Connector to be created.
    tenantId String

    The ID of the tenant that this Azure Active Directory Data Connector connects to. Changing this forces a new Azure Active Directory Data Connector to be created.

    NOTE Currently, only the same tenant as the running account is allowed. Cross-tenant scenario is not supported yet.

    Import

    Azure Active Directory Data Connectors can be imported using the resource id, e.g.

    $ pulumi import azure:sentinel/dataConnectorAzureActiveDirectory:DataConnectorAzureActiveDirectory example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/dataConnectors/dc1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi