1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. securitycenter

Module securitycenter

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource AdvancedThreatProtection

class AdvancedThreatProtection extends CustomResource

Manages a resources Advanced Threat Protection setting.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const rg = new azure.core.ResourceGroup("rg", {location: "northeurope"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: azurerm_resource_group.example.name,
    location: azurerm_resource_group.example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    tags: {
        environment: "example",
    },
});
const exampleAdvancedThreatProtection = new azure.securitycenter.AdvancedThreatProtection("exampleAdvancedThreatProtection", {
    targetResourceId: exampleAccount.id,
    enabled: true,
});

constructor

new AdvancedThreatProtection(name: string, args: AdvancedThreatProtectionArgs, opts?: pulumi.CustomResourceOptions)

Create a AdvancedThreatProtection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AdvancedThreatProtectionState, opts?: pulumi.CustomResourceOptions): AdvancedThreatProtection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AdvancedThreatProtection

Returns true if the given object is an instance of AdvancedThreatProtection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

Should Advanced Threat Protection be enabled on this resource?

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property targetResourceId

public targetResourceId: pulumi.Output<string>;

The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Contact

class Contact extends CustomResource

Manages the subscription’s Security Center Contact.

NOTE: Owner access permission is required.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.securitycenter.Contact("example", {
    alertNotifications: true,
    alertsToAdmins: true,
    email: "contact@example.com",
    phone: "+1-555-555-5555",
});

constructor

new Contact(name: string, args: ContactArgs, opts?: pulumi.CustomResourceOptions)

Create a Contact resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ContactState, opts?: pulumi.CustomResourceOptions): Contact

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Contact

Returns true if the given object is an instance of Contact. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property alertNotifications

public alertNotifications: pulumi.Output<boolean>;

Whether to send security alerts notifications to the security contact.

property alertsToAdmins

public alertsToAdmins: pulumi.Output<boolean>;

Whether to send security alerts notifications to subscription admins.

property email

public email: pulumi.Output<string>;

The email of the Security Center Contact.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property phone

public phone: pulumi.Output<string | undefined>;

The phone number of the Security Center Contact.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SubscriptionPricing

class SubscriptionPricing extends CustomResource

Manages the Pricing Tier for Azure Security Center in the current subscription.

NOTE: This resource requires the Owner permission on the Subscription.

NOTE: Deletion of this resource does not change or reset the pricing tier to Free

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.securitycenter.SubscriptionPricing("example", {
    tier: "Standard",
});

constructor

new SubscriptionPricing(name: string, args: SubscriptionPricingArgs, opts?: pulumi.CustomResourceOptions)

Create a SubscriptionPricing resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubscriptionPricingState, opts?: pulumi.CustomResourceOptions): SubscriptionPricing

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubscriptionPricing

Returns true if the given object is an instance of SubscriptionPricing. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property tier

public tier: pulumi.Output<string>;

The pricing tier to use. Possible values are Free and Standard.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Workspace

class Workspace extends CustomResource

Manages the subscription’s Security Center Workspace.

NOTE: Owner access permission is required.

NOTE: The subscription’s pricing model can not be Free for this to have any affect.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "westus"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "PerGB2018",
});
const exampleWorkspace = new azure.securitycenter.Workspace("exampleWorkspace", {
    scope: "/subscriptions/00000000-0000-0000-0000-000000000000",
    workspaceId: exampleAnalyticsWorkspace.id,
});

constructor

new Workspace(name: string, args: WorkspaceArgs, opts?: pulumi.CustomResourceOptions)

Create a Workspace resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkspaceState, opts?: pulumi.CustomResourceOptions): Workspace

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Workspace

Returns true if the given object is an instance of Workspace. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property scope

public scope: pulumi.Output<string>;

The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workspaceId

public workspaceId: pulumi.Output<string>;

The ID of the Log Analytics Workspace to save the data in.

Others

interface AdvancedThreatProtectionArgs

interface AdvancedThreatProtectionArgs

The set of arguments for constructing a AdvancedThreatProtection resource.

property enabled

enabled: pulumi.Input<boolean>;

Should Advanced Threat Protection be enabled on this resource?

property targetResourceId

targetResourceId: pulumi.Input<string>;

The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

interface AdvancedThreatProtectionState

interface AdvancedThreatProtectionState

Input properties used for looking up and filtering AdvancedThreatProtection resources.

property enabled

enabled?: pulumi.Input<boolean>;

Should Advanced Threat Protection be enabled on this resource?

property targetResourceId

targetResourceId?: pulumi.Input<string>;

The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

interface ContactArgs

interface ContactArgs

The set of arguments for constructing a Contact resource.

property alertNotifications

alertNotifications: pulumi.Input<boolean>;

Whether to send security alerts notifications to the security contact.

property alertsToAdmins

alertsToAdmins: pulumi.Input<boolean>;

Whether to send security alerts notifications to subscription admins.

property email

email: pulumi.Input<string>;

The email of the Security Center Contact.

property phone

phone?: pulumi.Input<string>;

The phone number of the Security Center Contact.

interface ContactState

interface ContactState

Input properties used for looking up and filtering Contact resources.

property alertNotifications

alertNotifications?: pulumi.Input<boolean>;

Whether to send security alerts notifications to the security contact.

property alertsToAdmins

alertsToAdmins?: pulumi.Input<boolean>;

Whether to send security alerts notifications to subscription admins.

property email

email?: pulumi.Input<string>;

The email of the Security Center Contact.

property phone

phone?: pulumi.Input<string>;

The phone number of the Security Center Contact.

interface SubscriptionPricingArgs

interface SubscriptionPricingArgs

The set of arguments for constructing a SubscriptionPricing resource.

property tier

tier: pulumi.Input<string>;

The pricing tier to use. Possible values are Free and Standard.

interface SubscriptionPricingState

interface SubscriptionPricingState

Input properties used for looking up and filtering SubscriptionPricing resources.

property tier

tier?: pulumi.Input<string>;

The pricing tier to use. Possible values are Free and Standard.

interface WorkspaceArgs

interface WorkspaceArgs

The set of arguments for constructing a Workspace resource.

property scope

scope: pulumi.Input<string>;

The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.

property workspaceId

workspaceId: pulumi.Input<string>;

The ID of the Log Analytics Workspace to save the data in.

interface WorkspaceState

interface WorkspaceState

Input properties used for looking up and filtering Workspace resources.

property scope

scope?: pulumi.Input<string>;

The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.

property workspaceId

workspaceId?: pulumi.Input<string>;

The ID of the Log Analytics Workspace to save the data in.