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.

securitycenter¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.securitycenter.AdvancedThreatProtection(resource_name, opts=None, enabled=None, target_resource_id=None, __props__=None, __name__=None, __opts__=None)¶

Manages a resources Advanced Threat Protection setting.

import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="northeurope")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=azurerm_resource_group["example"]["name"],
    location=azurerm_resource_group["example"]["location"],
    account_tier="Standard",
    account_replication_type="LRS",
    tags={
        "environment": "example",
    })
example_advanced_threat_protection = azure.securitycenter.AdvancedThreatProtection("exampleAdvancedThreatProtection",
    target_resource_id=example_account.id,
    enabled=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
enabled (pulumi.Input[bool]) – Should Advanced Threat Protection be enabled on this resource?
target_resource_id (pulumi.Input[str]) – The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

enabled: pulumi.Output[bool] = None¶: Should Advanced Threat Protection be enabled on this resource?

target_resource_id: pulumi.Output[str] = None¶: The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, enabled=None, target_resource_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
enabled (pulumi.Input[bool]) – Should Advanced Threat Protection be enabled on this resource?
target_resource_id (pulumi.Input[str]) – The ID of the Azure Resource which to enable Advanced Threat Protection on. Changing this forces a new resource to be created.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.securitycenter.Contact(resource_name, opts=None, alert_notifications=None, alerts_to_admins=None, email=None, phone=None, __props__=None, __name__=None, __opts__=None)¶

Manages the subscription’s Security Center Contact.

NOTE: Owner access permission is required.

import pulumi
import pulumi_azure as azure

example = azure.securitycenter.Contact("example",
    alert_notifications=True,
    alerts_to_admins=True,
    email="contact@example.com",
    phone="+1-555-555-5555")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
alert_notifications (pulumi.Input[bool]) – Whether to send security alerts notifications to the security contact.
alerts_to_admins (pulumi.Input[bool]) – Whether to send security alerts notifications to subscription admins.
email (pulumi.Input[str]) – The email of the Security Center Contact.
phone (pulumi.Input[str]) – The phone number of the Security Center Contact.

alert_notifications: pulumi.Output[bool] = None¶: Whether to send security alerts notifications to the security contact.

alerts_to_admins: pulumi.Output[bool] = None¶: Whether to send security alerts notifications to subscription admins.

email: pulumi.Output[str] = None¶: The email of the Security Center Contact.

phone: pulumi.Output[str] = None¶: The phone number of the Security Center Contact.

static get(resource_name, id, opts=None, alert_notifications=None, alerts_to_admins=None, email=None, phone=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
alert_notifications (pulumi.Input[bool]) – Whether to send security alerts notifications to the security contact.
alerts_to_admins (pulumi.Input[bool]) – Whether to send security alerts notifications to subscription admins.
email (pulumi.Input[str]) – The email of the Security Center Contact.
phone (pulumi.Input[str]) – The phone number of the Security Center Contact.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.securitycenter.SubscriptionPricing(resource_name, opts=None, tier=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.securitycenter.SubscriptionPricing("example", tier="Standard")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
tier (pulumi.Input[str]) – The pricing tier to use. Possible values are Free and Standard.

tier: pulumi.Output[str] = None¶: The pricing tier to use. Possible values are Free and Standard.

static get(resource_name, id, opts=None, tier=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
tier (pulumi.Input[str]) – The pricing tier to use. Possible values are Free and Standard.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_azure.securitycenter.Workspace(resource_name, opts=None, scope=None, workspace_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="PerGB2018")
example_workspace = azure.securitycenter.Workspace("exampleWorkspace",
    scope="/subscriptions/00000000-0000-0000-0000-000000000000",
    workspace_id=example_analytics_workspace.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
scope (pulumi.Input[str]) – The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
workspace_id (pulumi.Input[str]) – The ID of the Log Analytics Workspace to save the data in.

scope: pulumi.Output[str] = None¶: The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.

workspace_id: pulumi.Output[str] = None¶: The ID of the Log Analytics Workspace to save the data in.

static get(resource_name, id, opts=None, scope=None, workspace_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
scope (pulumi.Input[str]) – The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.
workspace_id (pulumi.Input[str]) – The ID of the Log Analytics Workspace to save the data in.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

securitycenter¶

On This Page