1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. EncryptionScope

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.storage.EncryptionScope

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a Storage Encryption Scope.

    Note: Storage Encryption Scopes are in Preview more information can be found here.

    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: "examplesa",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleEncryptionScope = new azure.storage.EncryptionScope("example", {
        name: "microsoftmanaged",
        storageAccountId: exampleAccount.id,
        source: "Microsoft.Storage",
    });
    
    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="examplesa",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS",
        identity=azure.storage.AccountIdentityArgs(
            type="SystemAssigned",
        ))
    example_encryption_scope = azure.storage.EncryptionScope("example",
        name="microsoftmanaged",
        storage_account_id=example_account.id,
        source="Microsoft.Storage")
    
    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("examplesa"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    			Identity: &storage.AccountIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = storage.NewEncryptionScope(ctx, "example", &storage.EncryptionScopeArgs{
    			Name:             pulumi.String("microsoftmanaged"),
    			StorageAccountId: exampleAccount.ID(),
    			Source:           pulumi.String("Microsoft.Storage"),
    		})
    		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 = "examplesa",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            Identity = new Azure.Storage.Inputs.AccountIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleEncryptionScope = new Azure.Storage.EncryptionScope("example", new()
        {
            Name = "microsoftmanaged",
            StorageAccountId = exampleAccount.Id,
            Source = "Microsoft.Storage",
        });
    
    });
    
    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.inputs.AccountIdentityArgs;
    import com.pulumi.azure.storage.EncryptionScope;
    import com.pulumi.azure.storage.EncryptionScopeArgs;
    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("examplesa")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .identity(AccountIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleEncryptionScope = new EncryptionScope("exampleEncryptionScope", EncryptionScopeArgs.builder()
                .name("microsoftmanaged")
                .storageAccountId(exampleAccount.id())
                .source("Microsoft.Storage")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: examplesa
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountTier: Standard
          accountReplicationType: LRS
          identity:
            type: SystemAssigned
      exampleEncryptionScope:
        type: azure:storage:EncryptionScope
        name: example
        properties:
          name: microsoftmanaged
          storageAccountId: ${exampleAccount.id}
          source: Microsoft.Storage
    

    Create EncryptionScope Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EncryptionScope(name: string, args: EncryptionScopeArgs, opts?: CustomResourceOptions);
    @overload
    def EncryptionScope(resource_name: str,
                        args: EncryptionScopeArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def EncryptionScope(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        source: Optional[str] = None,
                        storage_account_id: Optional[str] = None,
                        infrastructure_encryption_required: Optional[bool] = None,
                        key_vault_key_id: Optional[str] = None,
                        name: Optional[str] = None)
    func NewEncryptionScope(ctx *Context, name string, args EncryptionScopeArgs, opts ...ResourceOption) (*EncryptionScope, error)
    public EncryptionScope(string name, EncryptionScopeArgs args, CustomResourceOptions? opts = null)
    public EncryptionScope(String name, EncryptionScopeArgs args)
    public EncryptionScope(String name, EncryptionScopeArgs args, CustomResourceOptions options)
    
    type: azure:storage:EncryptionScope
    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 EncryptionScopeArgs
    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 EncryptionScopeArgs
    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 EncryptionScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EncryptionScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EncryptionScopeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var encryptionScopeResource = new Azure.Storage.EncryptionScope("encryptionScopeResource", new()
    {
        Source = "string",
        StorageAccountId = "string",
        InfrastructureEncryptionRequired = false,
        KeyVaultKeyId = "string",
        Name = "string",
    });
    
    example, err := storage.NewEncryptionScope(ctx, "encryptionScopeResource", &storage.EncryptionScopeArgs{
    	Source:                           pulumi.String("string"),
    	StorageAccountId:                 pulumi.String("string"),
    	InfrastructureEncryptionRequired: pulumi.Bool(false),
    	KeyVaultKeyId:                    pulumi.String("string"),
    	Name:                             pulumi.String("string"),
    })
    
    var encryptionScopeResource = new EncryptionScope("encryptionScopeResource", EncryptionScopeArgs.builder()
        .source("string")
        .storageAccountId("string")
        .infrastructureEncryptionRequired(false)
        .keyVaultKeyId("string")
        .name("string")
        .build());
    
    encryption_scope_resource = azure.storage.EncryptionScope("encryptionScopeResource",
        source="string",
        storage_account_id="string",
        infrastructure_encryption_required=False,
        key_vault_key_id="string",
        name="string")
    
    const encryptionScopeResource = new azure.storage.EncryptionScope("encryptionScopeResource", {
        source: "string",
        storageAccountId: "string",
        infrastructureEncryptionRequired: false,
        keyVaultKeyId: "string",
        name: "string",
    });
    
    type: azure:storage:EncryptionScope
    properties:
        infrastructureEncryptionRequired: false
        keyVaultKeyId: string
        name: string
        source: string
        storageAccountId: string
    

    EncryptionScope 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 EncryptionScope resource accepts the following input properties:

    Source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    StorageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    InfrastructureEncryptionRequired bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    Name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    Source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    StorageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    InfrastructureEncryptionRequired bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    Name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source String
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId String
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired Boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name String
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source str
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storage_account_id str
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructure_encryption_required bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    key_vault_key_id str
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name str
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source String
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId String
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired Boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name String
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EncryptionScope resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EncryptionScope Resource

    Get an existing EncryptionScope 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?: EncryptionScopeState, opts?: CustomResourceOptions): EncryptionScope
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            infrastructure_encryption_required: Optional[bool] = None,
            key_vault_key_id: Optional[str] = None,
            name: Optional[str] = None,
            source: Optional[str] = None,
            storage_account_id: Optional[str] = None) -> EncryptionScope
    func GetEncryptionScope(ctx *Context, name string, id IDInput, state *EncryptionScopeState, opts ...ResourceOption) (*EncryptionScope, error)
    public static EncryptionScope Get(string name, Input<string> id, EncryptionScopeState? state, CustomResourceOptions? opts = null)
    public static EncryptionScope get(String name, Output<String> id, EncryptionScopeState 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.
    The following state arguments are supported:
    InfrastructureEncryptionRequired bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    Name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    Source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    StorageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    InfrastructureEncryptionRequired bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    KeyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    Name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    Source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    StorageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired Boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name String
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source String
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId String
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId string
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name string
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source string
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId string
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructure_encryption_required bool
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    key_vault_key_id str
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name str
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source str
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storage_account_id str
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.
    infrastructureEncryptionRequired Boolean
    Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
    keyVaultKeyId String
    The ID of the Key Vault Key. Required when source is Microsoft.KeyVault.
    name String
    The name which should be used for this Storage Encryption Scope. Changing this forces a new Storage Encryption Scope to be created.
    source String
    The source of the Storage Encryption Scope. Possible values are Microsoft.KeyVault and Microsoft.Storage.
    storageAccountId String
    The ID of the Storage Account where this Storage Encryption Scope is created. Changing this forces a new Storage Encryption Scope to be created.

    Import

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

    $ pulumi import azure:storage/encryptionScope:EncryptionScope example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Storage/storageAccounts/account1/encryptionScopes/scope1
    

    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi