pulumi-azure-kotlin/com.pulumi.azure.storage.kotlin/Account

Account

class Account : KotlinCustomResource

Manages an Azure Storage Account.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("GRS")
            .tags(Map.of("environment", "staging"))
            .build());
    }
}

With Network Rules

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.inputs.AccountNetworkRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .addressSpaces("10.0.0.0/16")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());
        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .serviceEndpoints(
                "Microsoft.Sql",
                "Microsoft.Storage")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .networkRules(AccountNetworkRulesArgs.builder()
                .defaultAction("Deny")
                .ipRules("100.0.0.1")
                .virtualNetworkSubnetIds(exampleSubnet.id())
                .build())
            .tags(Map.of("environment", "staging"))
            .build());
    }
}

Import

Storage Accounts can be imported using the resource id, e.g.

$ pulumi import azure:storage/account:Account storageAcc1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount

Properties

accessTier

val accessTier: Output<String>

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

accountKind

val accountKind: Output<String>?

Defines the Kind of account. Valid options are BlobStorage, BlockBlobStorage, FileStorage, Storage and StorageV2. Defaults to StorageV2.

accountReplicationType

val accountReplicationType: Output<String>

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

accountTier

val accountTier: Output<String>

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.

allowedCopyScope

val allowedCopyScope: Output<String>?

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Possible values are AAD and PrivateLink.

allowNestedItemsToBePublic

val allowNestedItemsToBePublic: Output<Boolean>?

Allow or disallow nested items within this Account to opt into being public. Defaults to true.

azureFilesAuthentication

val azureFilesAuthentication: Output<AccountAzureFilesAuthentication>?

A azure_files_authentication block as defined below.

blobProperties

val blobProperties: Output<AccountBlobProperties>

A blob_properties block as defined below.

crossTenantReplicationEnabled

val crossTenantReplicationEnabled: Output<Boolean>?

Should cross Tenant replication be enabled? Defaults to true.

customDomain

val customDomain: Output<AccountCustomDomain>?

A custom_domain block as documented below.

customerManagedKey

val customerManagedKey: Output<AccountCustomerManagedKey>?

A customer_managed_key block as documented below.

defaultToOauthAuthentication

val defaultToOauthAuthentication: Output<Boolean>?

Default to Azure Active Directory authorization in the Azure portal when accessing the Storage Account. The default value is false

edgeZone

val edgeZone: Output<String>?

Specifies the Edge Zone within the Azure Region where this Storage Account should exist. Changing this forces a new Storage Account to be created.

enableHttpsTrafficOnly

val enableHttpsTrafficOnly: Output<Boolean>?

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

val id: Output<String>

identity

val identity: Output<AccountIdentity>?

An identity block as defined below.

immutabilityPolicy

val immutabilityPolicy: Output<AccountImmutabilityPolicy>?

An immutability_policy block as defined below. Changing this forces a new resource to be created.

infrastructureEncryptionEnabled

val infrastructureEncryptionEnabled: Output<Boolean>?

Is infrastructure encryption enabled? Changing this forces a new resource to be created. Defaults to false.

isHnsEnabled

val isHnsEnabled: Output<Boolean>?

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.

largeFileShareEnabled

val largeFileShareEnabled: Output<Boolean>

Is Large File Share Enabled?

location

val location: Output<String>

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

minTlsVersion

val minTlsVersion: Output<String>?

The minimum supported TLS version for the storage account. Possible values are TLS1_0, TLS1_1, and TLS1_2. Defaults to TLS1_2 for new storage accounts.

name

val name: Output<String>

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

networkRules

val networkRules: Output<AccountNetworkRules>

A network_rules block as documented below.

nfsv3Enabled

val nfsv3Enabled: Output<Boolean>?

Is NFSv3 protocol enabled? Changing this forces a new resource to be created. Defaults to false.

primaryAccessKey

val primaryAccessKey: Output<String>

The primary access key for the storage account.

primaryBlobConnectionString

val primaryBlobConnectionString: Output<String>

The connection string associated with the primary blob location.

primaryBlobEndpoint

val primaryBlobEndpoint: Output<String>

The endpoint URL for blob storage in the primary location.

primaryBlobHost

val primaryBlobHost: Output<String>

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

primaryConnectionString

val primaryConnectionString: Output<String>

The connection string associated with the primary location.

primaryDfsEndpoint

val primaryDfsEndpoint: Output<String>

The endpoint URL for DFS storage in the primary location.

primaryDfsHost

val primaryDfsHost: Output<String>

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

primaryFileEndpoint

val primaryFileEndpoint: Output<String>

The endpoint URL for file storage in the primary location.

primaryFileHost

val primaryFileHost: Output<String>

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

primaryLocation

val primaryLocation: Output<String>

The primary location of the storage account.

primaryQueueEndpoint

val primaryQueueEndpoint: Output<String>

The endpoint URL for queue storage in the primary location.

primaryQueueHost

val primaryQueueHost: Output<String>

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

primaryTableEndpoint

val primaryTableEndpoint: Output<String>

The endpoint URL for table storage in the primary location.

primaryTableHost

val primaryTableHost: Output<String>

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

primaryWebEndpoint

val primaryWebEndpoint: Output<String>

The endpoint URL for web storage in the primary location.

primaryWebHost

val primaryWebHost: Output<String>

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

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>?

Whether the public network access is enabled? Defaults to true.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

queueEncryptionKeyType

val queueEncryptionKeyType: Output<String>?

The encryption type of the queue service. Possible values are Service and Account. Changing this forces a new resource to be created. Default value is Service.

queueProperties

val queueProperties: Output<AccountQueueProperties>

A queue_properties block as defined below.

resourceGroupName

val resourceGroupName: Output<String>

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

routing

val routing: Output<AccountRouting>

A routing block as defined below.

sasPolicy

val sasPolicy: Output<AccountSasPolicy>?

A sas_policy block as defined below.

secondaryAccessKey

val secondaryAccessKey: Output<String>

The secondary access key for the storage account.

secondaryBlobConnectionString

val secondaryBlobConnectionString: Output<String>

The connection string associated with the secondary blob location.

secondaryBlobEndpoint

val secondaryBlobEndpoint: Output<String>

The endpoint URL for blob storage in the secondary location.

secondaryBlobHost

val secondaryBlobHost: Output<String>

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

secondaryConnectionString

val secondaryConnectionString: Output<String>

The connection string associated with the secondary location.

secondaryDfsEndpoint

val secondaryDfsEndpoint: Output<String>

The endpoint URL for DFS storage in the secondary location.

secondaryDfsHost

val secondaryDfsHost: Output<String>

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

secondaryFileEndpoint

val secondaryFileEndpoint: Output<String>

The endpoint URL for file storage in the secondary location.

secondaryFileHost

val secondaryFileHost: Output<String>

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

secondaryLocation

val secondaryLocation: Output<String>

The secondary location of the storage account.

secondaryQueueEndpoint

val secondaryQueueEndpoint: Output<String>

The endpoint URL for queue storage in the secondary location.

secondaryQueueHost

val secondaryQueueHost: Output<String>

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

secondaryTableEndpoint

val secondaryTableEndpoint: Output<String>

The endpoint URL for table storage in the secondary location.

secondaryTableHost

val secondaryTableHost: Output<String>

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

secondaryWebEndpoint

val secondaryWebEndpoint: Output<String>

The endpoint URL for web storage in the secondary location.

secondaryWebHost

val secondaryWebHost: Output<String>

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

sftpEnabled

val sftpEnabled: Output<Boolean>?

Boolean, enable SFTP for the storage account

sharedAccessKeyEnabled

val sharedAccessKeyEnabled: Output<Boolean>?

shareProperties

val shareProperties: Output<AccountShareProperties>

A share_properties block as defined below.

staticWebsite

val staticWebsite: Output<AccountStaticWebsite>?

A static_website block as defined below.

tableEncryptionKeyType

val tableEncryptionKeyType: Output<String>?

The encryption type of the table service. Possible values are Service and Account. Changing this forces a new resource to be created. Default value is Service.