1. Packages
  2. Azure Native
  3. API Docs
  4. securityinsights
  5. EntityAnalytics
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.securityinsights.EntityAnalytics

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Settings with single toggle. Azure REST API version: 2023-06-01-preview. Prior API version in Azure Native 1.x: 2021-03-01-preview.

    Example Usage

    Update EyesOn settings.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var entityAnalytics = new AzureNative.SecurityInsights.EntityAnalytics("entityAnalytics", new()
        {
            ResourceGroupName = "myRg",
            SettingsName = "EyesOn",
            WorkspaceName = "myWorkspace",
        });
    
    });
    
    package main
    
    import (
    	securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := securityinsights.NewEntityAnalytics(ctx, "entityAnalytics", &securityinsights.EntityAnalyticsArgs{
    			ResourceGroupName: pulumi.String("myRg"),
    			SettingsName:      pulumi.String("EyesOn"),
    			WorkspaceName:     pulumi.String("myWorkspace"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.securityinsights.EntityAnalytics;
    import com.pulumi.azurenative.securityinsights.EntityAnalyticsArgs;
    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 entityAnalytics = new EntityAnalytics("entityAnalytics", EntityAnalyticsArgs.builder()
                .resourceGroupName("myRg")
                .settingsName("EyesOn")
                .workspaceName("myWorkspace")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    entity_analytics = azure_native.securityinsights.EntityAnalytics("entityAnalytics",
        resource_group_name="myRg",
        settings_name="EyesOn",
        workspace_name="myWorkspace")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const entityAnalytics = new azure_native.securityinsights.EntityAnalytics("entityAnalytics", {
        resourceGroupName: "myRg",
        settingsName: "EyesOn",
        workspaceName: "myWorkspace",
    });
    
    resources:
      entityAnalytics:
        type: azure-native:securityinsights:EntityAnalytics
        properties:
          resourceGroupName: myRg
          settingsName: EyesOn
          workspaceName: myWorkspace
    

    Create EntityAnalytics Resource

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

    Constructor syntax

    new EntityAnalytics(name: string, args: EntityAnalyticsArgs, opts?: CustomResourceOptions);
    @overload
    def EntityAnalytics(resource_name: str,
                        args: EntityAnalyticsArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntityAnalytics(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        resource_group_name: Optional[str] = None,
                        workspace_name: Optional[str] = None,
                        entity_providers: Optional[Sequence[Union[str, EntityProviders]]] = None,
                        settings_name: Optional[str] = None)
    func NewEntityAnalytics(ctx *Context, name string, args EntityAnalyticsArgs, opts ...ResourceOption) (*EntityAnalytics, error)
    public EntityAnalytics(string name, EntityAnalyticsArgs args, CustomResourceOptions? opts = null)
    public EntityAnalytics(String name, EntityAnalyticsArgs args)
    public EntityAnalytics(String name, EntityAnalyticsArgs args, CustomResourceOptions options)
    
    type: azure-native:securityinsights:EntityAnalytics
    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 EntityAnalyticsArgs
    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 EntityAnalyticsArgs
    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 EntityAnalyticsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityAnalyticsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityAnalyticsArgs
    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 entityAnalyticsResource = new AzureNative.SecurityInsights.EntityAnalytics("entityAnalyticsResource", new()
    {
        Kind = "string",
        ResourceGroupName = "string",
        WorkspaceName = "string",
        EntityProviders = new[]
        {
            "string",
        },
        SettingsName = "string",
    });
    
    example, err := securityinsights.NewEntityAnalytics(ctx, "entityAnalyticsResource", &securityinsights.EntityAnalyticsArgs{
    	Kind:              pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	WorkspaceName:     pulumi.String("string"),
    	EntityProviders: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SettingsName: pulumi.String("string"),
    })
    
    var entityAnalyticsResource = new EntityAnalytics("entityAnalyticsResource", EntityAnalyticsArgs.builder()
        .kind("string")
        .resourceGroupName("string")
        .workspaceName("string")
        .entityProviders("string")
        .settingsName("string")
        .build());
    
    entity_analytics_resource = azure_native.securityinsights.EntityAnalytics("entityAnalyticsResource",
        kind="string",
        resource_group_name="string",
        workspace_name="string",
        entity_providers=["string"],
        settings_name="string")
    
    const entityAnalyticsResource = new azure_native.securityinsights.EntityAnalytics("entityAnalyticsResource", {
        kind: "string",
        resourceGroupName: "string",
        workspaceName: "string",
        entityProviders: ["string"],
        settingsName: "string",
    });
    
    type: azure-native:securityinsights:EntityAnalytics
    properties:
        entityProviders:
            - string
        kind: string
        resourceGroupName: string
        settingsName: string
        workspaceName: string
    

    EntityAnalytics 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 EntityAnalytics resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    EntityProviders List<Union<string, Pulumi.AzureNative.SecurityInsights.EntityProviders>>
    The relevant entity providers that are synced
    SettingsName string
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    EntityProviders []string
    The relevant entity providers that are synced
    SettingsName string
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    entityProviders List<Either<String,EntityProviders>>
    The relevant entity providers that are synced
    settingsName String
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    entityProviders (string | EntityProviders)[]
    The relevant entity providers that are synced
    settingsName string
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    entity_providers Sequence[Union[str, EntityProviders]]
    The relevant entity providers that are synced
    settings_name str
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    entityProviders List<String | "ActiveDirectory" | "AzureActiveDirectory">
    The relevant entity providers that are synced
    settingsName String
    The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.SecurityInsights.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Etag string
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag string
    Etag of the azure resource
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    Etag of the azure resource
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag String
    Etag of the azure resource

    Supporting Types

    EntityProviders, EntityProvidersArgs

    ActiveDirectory
    ActiveDirectory
    AzureActiveDirectory
    AzureActiveDirectory
    EntityProvidersActiveDirectory
    ActiveDirectory
    EntityProvidersAzureActiveDirectory
    AzureActiveDirectory
    ActiveDirectory
    ActiveDirectory
    AzureActiveDirectory
    AzureActiveDirectory
    ActiveDirectory
    ActiveDirectory
    AzureActiveDirectory
    AzureActiveDirectory
    ACTIVE_DIRECTORY
    ActiveDirectory
    AZURE_ACTIVE_DIRECTORY
    AzureActiveDirectory
    "ActiveDirectory"
    ActiveDirectory
    "AzureActiveDirectory"
    AzureActiveDirectory

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:securityinsights:EntityAnalytics EyesOn /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi