1. Docs
  2. Reference
  3. API
  4. pulumi_azure
  5. storage

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.

storage

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.storage.Account(resource_name, opts=None, access_tier=None, account_kind=None, account_replication_type=None, account_tier=None, blob_properties=None, custom_domain=None, enable_https_traffic_only=None, identity=None, is_hns_enabled=None, location=None, name=None, network_rules=None, queue_properties=None, resource_group_name=None, static_website=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Storage Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="GRS",
    tags={
        "environment": "staging",
    })

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24",
    service_endpoints=[
        "Microsoft.Sql",
        "Microsoft.Storage",
    ])
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    network_rules={
        "default_action": "Deny",
        "ip_rules": ["100.0.0.1"],
        "virtual_network_subnet_ids": [example_subnet.id],
    },
    tags={
        "environment": "staging",
    })
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_tier (pulumi.Input[str]) – Defines the access tier for BlobStorage, FileStorage and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.

  • account_kind (pulumi.Input[str]) – Defines the Kind of account. Valid options are BlobStorage, BlockBlobStorage, FileStorage, Storage and StorageV2. Changing this forces a new resource to be created. Defaults to StorageV2.

  • account_replication_type (pulumi.Input[str]) – Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS, ZRS, GZRS and RAGZRS.

  • account_tier (pulumi.Input[str]) – Defines the Tier to use for this storage account. Valid options are Standard and Premium. For BlockBlobStorage and FileStorage accounts only Premium is valid. Changing this forces a new resource to be created.

  • blob_properties (pulumi.Input[dict]) – A blob_properties block as defined below.

  • custom_domain (pulumi.Input[dict]) – A custom_domain block as documented below.

  • enable_https_traffic_only (pulumi.Input[bool]) – Boolean flag which forces HTTPS if enabled, see here for more information. Defaults to true.

  • identity (pulumi.Input[dict]) – A identity block as defined below.

  • is_hns_enabled (pulumi.Input[bool]) – Is Hierarchical Namespace enabled? This can be used with Azure Data Lake Storage Gen 2 (see here for more information). Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

  • network_rules (pulumi.Input[dict]) – A network_rules block as documented below.

  • queue_properties (pulumi.Input[dict]) – A queue_properties block as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

  • static_website (pulumi.Input[dict]) – A static_website block as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The blob_properties object supports the following:

  • corsRules (pulumi.Input[list]) - A cors_rule block as defined below.

    • allowedHeaders (pulumi.Input[list]) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (pulumi.Input[list]) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (pulumi.Input[list]) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (pulumi.Input[list]) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (pulumi.Input[float]) - The number of seconds the client should cache a preflight response.

  • deleteRetentionPolicy (pulumi.Input[dict]) - A delete_retention_policy block as defined below.

    • days (pulumi.Input[float]) - Specifies the number of days that the blob should be retained, between 1 and 365 days. Defaults to 7.

The custom_domain object supports the following:

  • name (pulumi.Input[str]) - The Custom Domain Name to use for the Storage Account, which will be validated by Azure.

  • useSubdomain (pulumi.Input[bool]) - Should the Custom Domain Name be validated by using indirect CNAME validation?

