storage

class pulumi_azure.storage.Account(resource_name, opts=None, access_tier=None, account_encryption_source=None, account_kind=None, account_replication_type=None, account_tier=None, account_type=None, custom_domain=None, enable_blob_encryption=None, enable_file_encryption=None, enable_https_traffic_only=None, identity=None, location=None, name=None, network_rules=None, resource_group_name=None, tags=None, __name__=None, __opts__=None)

layout: “azurerm” page_title: “Azure Resource Manager: azurerm_storage_account” sidebar_current: “docs-azurerm-resource-storage-account” description: |-

Manages a Azure Storage Account.

Manage an Azure Storage Account.

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 and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.
  • account_encryption_source (pulumi.Input[str]) – The Encryption Source for this Storage Account. Possible values are Microsoft.Keyvault and Microsoft.Storage. Defaults to Microsoft.Storage.
  • account_kind (pulumi.Input[str]) – Defines the Kind of account. Valid options are Storage, StorageV2 and BlobStorage. Changing this forces a new resource to be created. Defaults to Storage.
  • account_replication_type (pulumi.Input[str]) – Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS and ZRS.
  • account_tier (pulumi.Input[str]) – Defines the Tier to use for this storage account. Valid options are Standard and Premium. Changing this forces a new resource to be created
  • custom_domain (pulumi.Input[dict]) – A custom_domain block as documented below.
  • enable_blob_encryption (pulumi.Input[bool]) – Boolean flag which controls if Encryption Services are enabled for Blob storage, see here for more information. Defaults to true.
  • enable_file_encryption (pulumi.Input[bool]) –

    Boolean flag which controls if Encryption Services are enabled for File storage, see here for more information. Defaults to true.

  • enable_https_traffic_only (pulumi.Input[bool]) –

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

  • identity (pulumi.Input[dict]) – A Managed Service Identity block as defined below.
  • 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]) – The Custom Domain Name to use for the Storage Account, which will be validated by Azure.
  • network_rules (pulumi.Input[dict]) – A network_rules block as documented 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.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
access_tier = None

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

account_encryption_source = None

The Encryption Source for this Storage Account. Possible values are Microsoft.Keyvault and Microsoft.Storage. Defaults to Microsoft.Storage.

account_kind = None

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

account_replication_type = None

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

account_tier = None

Defines the Tier to use for this storage account. Valid options are Standard and Premium. Changing this forces a new resource to be created

custom_domain = None

A custom_domain block as documented below.

enable_blob_encryption = None

Boolean flag which controls if Encryption Services are enabled for Blob storage, see here for more information. Defaults to true.

enable_file_encryption = None

Boolean flag which controls if Encryption Services are enabled for File storage, see here for more information. Defaults to true.

enable_https_traffic_only = None

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

identity = None

A Managed Service Identity block as defined below.

location = None

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

name = None

The Custom Domain Name to use for the Storage Account, which will be validated by Azure.

network_rules = None

A network_rules block as documented below.

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_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.

resource_group_name = 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 = 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_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.

tags = None

A mapping of tags to assign to 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
class pulumi_azure.storage.Blob(resource_name, opts=None, attempts=None, content_type=None, name=None, parallelism=None, resource_group_name=None, size=None, source=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, __name__=None, __opts__=None)

Manage an Azure Storage Blob.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • attempts (pulumi.Input[float]) – The number of attempts to make per page or block when uploading. Defaults to 1.
  • 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.
  • 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.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage container. Changing this forces a new resource to be created.
  • 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.
  • source (pulumi.Input[str]) – An absolute path to a file on the local system. Cannot be defined if source_uri is defined.
  • 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. Cannot be defined if source is defined.
  • 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. One of either block or page. When not copying from an existing blob, this becomes required.
attempts = None

The number of attempts to make per page or block when uploading. Defaults to 1.

content_type = None

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

name = None

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

parallelism = None

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

resource_group_name = None

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

size = 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 = None

An absolute path to a file on the local system. Cannot be defined if source_uri is defined.

source_uri = 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. Cannot be defined if source is defined.

storage_account_name = None

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

storage_container_name = None

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

type = None

The type of the storage blob to be created. One of either block or page. When not copying from an existing blob, this becomes required.

url = None

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, name=None, resource_group_name=None, storage_account_name=None, __name__=None, __opts__=None)

Manage an Azure Storage Container.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • container_access_type (pulumi.Input[str]) – The ‘interface’ for access the container provides. Can be either blob, container or private. Defaults to private.
  • name (pulumi.Input[str]) – The name of the storage container. Must be unique within the storage service the container is located.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage container. Changing this forces a new resource to be created.
  • 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.
container_access_type = None

The ‘interface’ for access the container provides. Can be either blob, container or private. Defaults to private.

name = None

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

properties = None

Key-value definition of additional properties associated to the storage container

resource_group_name = None

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

storage_account_name = None

Specifies the storage account in which to create the storage container. 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.GetAccountResult(access_tier=None, account_encryption_source=None, account_kind=None, account_replication_type=None, account_tier=None, custom_domain=None, enable_blob_encryption=None, enable_file_encryption=None, enable_https_traffic_only=None, location=None, primary_access_key=None, primary_blob_connection_string=None, primary_blob_endpoint=None, primary_blob_host=None, primary_connection_string=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, secondary_access_key=None, secondary_blob_connection_string=None, secondary_blob_endpoint=None, secondary_blob_host=None, secondary_connection_string=None, secondary_location=None, secondary_queue_endpoint=None, secondary_queue_host=None, secondary_table_endpoint=None, secondary_table_host=None, tags=None, id=None)

A collection of values returned by getAccount.

access_tier = None

The access tier for BlobStorage accounts.

account_encryption_source = None

The Encryption Source for this Storage Account.

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_domain = None

A custom_domain block as documented below.

enable_blob_encryption = None

Are Encryption Services are enabled for Blob storage? See here for more information.

enable_file_encryption = None

Are Encryption Services are enabled for File storage? See here for more information.

enable_https_traffic_only = None

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

location = None

The Azure location where the Storage Account exists

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_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.

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_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.

tags = None

A mapping of tags to assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.storage.GetAccountSASResult(sas=None, id=None)

A collection of values returned by getAccountSAS.

sas = None

The computed Account Shared Access Signature (SAS).

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.storage.Queue(resource_name, opts=None, name=None, resource_group_name=None, storage_account_name=None, __name__=None, __opts__=None)

Manage an Azure Storage Queue.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the storage queue. Must be unique within the storage account the queue is located.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage queue. Changing this forces a new resource to be created.
  • storage_account_name (pulumi.Input[str]) – Specifies the storage account in which to create the storage queue. Changing this forces a new resource to be created.
name = None

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

resource_group_name = None

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

storage_account_name = None

Specifies the storage account in which to create the storage queue. 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, name=None, quota=None, resource_group_name=None, storage_account_name=None, __name__=None, __opts__=None)

Manage an Azure Storage File Share.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • 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. Must be greater than 0, and less than or equal to 5 TB (5120 GB). Default is 5120.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the share. Changing this forces a new resource to be created.
  • 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.
name = None

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

quota = None

The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5 TB (5120 GB). Default is 5120.

resource_group_name = None

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

storage_account_name = None

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

url = None

The URL of the share

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, name=None, resource_group_name=None, storage_account_name=None, __name__=None, __opts__=None)

Manage an Azure Storage Table.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the storage table. Must be unique within the storage account the table is located.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the storage table. Changing this forces a new resource to be created.
  • 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.
name = None

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

resource_group_name = None

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

storage_account_name = None

Specifies the storage account in which to create the storage table. 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, attempts=None, content_type=None, name=None, parallelism=None, resource_group_name=None, size=None, content=None, source_uri=None, storage_account_name=None, storage_container_name=None, type=None, __name__=None, __opts__=None)

Create a ZipBlob resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • 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.

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.