We recommend using Azure Native.
azure.storage.Container
Explore with Pulumi AI
Manages a Container within an Azure Storage Account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "examplestoraccount",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
tags: {
environment: "staging",
},
});
const exampleContainer = new azure.storage.Container("example", {
name: "vhds",
storageAccountName: exampleAccount.name,
containerAccessType: "private",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_account = azure.storage.Account("example",
name="examplestoraccount",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS",
tags={
"environment": "staging",
})
example_container = azure.storage.Container("example",
name="vhds",
storage_account_name=example_account.name,
container_access_type="private")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("examplestoraccount"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
Tags: pulumi.StringMap{
"environment": pulumi.String("staging"),
},
})
if err != nil {
return err
}
_, err = storage.NewContainer(ctx, "example", &storage.ContainerArgs{
Name: pulumi.String("vhds"),
StorageAccountName: exampleAccount.Name,
ContainerAccessType: pulumi.String("private"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "examplestoraccount",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
Tags =
{
{ "environment", "staging" },
},
});
var exampleContainer = new Azure.Storage.Container("example", new()
{
Name = "vhds",
StorageAccountName = exampleAccount.Name,
ContainerAccessType = "private",
});
});
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 com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("examplestoraccount")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.tags(Map.of("environment", "staging"))
.build());
var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
.name("vhds")
.storageAccountName(exampleAccount.name())
.containerAccessType("private")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: examplestoraccount
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
tags:
environment: staging
exampleContainer:
type: azure:storage:Container
name: example
properties:
name: vhds
storageAccountName: ${exampleAccount.name}
containerAccessType: private
Create Container Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Container(name: string, args: ContainerArgs, opts?: CustomResourceOptions);
@overload
def Container(resource_name: str,
args: ContainerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Container(resource_name: str,
opts: Optional[ResourceOptions] = None,
storage_account_name: Optional[str] = None,
container_access_type: Optional[str] = None,
default_encryption_scope: Optional[str] = None,
encryption_scope_override_enabled: Optional[bool] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None)
func NewContainer(ctx *Context, name string, args ContainerArgs, opts ...ResourceOption) (*Container, error)
public Container(string name, ContainerArgs args, CustomResourceOptions? opts = null)
public Container(String name, ContainerArgs args)
public Container(String name, ContainerArgs args, CustomResourceOptions options)
type: azure:storage:Container
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ContainerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ContainerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ContainerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ContainerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ContainerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var containerResource = new Azure.Storage.Container("containerResource", new()
{
StorageAccountName = "string",
ContainerAccessType = "string",
DefaultEncryptionScope = "string",
EncryptionScopeOverrideEnabled = false,
Metadata =
{
{ "string", "string" },
},
Name = "string",
});
example, err := storage.NewContainer(ctx, "containerResource", &storage.ContainerArgs{
StorageAccountName: pulumi.String("string"),
ContainerAccessType: pulumi.String("string"),
DefaultEncryptionScope: pulumi.String("string"),
EncryptionScopeOverrideEnabled: pulumi.Bool(false),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var containerResource = new Container("containerResource", ContainerArgs.builder()
.storageAccountName("string")
.containerAccessType("string")
.defaultEncryptionScope("string")
.encryptionScopeOverrideEnabled(false)
.metadata(Map.of("string", "string"))
.name("string")
.build());
container_resource = azure.storage.Container("containerResource",
storage_account_name="string",
container_access_type="string",
default_encryption_scope="string",
encryption_scope_override_enabled=False,
metadata={
"string": "string",
},
name="string")
const containerResource = new azure.storage.Container("containerResource", {
storageAccountName: "string",
containerAccessType: "string",
defaultEncryptionScope: "string",
encryptionScopeOverrideEnabled: false,
metadata: {
string: "string",
},
name: "string",
});
type: azure:storage:Container
properties:
containerAccessType: string
defaultEncryptionScope: string
encryptionScopeOverrideEnabled: false
metadata:
string: string
name: string
storageAccountName: string
Container Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Container resource accepts the following input properties:
- Storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- Container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- Default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- Encryption
Scope boolOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - Metadata Dictionary<string, string>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- Name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- Storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- Container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- Default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- Encryption
Scope boolOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - Metadata map[string]string
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- Name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- storage
Account StringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access StringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption StringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope BooleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - metadata Map<String,String>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name String
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope booleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - metadata {[key: string]: string}
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- storage_
account_ strname - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container_
access_ strtype The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default_
encryption_ strscope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption_
scope_ booloverride_ enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - metadata Mapping[str, str]
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name str
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- storage
Account StringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access StringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption StringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope BooleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - metadata Map<String>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name String
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the Container resource produces the following output properties:
- Has
Immutability boolPolicy - Is there an Immutability Policy configured on this Storage Container?
- Has
Legal boolHold - Is there a Legal Hold configured on this Storage Container?
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Manager stringId - The Resource Manager ID of this Storage Container.
- Has
Immutability boolPolicy - Is there an Immutability Policy configured on this Storage Container?
- Has
Legal boolHold - Is there a Legal Hold configured on this Storage Container?
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Manager stringId - The Resource Manager ID of this Storage Container.
- has
Immutability BooleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal BooleanHold - Is there a Legal Hold configured on this Storage Container?
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Manager StringId - The Resource Manager ID of this Storage Container.
- has
Immutability booleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal booleanHold - Is there a Legal Hold configured on this Storage Container?
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Manager stringId - The Resource Manager ID of this Storage Container.
- has_
immutability_ boolpolicy - Is there an Immutability Policy configured on this Storage Container?
- has_
legal_ boolhold - Is there a Legal Hold configured on this Storage Container?
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
manager_ strid - The Resource Manager ID of this Storage Container.
- has
Immutability BooleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal BooleanHold - Is there a Legal Hold configured on this Storage Container?
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Manager StringId - The Resource Manager ID of this Storage Container.
Look up Existing Container Resource
Get an existing Container resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ContainerState, opts?: CustomResourceOptions): Container
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
container_access_type: Optional[str] = None,
default_encryption_scope: Optional[str] = None,
encryption_scope_override_enabled: Optional[bool] = None,
has_immutability_policy: Optional[bool] = None,
has_legal_hold: Optional[bool] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
resource_manager_id: Optional[str] = None,
storage_account_name: Optional[str] = None) -> Container
func GetContainer(ctx *Context, name string, id IDInput, state *ContainerState, opts ...ResourceOption) (*Container, error)
public static Container Get(string name, Input<string> id, ContainerState? state, CustomResourceOptions? opts = null)
public static Container get(String name, Output<String> id, ContainerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- Default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- Encryption
Scope boolOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - Has
Immutability boolPolicy - Is there an Immutability Policy configured on this Storage Container?
- Has
Legal boolHold - Is there a Legal Hold configured on this Storage Container?
- Metadata Dictionary<string, string>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- Name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- Resource
Manager stringId - The Resource Manager ID of this Storage Container.
- Storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- Container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- Default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- Encryption
Scope boolOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - Has
Immutability boolPolicy - Is there an Immutability Policy configured on this Storage Container?
- Has
Legal boolHold - Is there a Legal Hold configured on this Storage Container?
- Metadata map[string]string
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- Name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- Resource
Manager stringId - The Resource Manager ID of this Storage Container.
- Storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access StringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption StringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope BooleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - has
Immutability BooleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal BooleanHold - Is there a Legal Hold configured on this Storage Container?
- metadata Map<String,String>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name String
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- resource
Manager StringId - The Resource Manager ID of this Storage Container.
- storage
Account StringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access stringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption stringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope booleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - has
Immutability booleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal booleanHold - Is there a Legal Hold configured on this Storage Container?
- metadata {[key: string]: string}
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name string
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- resource
Manager stringId - The Resource Manager ID of this Storage Container.
- storage
Account stringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container_
access_ strtype The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default_
encryption_ strscope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption_
scope_ booloverride_ enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - has_
immutability_ boolpolicy - Is there an Immutability Policy configured on this Storage Container?
- has_
legal_ boolhold - Is there a Legal Hold configured on this Storage Container?
- metadata Mapping[str, str]
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name str
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- resource_
manager_ strid - The Resource Manager ID of this Storage Container.
- storage_
account_ strname - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
- container
Access StringType The Access Level configured for this Container. Possible values are
blob
,container
orprivate
. Defaults toprivate
.Note When updating
container_access_type
for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.- default
Encryption StringScope - The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
- encryption
Scope BooleanOverride Enabled - Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying
default_encryption_scope
. Defaults totrue
. Changing this forces a new resource to be created. - has
Immutability BooleanPolicy - Is there an Immutability Policy configured on this Storage Container?
- has
Legal BooleanHold - Is there a Legal Hold configured on this Storage Container?
- metadata Map<String>
- A mapping of MetaData for this Container. All metadata keys should be lowercase.
- name String
- The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
- resource
Manager StringId - The Resource Manager ID of this Storage Container.
- storage
Account StringName - The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
Import
Storage Containers can be imported using the resource id
, e.g.
$ pulumi import azure:storage/container:Container container1 https://example.blob.core.windows.net/container
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.