The identity object supports the following:

  • principal_id (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Identity of this Storage Account.

  • tenant_id (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Identity of this Storage Account.

  • type (pulumi.Input[str]) - Specifies the identity type of the Storage Account. At this time the only allowed value is SystemAssigned.

The network_rules object supports the following:

  • bypasses (pulumi.Input[list]) - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

  • default_action (pulumi.Input[str]) - Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

  • ip_rules (pulumi.Input[list]) - List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

  • virtual_network_subnet_ids (pulumi.Input[list]) - A list of resource ids for subnets.

The queue_properties object supports the following:

  • corsRules (pulumi.Input[list]) - A cors_rule block as defined above.

    • allowedHeaders (pulumi.Input[list]) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (pulumi.Input[list]) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (pulumi.Input[list]) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (pulumi.Input[list]) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (pulumi.Input[float]) - The number of seconds the client should cache a preflight response.

  • hourMetrics (pulumi.Input[dict]) - A hour_metrics block as defined below.

    • enabled (pulumi.Input[bool]) - Indicates whether hour metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (pulumi.Input[bool]) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

  • logging (pulumi.Input[dict]) - A logging block as defined below.

    • delete (pulumi.Input[bool]) - Indicates whether all delete requests should be logged. Changing this forces a new resource.

    • read (pulumi.Input[bool]) - Indicates whether all read requests should be logged. Changing this forces a new resource.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

    • write (pulumi.Input[bool]) - Indicates whether all write requests should be logged. Changing this forces a new resource.

  • minuteMetrics (pulumi.Input[dict]) - A minute_metrics block as defined below.

    • enabled (pulumi.Input[bool]) - Indicates whether minute metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (pulumi.Input[bool]) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

The static_website object supports the following:

  • error404Document (pulumi.Input[str]) - The absolute path to a custom webpage that should be used when a request is made which does not correspond to an existing file.

  • indexDocument (pulumi.Input[str]) - The webpage that Azure Storage serves for requests to the root of a website or any subfolder. For example, index.html. The value is case-sensitive.

access_tier: pulumi.Output[str] = None

Defines the access tier for BlobStorage, FileStorage and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.

account_kind: pulumi.Output[str] = None

Defines the Kind of account. Valid options are BlobStorage, BlockBlobStorage, FileStorage, Storage and StorageV2. Changing this forces a new resource to be created. Defaults to StorageV2.

account_replication_type: pulumi.Output[str] = None

Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS, ZRS, GZRS and RAGZRS.

account_tier: pulumi.Output[str] = None

Defines the Tier to use for this storage account. Valid options are Standard and Premium. For BlockBlobStorage and FileStorage accounts only Premium is valid. Changing this forces a new resource to be created.

blob_properties: pulumi.Output[dict] = None

A blob_properties block as defined below.

  • corsRules (list) - A cors_rule block as defined below.

    • allowedHeaders (list) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (list) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (list) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (list) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (float) - The number of seconds the client should cache a preflight response.

  • deleteRetentionPolicy (dict) - A delete_retention_policy block as defined below.

    • days (float) - Specifies the number of days that the blob should be retained, between 1 and 365 days. Defaults to 7.

custom_domain: pulumi.Output[dict] = None

A custom_domain block as documented below.

  • name (str) - The Custom Domain Name to use for the Storage Account, which will be validated by Azure.

  • useSubdomain (bool) - Should the Custom Domain Name be validated by using indirect CNAME validation?

enable_https_traffic_only: pulumi.Output[bool] = None

Boolean flag which forces HTTPS if enabled, see here for more information. Defaults to true.

identity: pulumi.Output[dict] = None

A identity block as defined below.

  • principal_id (str) - The Principal ID for the Service Principal associated with the Identity of this Storage Account.

  • tenant_id (str) - The Tenant ID for the Service Principal associated with the Identity of this Storage Account.

  • type (str) - Specifies the identity type of the Storage Account. At this time the only allowed value is SystemAssigned.

is_hns_enabled: pulumi.Output[bool] = None

Is Hierarchical Namespace enabled? This can be used with Azure Data Lake Storage Gen 2 (see here for more information). Changing this forces a new resource to be created.

location: pulumi.Output[str] = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None

Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

network_rules: pulumi.Output[dict] = None

A network_rules block as documented below.

  • bypasses (list) - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

  • default_action (str) - Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

  • ip_rules (list) - List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

  • virtual_network_subnet_ids (list) - A list of resource ids for subnets.

primary_access_key: pulumi.Output[str] = None

The primary access key for the storage account.

primary_blob_connection_string: pulumi.Output[str] = None

The connection string associated with the primary blob location.

primary_blob_endpoint: pulumi.Output[str] = None

The endpoint URL for blob storage in the primary location.

primary_blob_host: pulumi.Output[str] = None

The hostname with port if applicable for blob storage in the primary location.

primary_connection_string: pulumi.Output[str] = None

The connection string associated with the primary location.

primary_dfs_endpoint: pulumi.Output[str] = None

The endpoint URL for DFS storage in the primary location.

primary_dfs_host: pulumi.Output[str] = None

The hostname with port if applicable for DFS storage in the primary location.

primary_file_endpoint: pulumi.Output[str] = None

The endpoint URL for file storage in the primary location.

primary_file_host: pulumi.Output[str] = None

The hostname with port if applicable for file storage in the primary location.

primary_location: pulumi.Output[str] = None

The primary location of the storage account.

primary_queue_endpoint: pulumi.Output[str] = None

The endpoint URL for queue storage in the primary location.

primary_queue_host: pulumi.Output[str] = None

The hostname with port if applicable for queue storage in the primary location.

primary_table_endpoint: pulumi.Output[str] = None

The endpoint URL for table storage in the primary location.

primary_table_host: pulumi.Output[str] = None

The hostname with port if applicable for table storage in the primary location.

primary_web_endpoint: pulumi.Output[str] = None

The endpoint URL for web storage in the primary location.

primary_web_host: pulumi.Output[str] = None

The hostname with port if applicable for web storage in the primary location.

queue_properties: pulumi.Output[dict] = None

A queue_properties block as defined below.

  • corsRules (list) - A cors_rule block as defined above.

    • allowedHeaders (list) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (list) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (list) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (list) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (float) - The number of seconds the client should cache a preflight response.

  • hourMetrics (dict) - A hour_metrics block as defined below.

    • enabled (bool) - Indicates whether hour metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (bool) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (float) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (str) - The version of storage analytics to configure. Changing this forces a new resource.

  • logging (dict) - A logging block as defined below.

    • delete (bool) - Indicates whether all delete requests should be logged. Changing this forces a new resource.

    • read (bool) - Indicates whether all read requests should be logged. Changing this forces a new resource.

    • retentionPolicyDays (float) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (str) - The version of storage analytics to configure. Changing this forces a new resource.

    • write (bool) - Indicates whether all write requests should be logged. Changing this forces a new resource.

  • minuteMetrics (dict) - A minute_metrics block as defined below.

    • enabled (bool) - Indicates whether minute metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (bool) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (float) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (str) - The version of storage analytics to configure. Changing this forces a new resource.

resource_group_name: pulumi.Output[str] = None

The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

secondary_access_key: pulumi.Output[str] = None

The secondary access key for the storage account.

secondary_blob_connection_string: pulumi.Output[str] = None

The connection string associated with the secondary blob location.

secondary_blob_endpoint: pulumi.Output[str] = None

The endpoint URL for blob storage in the secondary location.

secondary_blob_host: pulumi.Output[str] = None

The hostname with port if applicable for blob storage in the secondary location.

secondary_connection_string: pulumi.Output[str] = None

The connection string associated with the secondary location.

secondary_dfs_endpoint: pulumi.Output[str] = None

The endpoint URL for DFS storage in the secondary location.

secondary_dfs_host: pulumi.Output[str] = None

The hostname with port if applicable for DFS storage in the secondary location.

secondary_file_endpoint: pulumi.Output[str] = None

The endpoint URL for file storage in the secondary location.

secondary_file_host: pulumi.Output[str] = None

The hostname with port if applicable for file storage in the secondary location.

secondary_location: pulumi.Output[str] = None

The secondary location of the storage account.

secondary_queue_endpoint: pulumi.Output[str] = None

The endpoint URL for queue storage in the secondary location.

secondary_queue_host: pulumi.Output[str] = None

The hostname with port if applicable for queue storage in the secondary location.

secondary_table_endpoint: pulumi.Output[str] = None

The endpoint URL for table storage in the secondary location.

secondary_table_host: pulumi.Output[str] = None

The hostname with port if applicable for table storage in the secondary location.

secondary_web_endpoint: pulumi.Output[str] = None

The endpoint URL for web storage in the secondary location.

secondary_web_host: pulumi.Output[str] = None

The hostname with port if applicable for web storage in the secondary location.

static_website: pulumi.Output[dict] = None

A static_website block as defined below.

  • error404Document (str) - The absolute path to a custom webpage that should be used when a request is made which does not correspond to an existing file.

  • indexDocument (str) - The webpage that Azure Storage serves for requests to the root of a website or any subfolder. For example, index.html. The value is case-sensitive.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, access_tier=None, account_kind=None, account_replication_type=None, account_tier=None, blob_properties=None, custom_domain=None, enable_https_traffic_only=None, identity=None, is_hns_enabled=None, location=None, name=None, network_rules=None, primary_access_key=None, primary_blob_connection_string=None, primary_blob_endpoint=None, primary_blob_host=None, primary_connection_string=None, primary_dfs_endpoint=None, primary_dfs_host=None, primary_file_endpoint=None, primary_file_host=None, primary_location=None, primary_queue_endpoint=None, primary_queue_host=None, primary_table_endpoint=None, primary_table_host=None, primary_web_endpoint=None, primary_web_host=None, queue_properties=None, resource_group_name=None, secondary_access_key=None, secondary_blob_connection_string=None, secondary_blob_endpoint=None, secondary_blob_host=None, secondary_connection_string=None, secondary_dfs_endpoint=None, secondary_dfs_host=None, secondary_file_endpoint=None, secondary_file_host=None, secondary_location=None, secondary_queue_endpoint=None, secondary_queue_host=None, secondary_table_endpoint=None, secondary_table_host=None, secondary_web_endpoint=None, secondary_web_host=None, static_website=None, tags=None)

Get an existing Account 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.

  • access_tier (pulumi.Input[str]) – Defines the access tier for BlobStorage, FileStorage and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.

  • account_kind (pulumi.Input[str]) – Defines the Kind of account. Valid options are BlobStorage, BlockBlobStorage, FileStorage, Storage and StorageV2. Changing this forces a new resource to be created. Defaults to StorageV2.

  • account_replication_type (pulumi.Input[str]) – Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS, ZRS, GZRS and RAGZRS.

  • account_tier (pulumi.Input[str]) – Defines the Tier to use for this storage account. Valid options are Standard and Premium. For BlockBlobStorage and FileStorage accounts only Premium is valid. Changing this forces a new resource to be created.

  • blob_properties (pulumi.Input[dict]) – A blob_properties block as defined below.

  • custom_domain (pulumi.Input[dict]) – A custom_domain block as documented below.

  • enable_https_traffic_only (pulumi.Input[bool]) –

    Boolean flag which forces HTTPS if enabled, see here for more information. Defaults to true.

  • identity (pulumi.Input[dict]) – A identity block as defined below.

  • is_hns_enabled (pulumi.Input[bool]) –

    Is Hierarchical Namespace enabled? This can be used with Azure Data Lake Storage Gen 2 (see here for more information). Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

  • network_rules (pulumi.Input[dict]) – A network_rules block as documented below.

  • primary_access_key (pulumi.Input[str]) – The primary access key for the storage account.

  • primary_blob_connection_string (pulumi.Input[str]) – The connection string associated with the primary blob location.

  • primary_blob_endpoint (pulumi.Input[str]) – The endpoint URL for blob storage in the primary location.

  • primary_blob_host (pulumi.Input[str]) – The hostname with port if applicable for blob storage in the primary location.

  • primary_connection_string (pulumi.Input[str]) – The connection string associated with the primary location.

  • primary_dfs_endpoint (pulumi.Input[str]) – The endpoint URL for DFS storage in the primary location.

  • primary_dfs_host (pulumi.Input[str]) – The hostname with port if applicable for DFS storage in the primary location.

  • primary_file_endpoint (pulumi.Input[str]) – The endpoint URL for file storage in the primary location.

  • primary_file_host (pulumi.Input[str]) – The hostname with port if applicable for file storage in the primary location.

  • primary_location (pulumi.Input[str]) – The primary location of the storage account.

  • primary_queue_endpoint (pulumi.Input[str]) – The endpoint URL for queue storage in the primary location.

  • primary_queue_host (pulumi.Input[str]) – The hostname with port if applicable for queue storage in the primary location.

  • primary_table_endpoint (pulumi.Input[str]) – The endpoint URL for table storage in the primary location.

  • primary_table_host (pulumi.Input[str]) – The hostname with port if applicable for table storage in the primary location.

  • primary_web_endpoint (pulumi.Input[str]) – The endpoint URL for web storage in the primary location.

  • primary_web_host (pulumi.Input[str]) – The hostname with port if applicable for web storage in the primary location.

  • queue_properties (pulumi.Input[dict]) – A queue_properties block as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

  • secondary_access_key (pulumi.Input[str]) – The secondary access key for the storage account.

  • secondary_blob_connection_string (pulumi.Input[str]) – The connection string associated with the secondary blob location.

  • secondary_blob_endpoint (pulumi.Input[str]) – The endpoint URL for blob storage in the secondary location.

  • secondary_blob_host (pulumi.Input[str]) – The hostname with port if applicable for blob storage in the secondary location.

  • secondary_connection_string (pulumi.Input[str]) – The connection string associated with the secondary location.

  • secondary_dfs_endpoint (pulumi.Input[str]) – The endpoint URL for DFS storage in the secondary location.

  • secondary_dfs_host (pulumi.Input[str]) – The hostname with port if applicable for DFS storage in the secondary location.

  • secondary_file_endpoint (pulumi.Input[str]) – The endpoint URL for file storage in the secondary location.

  • secondary_file_host (pulumi.Input[str]) – The hostname with port if applicable for file storage in the secondary location.

  • secondary_location (pulumi.Input[str]) – The secondary location of the storage account.

  • secondary_queue_endpoint (pulumi.Input[str]) – The endpoint URL for queue storage in the secondary location.

  • secondary_queue_host (pulumi.Input[str]) – The hostname with port if applicable for queue storage in the secondary location.

  • secondary_table_endpoint (pulumi.Input[str]) – The endpoint URL for table storage in the secondary location.

  • secondary_table_host (pulumi.Input[str]) – The hostname with port if applicable for table storage in the secondary location.

  • secondary_web_endpoint (pulumi.Input[str]) – The endpoint URL for web storage in the secondary location.

  • secondary_web_host (pulumi.Input[str]) – The hostname with port if applicable for web storage in the secondary location.

  • static_website (pulumi.Input[dict]) – A static_website block as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The blob_properties object supports the following:

  • corsRules (pulumi.Input[list]) - A cors_rule block as defined below.

    • allowedHeaders (pulumi.Input[list]) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (pulumi.Input[list]) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (pulumi.Input[list]) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (pulumi.Input[list]) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (pulumi.Input[float]) - The number of seconds the client should cache a preflight response.

  • deleteRetentionPolicy (pulumi.Input[dict]) - A delete_retention_policy block as defined below.

    • days (pulumi.Input[float]) - Specifies the number of days that the blob should be retained, between 1 and 365 days. Defaults to 7.

The custom_domain object supports the following:

  • name (pulumi.Input[str]) - The Custom Domain Name to use for the Storage Account, which will be validated by Azure.

  • useSubdomain (pulumi.Input[bool]) - Should the Custom Domain Name be validated by using indirect CNAME validation?

The identity object supports the following:

  • principal_id (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Identity of this Storage Account.

  • tenant_id (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Identity of this Storage Account.

  • type (pulumi.Input[str]) - Specifies the identity type of the Storage Account. At this time the only allowed value is SystemAssigned.

The network_rules object supports the following:

  • bypasses (pulumi.Input[list]) - Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

  • default_action (pulumi.Input[str]) - Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

  • ip_rules (pulumi.Input[list]) - List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

  • virtual_network_subnet_ids (pulumi.Input[list]) - A list of resource ids for subnets.

The queue_properties object supports the following:

  • corsRules (pulumi.Input[list]) - A cors_rule block as defined above.

    • allowedHeaders (pulumi.Input[list]) - A list of headers that are allowed to be a part of the cross-origin request.

    • allowedMethods (pulumi.Input[list]) - A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

    • allowedOrigins (pulumi.Input[list]) - A list of origin domains that will be allowed by CORS.

    • exposedHeaders (pulumi.Input[list]) - A list of response headers that are exposed to CORS clients.

    • maxAgeInSeconds (pulumi.Input[float]) - The number of seconds the client should cache a preflight response.

  • hourMetrics (pulumi.Input[dict]) - A hour_metrics block as defined below.

    • enabled (pulumi.Input[bool]) - Indicates whether hour metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (pulumi.Input[bool]) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

  • logging (pulumi.Input[dict]) - A logging block as defined below.

    • delete (pulumi.Input[bool]) - Indicates whether all delete requests should be logged. Changing this forces a new resource.

    • read (pulumi.Input[bool]) - Indicates whether all read requests should be logged. Changing this forces a new resource.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

    • write (pulumi.Input[bool]) - Indicates whether all write requests should be logged. Changing this forces a new resource.

  • minuteMetrics (pulumi.Input[dict]) - A minute_metrics block as defined below.

    • enabled (pulumi.Input[bool]) - Indicates whether minute metrics are enabled for the Queue service. Changing this forces a new resource.

    • includeApis (pulumi.Input[bool]) - Indicates whether metrics should generate summary statistics for called API operations.

    • retentionPolicyDays (pulumi.Input[float]) - Specifies the number of days that logs will be retained. Changing this forces a new resource.

    • version (pulumi.Input[str]) - The version of storage analytics to configure. Changing this forces a new resource.

The static_website object supports the following:

  • error404Document (pulumi.Input[str]) - The absolute path to a custom webpage that should be used when a request is made which does not correspond to an existing file.

  • indexDocument (pulumi.Input[str]) - The webpage that Azure Storage serves for requests to the root of a website or any subfolder. For example, index.html. The value is case-sensitive.

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.storage.AccountNetworkRules(resource_name, opts=None, bypasses=None, default_action=None, ip_rules=None, resource_group_name=None, storage_account_name=None, virtual_network_subnet_ids=None, __props__=None, __name__=None, __opts__=None)

Manages network rules inside of a Azure Storage Account.

NOTE: Network Rules can be defined either directly on the storage.Account resource, or using the storage.AccountNetworkRules resource - but the two cannot be used together. Spurious changes will occur if both are used against the same Storage Account.

NOTE: Only one storage.AccountNetworkRules can be tied to an storage.Account. Spurious changes will occur if more than storage.AccountNetworkRules is tied to the same storage.Account.

NOTE: Deleting this resource updates the storage account back to the default values it had when the storage account was created.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    address_spaces=["10.0.0.0/16"],
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="10.0.2.0/24",
    service_endpoints=["Microsoft.Storage"])
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="GRS",
    tags={
        "environment": "staging",
    })
test = azure.storage.AccountNetworkRules("test",
    resource_group_name=azurerm_resource_group["test"]["name"],
    storage_account_name=azurerm_storage_account["test"]["name"],
    default_action="Allow",
    ip_rules=["127.0.0.1"],
    virtual_network_subnet_ids=[azurerm_subnet["test"]["id"]],
    bypasses=["Metrics"])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bypasses (pulumi.Input[list]) – Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

  • default_action (pulumi.Input[str]) – Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

  • ip_rules (pulumi.Input[list]) –

    List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

  • storage_account_name (pulumi.Input[str]) – Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

  • virtual_network_subnet_ids (pulumi.Input[list]) – A list of virtual network subnet ids to to secure the storage account.

bypasses: pulumi.Output[list] = None

Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

default_action: pulumi.Output[str] = None

Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

ip_rules: pulumi.Output[list] = None

List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

resource_group_name: pulumi.Output[str] = None

The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

storage_account_name: pulumi.Output[str] = None

Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

virtual_network_subnet_ids: pulumi.Output[list] = None

A list of virtual network subnet ids to to secure the storage account.

static get(resource_name, id, opts=None, bypasses=None, default_action=None, ip_rules=None, resource_group_name=None, storage_account_name=None, virtual_network_subnet_ids=None)

Get an existing AccountNetworkRules 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.

  • bypasses (pulumi.Input[list]) – Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

  • default_action (pulumi.Input[str]) – Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

  • ip_rules (pulumi.Input[list]) –

    List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.

  • storage_account_name (pulumi.Input[str]) – Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.

  • virtual_network_subnet_ids (pulumi.Input[list]) – A list of virtual network subnet ids to to secure the storage account.

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.storage.AwaitableGetAccountBlobContainerSASResult(cache_control=None, connection_string=None, container_name=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, expiry=None, https_only=None, id=None, ip_address=None, permissions=None, sas=None, start=None)
class pulumi_azure.storage.AwaitableGetAccountResult(access_tier=None, account_kind=None, account_replication_type=None, account_tier=None, custom_domains=None, enable_https_traffic_only=None, id=None, is_hns_enabled=None, location=None, name=None, primary_access_key=None, primary_blob_connection_string=None, primary_blob_endpoint=None, primary_blob_host=None, primary_connection_string=None, primary_dfs_endpoint=None, primary_dfs_host=None, primary_file_endpoint=None, primary_file_host=None, primary_location=None, primary_queue_endpoint=None, primary_queue_host=None, primary_table_endpoint=None, primary_table_host=None, primary_web_endpoint=None, primary_web_host=None, resource_group_name=None, secondary_access_key=None, secondary_blob_connection_string=None, secondary_blob_endpoint=None, secondary_blob_host=None, secondary_connection_string=None, secondary_dfs_endpoint=None, secondary_dfs_host=None, secondary_file_endpoint=None, secondary_file_host=None, secondary_location=None, secondary_queue_endpoint=None, secondary_queue_host=None, secondary_table_endpoint=None, secondary_table_host=None, secondary_web_endpoint=None, secondary_web_host=None, tags=None)
class pulumi_azure.storage.AwaitableGetAccountSASResult(connection_string=None, expiry=None, https_only=None, id=None, permissions=None, resource_types=None, sas=None, services=None, start=None)
class pulumi_azure.storage.AwaitableGetPolicyResult(id=None, rules=None, storage_account_id=None)
class pulumi_azure.storage.AwaitableGetStorageContainerResult(container_access_type=None, has_immutability_policy=None, has_legal_hold=None, id=None, metadata=None, name=None, resource_manager_id=None, storage_account_name=None)
class pulumi_azure.storage.Blob(resource_name, opts=None, access_tier=None, content_type=None, metadata=None, name=None, parallelism=None, size=None, source=None, source_content=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, __props__=None, __name__=None, __opts__=None)

Manages a Blob within a Storage Container.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_account.name,
    container_access_type="private")
example_blob = azure.storage.Blob("exampleBlob",
    storage_account_name=example_account.name,
    storage_container_name=example_container.name,
    type="Block",
    source=pulumi.FileAsset("some-local-file.zip"))
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_tier (pulumi.Input[str]) – The access tier of the storage blob. Possible values are Archive, Cool and Hot.

  • content_type (pulumi.Input[str]) – The content type of the storage blob. Cannot be defined if source_uri is defined. Defaults to application/octet-stream.

  • metadata (pulumi.Input[dict]) – A map of custom blob metadata.

  • name (pulumi.Input[str]) – The name of the storage blob. Must be unique within the storage container the blob is located.

  • parallelism (pulumi.Input[float]) – The number of workers per CPU core to run for concurrent uploads. Defaults to 8.

  • size (pulumi.Input[float]) – Used only for page blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to 0.

  • pulumi.Archive]] source (pulumi.Input[Union[pulumi.Asset,) – An absolute path to a file on the local system. This field cannot be specified for Append blobs and cannot be specified if source_content or source_uri is specified.

  • source_content (pulumi.Input[str]) – The content for this blob which should be defined inline. This field can only be specified for Block blobs and cannot be specified if source or source_uri is specified.

  • source_uri (pulumi.Input[str]) – The URI of an existing blob, or a file in the Azure File service, to use as the source contents for the blob to be created. Changing this forces a new resource to be created. This field cannot be specified for Append blobs and cannot be specified if source or source_content is specified.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage container. Changing this forces a new resource to be created.

  • storage_container_name (pulumi.Input[str]) – The name of the storage container in which this blob should be created.

  • type (pulumi.Input[str]) – The type of the storage blob to be created. Possible values are Append, Block or Page. Changing this forces a new resource to be created.

access_tier: pulumi.Output[str] = None

The access tier of the storage blob. Possible values are Archive, Cool and Hot.

content_type: pulumi.Output[str] = None

The content type of the storage blob. Cannot be defined if source_uri is defined. Defaults to application/octet-stream.

metadata: pulumi.Output[dict] = None

A map of custom blob metadata.

name: pulumi.Output[str] = None

The name of the storage blob. Must be unique within the storage container the blob is located.

parallelism: pulumi.Output[float] = None

The number of workers per CPU core to run for concurrent uploads. Defaults to 8.

size: pulumi.Output[float] = None

Used only for page blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to 0.

source: pulumi.Output[Union[pulumi.Asset, pulumi.Archive]] = None

An absolute path to a file on the local system. This field cannot be specified for Append blobs and cannot be specified if source_content or source_uri is specified.

source_content: pulumi.Output[str] = None

The content for this blob which should be defined inline. This field can only be specified for Block blobs and cannot be specified if source or source_uri is specified.

source_uri: pulumi.Output[str] = None

The URI of an existing blob, or a file in the Azure File service, to use as the source contents for the blob to be created. Changing this forces a new resource to be created. This field cannot be specified for Append blobs and cannot be specified if source or source_content is specified.

storage_account_name: pulumi.Output[str] = None

Specifies the storage account in which to create the storage container. Changing this forces a new resource to be created.

storage_container_name: pulumi.Output[str] = None

The name of the storage container in which this blob should be created.

type: pulumi.Output[str] = None

The type of the storage blob to be created. Possible values are Append, Block or Page. Changing this forces a new resource to be created.

url: pulumi.Output[str] = None

The URL of the blob

static get(resource_name, id, opts=None, access_tier=None, content_type=None, metadata=None, name=None, parallelism=None, size=None, source=None, source_content=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, url=None)

Get an existing Blob 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.

  • access_tier (pulumi.Input[str]) – The access tier of the storage blob. Possible values are Archive, Cool and Hot.

  • content_type (pulumi.Input[str]) – The content type of the storage blob. Cannot be defined if source_uri is defined. Defaults to application/octet-stream.

  • metadata (pulumi.Input[dict]) – A map of custom blob metadata.

  • name (pulumi.Input[str]) – The name of the storage blob. Must be unique within the storage container the blob is located.

  • parallelism (pulumi.Input[float]) – The number of workers per CPU core to run for concurrent uploads. Defaults to 8.

  • size (pulumi.Input[float]) – Used only for page blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to 0.

  • pulumi.Archive]] source (pulumi.Input[Union[pulumi.Asset,) – An absolute path to a file on the local system. This field cannot be specified for Append blobs and cannot be specified if source_content or source_uri is specified.

  • source_content (pulumi.Input[str]) – The content for this blob which should be defined inline. This field can only be specified for Block blobs and cannot be specified if source or source_uri is specified.

  • source_uri (pulumi.Input[str]) – The URI of an existing blob, or a file in the Azure File service, to use as the source contents for the blob to be created. Changing this forces a new resource to be created. This field cannot be specified for Append blobs and cannot be specified if source or source_content is specified.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage container. Changing this forces a new resource to be created.

  • storage_container_name (pulumi.Input[str]) – The name of the storage container in which this blob should be created.

  • type (pulumi.Input[str]) – The type of the storage blob to be created. Possible values are Append, Block or Page. Changing this forces a new resource to be created.

  • url (pulumi.Input[str]) – The URL of the blob

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.storage.Container(resource_name, opts=None, container_access_type=None, metadata=None, name=None, storage_account_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Container within an Azure Storage Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    tags={
        "environment": "staging",
    })
example_container = azure.storage.Container("exampleContainer",
    storage_account_name=example_account.name,
    container_access_type="private")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • container_access_type (pulumi.Input[str]) – The Access Level configured for this Container. Possible values are blob, container or private. Defaults to private.

  • metadata (pulumi.Input[dict]) – A mapping of MetaData for this Container.

  • name (pulumi.Input[str]) – The name of the Container which should be created within the Storage Account.

  • storage_account_name (pulumi.Input[str]) – The name of the Storage Account where the Container should be created.

container_access_type: pulumi.Output[str] = None

The Access Level configured for this Container. Possible values are blob, container or private. Defaults to private.

has_immutability_policy: pulumi.Output[bool] = None

Is there an Immutability Policy configured on this Storage Container?

Is there a Legal Hold configured on this Storage Container?

metadata: pulumi.Output[dict] = None

A mapping of MetaData for this Container.

name: pulumi.Output[str] = None

The name of the Container which should be created within the Storage Account.

resource_manager_id: pulumi.Output[str] = None

The Resource Manager ID of this Storage Container.

storage_account_name: pulumi.Output[str] = None

The name of the Storage Account where the Container should be created.

static get(resource_name, id, opts=None, container_access_type=None, has_immutability_policy=None, has_legal_hold=None, metadata=None, name=None, resource_manager_id=None, storage_account_name=None)

Get an existing Container 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.

  • container_access_type (pulumi.Input[str]) – The Access Level configured for this Container. Possible values are blob, container or private. Defaults to private.

  • has_immutability_policy (pulumi.Input[bool]) – Is there an Immutability Policy configured on this Storage Container?

  • has_legal_hold (pulumi.Input[bool]) – Is there a Legal Hold configured on this Storage Container?

  • metadata (pulumi.Input[dict]) – A mapping of MetaData for this Container.

  • name (pulumi.Input[str]) – The name of the Container which should be created within the Storage Account.

  • resource_manager_id (pulumi.Input[str]) – The Resource Manager ID of this Storage Container.

  • storage_account_name (pulumi.Input[str]) – The name of the Storage Account where the Container should 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.storage.CustomerManagedKey(resource_name, opts=None, key_name=None, key_vault_id=None, key_version=None, storage_account_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Customer Managed Key for a Storage Account.

Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • key_name (pulumi.Input[str]) – The name of Key Vault Key.

  • key_vault_id (pulumi.Input[str]) – The ID of the Key Vault. Changing this forces a new resource to be created.

  • key_version (pulumi.Input[str]) – The version of Key Vault Key.

  • storage_account_id (pulumi.Input[str]) – The ID of the Storage Account. Changing this forces a new resource to be created.

key_name: pulumi.Output[str] = None

The name of Key Vault Key.

key_vault_id: pulumi.Output[str] = None

The ID of the Key Vault. Changing this forces a new resource to be created.

key_version: pulumi.Output[str] = None

The version of Key Vault Key.

storage_account_id: pulumi.Output[str] = None

The ID of the Storage Account. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, key_name=None, key_vault_id=None, key_version=None, storage_account_id=None)

Get an existing CustomerManagedKey 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.

  • key_name (pulumi.Input[str]) – The name of Key Vault Key.

  • key_vault_id (pulumi.Input[str]) – The ID of the Key Vault. Changing this forces a new resource to be created.

  • key_version (pulumi.Input[str]) – The version of Key Vault Key.

  • storage_account_id (pulumi.Input[str]) – The ID of the Storage Account. 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.storage.DataLakeGen2Filesystem(resource_name, opts=None, name=None, properties=None, storage_account_id=None, __props__=None, __name__=None, __opts__=None)

Manages a Data Lake Gen2 File System within an Azure Storage Account.

NOTE: This Resource requires using Azure Active Directory to connect to Azure Storage, which in turn requires the Storage specific roles - which are not granted by default.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled="true")
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem",
    storage_account_id=example_account.id,
    properties={
        "hello": "aGVsbG8=",
    })
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

  • properties (pulumi.Input[dict]) – A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

  • storage_account_id (pulumi.Input[str]) – Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None

The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

properties: pulumi.Output[dict] = None

A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

storage_account_id: pulumi.Output[str] = None

Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, name=None, properties=None, storage_account_id=None)

Get an existing DataLakeGen2Filesystem 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.

  • name (pulumi.Input[str]) – The name of the Data Lake Gen2 File System which should be created within the Storage Account. Must be unique within the storage account the queue is located. Changing this forces a new resource to be created.

  • properties (pulumi.Input[dict]) – A mapping of Key to Base64-Encoded Values which should be assigned to this Data Lake Gen2 File System.

  • storage_account_id (pulumi.Input[str]) – Specifies the ID of the Storage Account in which the Data Lake Gen2 File System should exist. 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.storage.GetAccountBlobContainerSASResult(cache_control=None, connection_string=None, container_name=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, expiry=None, https_only=None, id=None, ip_address=None, permissions=None, sas=None, start=None)

A collection of values returned by getAccountBlobContainerSAS.

id = None

The provider-assigned unique ID for this managed resource.

sas = None

The computed Blob Container Shared Access Signature (SAS).

class pulumi_azure.storage.GetAccountResult(access_tier=None, account_kind=None, account_replication_type=None, account_tier=None, custom_domains=None, enable_https_traffic_only=None, id=None, is_hns_enabled=None, location=None, name=None, primary_access_key=None, primary_blob_connection_string=None, primary_blob_endpoint=None, primary_blob_host=None, primary_connection_string=None, primary_dfs_endpoint=None, primary_dfs_host=None, primary_file_endpoint=None, primary_file_host=None, primary_location=None, primary_queue_endpoint=None, primary_queue_host=None, primary_table_endpoint=None, primary_table_host=None, primary_web_endpoint=None, primary_web_host=None, resource_group_name=None, secondary_access_key=None, secondary_blob_connection_string=None, secondary_blob_endpoint=None, secondary_blob_host=None, secondary_connection_string=None, secondary_dfs_endpoint=None, secondary_dfs_host=None, secondary_file_endpoint=None, secondary_file_host=None, secondary_location=None, secondary_queue_endpoint=None, secondary_queue_host=None, secondary_table_endpoint=None, secondary_table_host=None, secondary_web_endpoint=None, secondary_web_host=None, tags=None)

A collection of values returned by getAccount.

access_tier = None

The access tier for BlobStorage accounts.

account_kind = None

The Kind of account.

account_replication_type = None

The type of replication used for this storage account.

account_tier = None

The Tier of this storage account.

custom_domains = None

A custom_domain block as documented below.

enable_https_traffic_only = None

Is traffic only allowed via HTTPS? See here for more information.

id = None

The provider-assigned unique ID for this managed resource.

is_hns_enabled = None

Is Hierarchical Namespace enabled?

location = None

The Azure location where the Storage Account exists

name = None

The Custom Domain Name used for the Storage Account.

primary_access_key = None

The primary access key for the Storage Account.

primary_blob_connection_string = None

The connection string associated with the primary blob location

primary_blob_endpoint = None

The endpoint URL for blob storage in the primary location.

primary_blob_host = None

The hostname with port if applicable for blob storage in the primary location.

primary_connection_string = None

The connection string associated with the primary location

primary_dfs_endpoint = None

The endpoint URL for DFS storage in the primary location.

primary_dfs_host = None

The hostname with port if applicable for DFS storage in the primary location.

primary_file_endpoint = None

The endpoint URL for file storage in the primary location.

primary_file_host = None

The hostname with port if applicable for file storage in the primary location.

primary_location = None

The primary location of the Storage Account.

primary_queue_endpoint = None

The endpoint URL for queue storage in the primary location.

primary_queue_host = None

The hostname with port if applicable for queue storage in the primary location.

primary_table_endpoint = None

The endpoint URL for table storage in the primary location.

primary_table_host = None

The hostname with port if applicable for table storage in the primary location.

primary_web_endpoint = None

The endpoint URL for web storage in the primary location.

primary_web_host = None

The hostname with port if applicable for web storage in the primary location.

secondary_access_key = None

The secondary access key for the Storage Account.

secondary_blob_connection_string = None

The connection string associated with the secondary blob location

secondary_blob_endpoint = None

The endpoint URL for blob storage in the secondary location.

secondary_blob_host = None

The hostname with port if applicable for blob storage in the secondary location.

secondary_connection_string = None

The connection string associated with the secondary location

secondary_dfs_endpoint = None

The endpoint URL for DFS storage in the secondary location.

secondary_dfs_host = None

The hostname with port if applicable for DFS storage in the secondary location.

secondary_file_endpoint = None

The endpoint URL for file storage in the secondary location.

secondary_file_host = None

The hostname with port if applicable for file storage in the secondary location.

secondary_location = None

The secondary location of the Storage Account.

secondary_queue_endpoint = None

The endpoint URL for queue storage in the secondary location.

secondary_queue_host = None

The hostname with port if applicable for queue storage in the secondary location.

secondary_table_endpoint = None

The endpoint URL for table storage in the secondary location.

secondary_table_host = None

The hostname with port if applicable for table storage in the secondary location.

secondary_web_endpoint = None

The endpoint URL for web storage in the secondary location.

secondary_web_host = None

The hostname with port if applicable for web storage in the secondary location.

tags = None

A mapping of tags to assigned to the resource.

class pulumi_azure.storage.GetAccountSASResult(connection_string=None, expiry=None, https_only=None, id=None, permissions=None, resource_types=None, sas=None, services=None, start=None)

A collection of values returned by getAccountSAS.

id = None

The provider-assigned unique ID for this managed resource.

sas = None

The computed Account Shared Access Signature (SAS).

class pulumi_azure.storage.GetPolicyResult(id=None, rules=None, storage_account_id=None)

A collection of values returned by getPolicy.

id = None

The provider-assigned unique ID for this managed resource.

rules = None

A rule block as documented below.

class pulumi_azure.storage.GetStorageContainerResult(container_access_type=None, has_immutability_policy=None, has_legal_hold=None, id=None, metadata=None, name=None, resource_manager_id=None, storage_account_name=None)

A collection of values returned by getStorageContainer.

container_access_type = None

The Access Level configured for this Container.

has_immutability_policy = None

Is there an Immutability Policy configured on this Storage Container?

Is there a Legal Hold configured on this Storage Container?

id = None

The provider-assigned unique ID for this managed resource.

metadata = None

A mapping of MetaData for this Container.

resource_manager_id = None

The Resource Manager ID of this Storage Container.

class pulumi_azure.storage.ManagementPolicy(resource_name, opts=None, rules=None, storage_account_id=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Storage Account Management Policy.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="BlobStorage")
example_management_policy = azure.storage.ManagementPolicy("exampleManagementPolicy",
    storage_account_id=example_account.id,
    rule=[
        {
            "name": "rule1",
            "enabled": True,
            "filters": {
                "prefixMatches": ["container1/prefix1"],
                "blobTypes": ["blockBlob"],
            },
            "actions": {
                "base_blob": {
                    "tierToCoolAfterDaysSinceModificationGreaterThan": 10,
                    "tierToArchiveAfterDaysSinceModificationGreaterThan": 50,
                    "deleteAfterDaysSinceModificationGreaterThan": 100,
                },
                "snapshot": {
                    "deleteAfterDaysSinceCreationGreaterThan": 30,
                },
            },
        },
        {
            "name": "rule2",
            "enabled": False,
            "filters": {
                "prefixMatches": [
                    "container2/prefix1",
                    "container2/prefix2",
                ],
                "blobTypes": ["blockBlob"],
            },
            "actions": {
                "base_blob": {
                    "tierToCoolAfterDaysSinceModificationGreaterThan": 11,
                    "tierToArchiveAfterDaysSinceModificationGreaterThan": 51,
                    "deleteAfterDaysSinceModificationGreaterThan": 101,
                },
                "snapshot": {
                    "deleteAfterDaysSinceCreationGreaterThan": 31,
                },
            },
        },
    ])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • rules (pulumi.Input[list]) – A rule block as documented below.

  • storage_account_id (pulumi.Input[str]) – Specifies the id of the storage account to apply the management policy to.

The rules object supports the following:

  • actions (pulumi.Input[dict]) - An actions block as documented below.

    • baseBlob (pulumi.Input[dict]) - A base_blob block as documented below.

      • deleteAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to delete the blob. Must be at least 0.

      • tierToArchiveAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be at least 0.

      • tierToCoolAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be at least 0.

    • snapshot (pulumi.Input[dict]) - A snapshot block as documented below.

      • deleteAfterDaysSinceCreationGreaterThan (pulumi.Input[float]) - The age in days after create to delete the snaphot. Must be at least 0.

  • enabled (pulumi.Input[bool]) - Boolean to specify whether the rule is enabled.

  • filters (pulumi.Input[dict]) - A filter block as documented below.

    • blobTypes (pulumi.Input[list]) - An array of predefined values. Only blockBlob is supported.

    • prefixMatches (pulumi.Input[list]) - An array of strings for prefixes to be matched.

  • name (pulumi.Input[str]) - A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

rules: pulumi.Output[list] = None

A rule block as documented below.

  • actions (dict) - An actions block as documented below.

    • baseBlob (dict) - A base_blob block as documented below.

      • deleteAfterDaysSinceModificationGreaterThan (float) - The age in days after last modification to delete the blob. Must be at least 0.

      • tierToArchiveAfterDaysSinceModificationGreaterThan (float) - The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be at least 0.

      • tierToCoolAfterDaysSinceModificationGreaterThan (float) - The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be at least 0.

    • snapshot (dict) - A snapshot block as documented below.

      • deleteAfterDaysSinceCreationGreaterThan (float) - The age in days after create to delete the snaphot. Must be at least 0.

  • enabled (bool) - Boolean to specify whether the rule is enabled.

  • filters (dict) - A filter block as documented below.

    • blobTypes (list) - An array of predefined values. Only blockBlob is supported.

    • prefixMatches (list) - An array of strings for prefixes to be matched.

  • name (str) - A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

storage_account_id: pulumi.Output[str] = None

Specifies the id of the storage account to apply the management policy to.

static get(resource_name, id, opts=None, rules=None, storage_account_id=None)

Get an existing ManagementPolicy 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.

  • rules (pulumi.Input[list]) – A rule block as documented below.

  • storage_account_id (pulumi.Input[str]) – Specifies the id of the storage account to apply the management policy to.

The rules object supports the following:

  • actions (pulumi.Input[dict]) - An actions block as documented below.

    • baseBlob (pulumi.Input[dict]) - A base_blob block as documented below.

      • deleteAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to delete the blob. Must be at least 0.

      • tierToArchiveAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be at least 0.

      • tierToCoolAfterDaysSinceModificationGreaterThan (pulumi.Input[float]) - The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be at least 0.

    • snapshot (pulumi.Input[dict]) - A snapshot block as documented below.

      • deleteAfterDaysSinceCreationGreaterThan (pulumi.Input[float]) - The age in days after create to delete the snaphot. Must be at least 0.

  • enabled (pulumi.Input[bool]) - Boolean to specify whether the rule is enabled.

  • filters (pulumi.Input[dict]) - A filter block as documented below.

    • blobTypes (pulumi.Input[list]) - An array of predefined values. Only blockBlob is supported.

    • prefixMatches (pulumi.Input[list]) - An array of strings for prefixes to be matched.

  • name (pulumi.Input[str]) - A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

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.storage.Queue(resource_name, opts=None, metadata=None, name=None, storage_account_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Queue within an Azure Storage Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_queue = azure.storage.Queue("exampleQueue", storage_account_name=example_account.name)
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • metadata (pulumi.Input[dict]) – A mapping of MetaData which should be assigned to this Storage Queue.

  • name (pulumi.Input[str]) – The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

  • storage_account_name (pulumi.Input[str]) – Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

metadata: pulumi.Output[dict] = None

A mapping of MetaData which should be assigned to this Storage Queue.

name: pulumi.Output[str] = None

The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

storage_account_name: pulumi.Output[str] = None

Specifies the Storage Account in which the Storage Queue should exist. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, metadata=None, name=None, storage_account_name=None)

Get an existing Queue 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.

  • metadata (pulumi.Input[dict]) – A mapping of MetaData which should be assigned to this Storage Queue.

  • name (pulumi.Input[str]) – The name of the Queue which should be created within the Storage Account. Must be unique within the storage account the queue is located.

  • storage_account_name (pulumi.Input[str]) – Specifies the Storage Account in which the Storage Queue should exist. 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.storage.Share(resource_name, opts=None, acls=None, metadata=None, name=None, quota=None, storage_account_name=None, __props__=None, __name__=None, __opts__=None)

Manages a File Share within Azure Storage.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_share = azure.storage.Share("exampleShare",
    storage_account_name=example_account.name,
    quota=50,
    acl=[{
        "id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
        "access_policy": [{
            "permissions": "rwdl",
            "start": "2019-07-02T09:38:21.0000000Z",
            "expiry": "2019-07-02T10:38:21.0000000Z",
        }],
    }])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acls (pulumi.Input[list]) – One or more acl blocks as defined below.

  • metadata (pulumi.Input[dict]) – A mapping of MetaData for this File Share.

  • name (pulumi.Input[str]) – The name of the share. Must be unique within the storage account where the share is located.

  • quota (pulumi.Input[float]) – The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the share. Changing this forces a new resource to be created.

The acls object supports the following:

  • access_policies (pulumi.Input[list]) - An access_policy block as defined below.

    • expiry (pulumi.Input[str]) - The time at which this Access Policy should be valid until, in ISO8601 format.

    • permissions (pulumi.Input[str]) - The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).

    • start (pulumi.Input[str]) - The time at which this Access Policy should be valid from, in ISO8601 format.

  • id (pulumi.Input[str]) - The ID which should be used for this Shared Identifier.

acls: pulumi.Output[list] = None

One or more acl blocks as defined below.

  • access_policies (list) - An access_policy block as defined below.

    • expiry (str) - The time at which this Access Policy should be valid until, in ISO8601 format.

    • permissions (str) - The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).

    • start (str) - The time at which this Access Policy should be valid from, in ISO8601 format.

  • id (str) - The ID which should be used for this Shared Identifier.

metadata: pulumi.Output[dict] = None

A mapping of MetaData for this File Share.

name: pulumi.Output[str] = None

The name of the share. Must be unique within the storage account where the share is located.

quota: pulumi.Output[float] = None

The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

resource_manager_id: pulumi.Output[str] = None

The Resource Manager ID of this File Share.

storage_account_name: pulumi.Output[str] = None

Specifies the storage account in which to create the share. Changing this forces a new resource to be created.

url: pulumi.Output[str] = None

The URL of the File Share

static get(resource_name, id, opts=None, acls=None, metadata=None, name=None, quota=None, resource_manager_id=None, storage_account_name=None, url=None)

Get an existing Share 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.

  • acls (pulumi.Input[list]) – One or more acl blocks as defined below.

  • metadata (pulumi.Input[dict]) – A mapping of MetaData for this File Share.

  • name (pulumi.Input[str]) – The name of the share. Must be unique within the storage account where the share is located.

  • quota (pulumi.Input[float]) – The maximum size of the share, in gigabytes. For Standard storage accounts, this must be greater than 0 and less than 5120 GB (5 TB). For Premium FileStorage storage accounts, this must be greater than 100 GB and less than 102400 GB (100 TB). Default is 5120.

  • resource_manager_id (pulumi.Input[str]) – The Resource Manager ID of this File Share.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the share. Changing this forces a new resource to be created.

  • url (pulumi.Input[str]) – The URL of the File Share

The acls object supports the following:

  • access_policies (pulumi.Input[list]) - An access_policy block as defined below.

    • expiry (pulumi.Input[str]) - The time at which this Access Policy should be valid until, in ISO8601 format.

    • permissions (pulumi.Input[str]) - The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).

    • start (pulumi.Input[str]) - The time at which this Access Policy should be valid from, in ISO8601 format.

  • id (pulumi.Input[str]) - The ID which should be used for this Shared Identifier.

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.storage.ShareDirectory(resource_name, opts=None, metadata=None, name=None, share_name=None, storage_account_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Directory within an Azure Storage File Share.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_share = azure.storage.Share("exampleShare",
    storage_account_name=example_account.name,
    quota=50)
example_share_directory = azure.storage.ShareDirectory("exampleShareDirectory",
    share_name=example_share.name,
    storage_account_name=example_account.name)
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • metadata (pulumi.Input[dict]) – A mapping of metadata to assign to this Directory.

  • name (pulumi.Input[str]) – The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

  • share_name (pulumi.Input[str]) – The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.

  • storage_account_name (pulumi.Input[str]) – The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

metadata: pulumi.Output[dict] = None

A mapping of metadata to assign to this Directory.

name: pulumi.Output[str] = None

The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

share_name: pulumi.Output[str] = None

The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.

storage_account_name: pulumi.Output[str] = None

The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, metadata=None, name=None, share_name=None, storage_account_name=None)

Get an existing ShareDirectory 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.

  • metadata (pulumi.Input[dict]) – A mapping of metadata to assign to this Directory.

  • name (pulumi.Input[str]) – The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

  • share_name (pulumi.Input[str]) – The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.

  • storage_account_name (pulumi.Input[str]) – The name of the Storage Account within which the File Share is located. 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.storage.Table(resource_name, opts=None, acls=None, name=None, storage_account_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Table within an Azure Storage Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_table = azure.storage.Table("exampleTable", storage_account_name=example_account.name)
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acls (pulumi.Input[list]) – One or more acl blocks as defined below.

  • name (pulumi.Input[str]) – The name of the storage table. Must be unique within the storage account the table is located.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage table. Changing this forces a new resource to be created.

The acls object supports the following:

  • access_policies (pulumi.Input[list]) - An access_policy block as defined below.

    • expiry (pulumi.Input[str]) - The ISO8061 UTC time at which this Access Policy should be valid until.

    • permissions (pulumi.Input[str]) - The permissions which should associated with this Shared Identifier.

    • start (pulumi.Input[str]) - The ISO8061 UTC time at which this Access Policy should be valid from.

  • id (pulumi.Input[str]) - The ID which should be used for this Shared Identifier.

acls: pulumi.Output[list] = None

One or more acl blocks as defined below.

  • access_policies (list) - An access_policy block as defined below.

    • expiry (str) - The ISO8061 UTC time at which this Access Policy should be valid until.

    • permissions (str) - The permissions which should associated with this Shared Identifier.

    • start (str) - The ISO8061 UTC time at which this Access Policy should be valid from.

  • id (str) - The ID which should be used for this Shared Identifier.

name: pulumi.Output[str] = None

The name of the storage table. Must be unique within the storage account the table is located.

storage_account_name: pulumi.Output[str] = None

Specifies the storage account in which to create the storage table. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, acls=None, name=None, storage_account_name=None)

Get an existing Table 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.

  • acls (pulumi.Input[list]) – One or more acl blocks as defined below.

  • name (pulumi.Input[str]) – The name of the storage table. Must be unique within the storage account the table is located.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage table. Changing this forces a new resource to be created.

The acls object supports the following:

  • access_policies (pulumi.Input[list]) - An access_policy block as defined below.

    • expiry (pulumi.Input[str]) - The ISO8061 UTC time at which this Access Policy should be valid until.

    • permissions (pulumi.Input[str]) - The permissions which should associated with this Shared Identifier.

    • start (pulumi.Input[str]) - The ISO8061 UTC time at which this Access Policy should be valid from.

  • id (pulumi.Input[str]) - The ID which should be used for this Shared Identifier.

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.storage.TableEntity(resource_name, opts=None, entity=None, partition_key=None, row_key=None, storage_account_name=None, table_name=None, __props__=None, __name__=None, __opts__=None)

Manages an Entity within a Table in an Azure Storage Account.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="westus")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_table = azure.storage.Table("exampleTable",
    resource_group_name=example_resource_group.name,
    storage_account_name=example_account.name)
example_table_entity = azure.storage.TableEntity("exampleTableEntity",
    storage_account_name=example_account.name,
    table_name=example_table.name,
    partition_key="examplepartition",
    row_key="exmamplerow",
    entity={
        "example": "example",
    })
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • entity (pulumi.Input[dict]) – A map of key/value pairs that describe the entity to be inserted/merged in to the storage table.

  • partition_key (pulumi.Input[str]) – The key for the partition where the entity will be inserted/merged. Changing this forces a new resource.

  • row_key (pulumi.Input[str]) – The key for the row where the entity will be inserted/merged. Changing this forces a new resource.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage table entity. Changing this forces a new resource to be created.

  • table_name (pulumi.Input[str]) – The name of the storage table in which to create the storage table entity. Changing this forces a new resource to be created.

entity: pulumi.Output[dict] = None

A map of key/value pairs that describe the entity to be inserted/merged in to the storage table.

partition_key: pulumi.Output[str] = None

The key for the partition where the entity will be inserted/merged. Changing this forces a new resource.

row_key: pulumi.Output[str] = None

The key for the row where the entity will be inserted/merged. Changing this forces a new resource.

storage_account_name: pulumi.Output[str] = None

Specifies the storage account in which to create the storage table entity. Changing this forces a new resource to be created.

table_name: pulumi.Output[str] = None

The name of the storage table in which to create the storage table entity. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, entity=None, partition_key=None, row_key=None, storage_account_name=None, table_name=None)

Get an existing TableEntity 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.

  • entity (pulumi.Input[dict]) – A map of key/value pairs that describe the entity to be inserted/merged in to the storage table.

  • partition_key (pulumi.Input[str]) – The key for the partition where the entity will be inserted/merged. Changing this forces a new resource.

  • row_key (pulumi.Input[str]) – The key for the row where the entity will be inserted/merged. Changing this forces a new resource.

  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage table entity. Changing this forces a new resource to be created.

  • table_name (pulumi.Input[str]) – The name of the storage table in which to create the storage table entity. 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.storage.ZipBlob(resource_name, opts=None, access_tier=None, content=None, content_type=None, metadata=None, name=None, parallelism=None, size=None, source_content=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, __props__=None, __name__=None, __opts__=None)

Create a ZipBlob resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, access_tier=None, content=None, content_type=None, metadata=None, name=None, parallelism=None, size=None, source_content=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, url=None)

Get an existing ZipBlob 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.

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

pulumi_azure.storage.get_account(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Storage Account.

import pulumi
import pulumi_azure as azure

example = azure.storage.get_account(name="packerimages",
    resource_group_name="packer-storage")
pulumi.export("storageAccountTier", example.account_tier)
Parameters

  • name (str) – Specifies the name of the Storage Account

  • resource_group_name (str) – Specifies the name of the resource group the Storage Account is located in.

pulumi_azure.storage.get_account_blob_container_sas(cache_control=None, connection_string=None, container_name=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, expiry=None, https_only=None, ip_address=None, permissions=None, start=None, opts=None)

Use this data source to obtain a Shared Access Signature (SAS Token) for an existing Storage Account Blob Container.

Shared access signatures allow fine-grained, ephemeral access control to various aspects of an Azure Storage Account Blob Container.

import pulumi
import pulumi_azure as azure

rg = azure.core.ResourceGroup("rg", location="westus")
storage = azure.storage.Account("storage",
    resource_group_name=rg.name,
    location=rg.location,
    account_tier="Standard",
    account_replication_type="LRS")
container = azure.storage.Container("container",
    storage_account_name=storage.name,
    container_access_type="private")
example = pulumi.Output.all(storage.primary_connection_string, container.name).apply(lambda primary_connection_string, name: azure.storage.get_account_blob_container_sas(connection_string=primary_connection_string,
    container_name=name,
    https_only=True,
    ip_address="168.1.5.65",
    start="2018-03-21",
    expiry="2018-03-21",
    permissions={
        "read": True,
        "add": True,
        "create": False,
        "write": False,
        "delete": True,
        "list": True,
    },
    cache_control="max-age=5",
    content_disposition="inline",
    content_encoding="deflate",
    content_language="en-US",
    content_type="application/json"))
pulumi.export("sasUrlQueryString", example.sas)
Parameters

  • cache_control (str) – The Cache-Control response header that is sent when this SAS token is used.

  • connection_string (str) – The connection string for the storage account to which this SAS applies. Typically directly from the primary_connection_string attribute of an storage.Account resource.

  • container_name (str) – Name of the container.

  • content_disposition (str) – The Content-Disposition response header that is sent when this SAS token is used.

  • content_encoding (str) – The Content-Encoding response header that is sent when this SAS token is used.

  • content_language (str) – The Content-Language response header that is sent when this SAS token is used.

  • content_type (str) – The Content-Type response header that is sent when this SAS token is used.

  • expiry (str) – The expiration time and date of this SAS. Must be a valid ISO-8601 format time/date string.

  • https_only (bool) – Only permit https access. If false, both http and https are permitted. Defaults to true.

  • ip_address (str) – Single ipv4 address or range (connected with a dash) of ipv4 addresses.

  • permissions (dict) – A permissions block as defined below.

  • start (str) – The starting time and date of validity of this SAS. Must be a valid ISO-8601 format time/date string.

The permissions object supports the following:

  • add (bool) - Should Add permissions be enabled for this SAS?

  • create (bool) - Should Create permissions be enabled for this SAS?

  • delete (bool) - Should Delete permissions be enabled for this SAS?

  • list (bool) - Should List permissions be enabled for this SAS?

  • read (bool) - Should Read permissions be enabled for this SAS?

  • write (bool) - Should Write permissions be enabled for this SAS?

pulumi_azure.storage.get_account_sas(connection_string=None, expiry=None, https_only=None, permissions=None, resource_types=None, services=None, start=None, opts=None)

Use this data source to obtain a Shared Access Signature (SAS Token) for an existing Storage Account.

Shared access signatures allow fine-grained, ephemeral access control to various aspects of an Azure Storage Account.

Note that this is an Account SAS and not a Service SAS.

Parameters

  • connection_string (str) – The connection string for the storage account to which this SAS applies. Typically directly from the primary_connection_string attribute of a storage.Account resource.

  • expiry (str) – The expiration time and date of this SAS. Must be a valid ISO-8601 format time/date string.

  • https_only (bool) – Only permit https access. If false, both http and https are permitted. Defaults to true.

  • permissions (dict) – A permissions block as defined below.

  • resource_types (dict) – A resource_types block as defined below.

  • services (dict) – A services block as defined below.

  • start (str) – The starting time and date of validity of this SAS. Must be a valid ISO-8601 format time/date string.

The permissions object supports the following:

  • add (bool) - Should Add permissions be enabled for this SAS?

  • create (bool) - Should Create permissions be enabled for this SAS?

  • delete (bool) - Should Delete permissions be enabled for this SAS?

  • list (bool) - Should List permissions be enabled for this SAS?

  • process (bool) - Should Process permissions be enabled for this SAS?

  • read (bool) - Should Read permissions be enabled for this SAS?

  • update (bool) - Should Update permissions be enabled for this SAS?

  • write (bool) - Should Write permissions be enabled for this SAS?

The resource_types object supports the following:

  • container (bool) - Should permission be granted to the container?

  • object (bool) - Should permission be granted only to a specific object?

  • service (bool) - Should permission be granted to the entire service?

The services object supports the following:

  • blob (bool) - Should permission be granted to blob services within this storage account?

  • file (bool) - Should permission be granted to file services within this storage account?

  • queue (bool) - Should permission be granted to queue services within this storage account?

  • table (bool) - Should permission be granted to table services within this storage account?

pulumi_azure.storage.get_policy(storage_account_id=None, opts=None)

Use this data source to access information about an existing Storage Management Policy.

import pulumi
import pulumi_azure as azure

example_account = azure.storage.get_account(name="storageaccountname",
    resource_group_name="resourcegroupname")
example_policy = azure.storage.get_policy(storage_account_id=azurerm_storage_account["example"]["id"])
Parameters

storage_account_id (str) – Specifies the id of the storage account to retrieve the management policy for.

pulumi_azure.storage.get_storage_container(metadata=None, name=None, storage_account_name=None, opts=None)

Use this data source to access information about an existing Storage Container.

import pulumi
import pulumi_azure as azure

example = azure.storage.get_storage_container(name="example-container-name",
    storage_account_name="example-storage-account-name")
Parameters

  • metadata (dict) – A mapping of MetaData for this Container.

  • name (str) – The name of the Container.

  • storage_account_name (str) – The name of the Storage Account where the Container exists.