We recommend using Azure Native.
azure.storage.EncryptionScope
Explore with Pulumi AI
Manages a Storage Encryption Scope.
Note: Storage Encryption Scopes are in Preview more information can be found here.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
Identity = new Azure.Storage.Inputs.AccountIdentityArgs
{
Type = "SystemAssigned",
},
});
var exampleEncryptionScope = new Azure.Storage.EncryptionScope("exampleEncryptionScope", new()
{
StorageAccountId = exampleAccount.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 {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.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, "exampleEncryptionScope", &storage.EncryptionScopeArgs{
StorageAccountId: exampleAccount.ID(),
Source: pulumi.String("Microsoft.Storage"),
})
if err != nil {
return err
}
return nil
})
}
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 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("LRS")
.identity(AccountIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleEncryptionScope = new EncryptionScope("exampleEncryptionScope", EncryptionScopeArgs.builder()
.storageAccountId(exampleAccount.id())
.source("Microsoft.Storage")
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
account_tier="Standard",
account_replication_type="LRS",
identity=azure.storage.AccountIdentityArgs(
type="SystemAssigned",
))
example_encryption_scope = azure.storage.EncryptionScope("exampleEncryptionScope",
storage_account_id=example_account.id,
source="Microsoft.Storage")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
identity: {
type: "SystemAssigned",
},
});
const exampleEncryptionScope = new azure.storage.EncryptionScope("exampleEncryptionScope", {
storageAccountId: exampleAccount.id,
source: "Microsoft.Storage",
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleAccount:
type: azure:storage:Account
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
accountTier: Standard
accountReplicationType: LRS
identity:
type: SystemAssigned
exampleEncryptionScope:
type: azure:storage:EncryptionScope
properties:
storageAccountId: ${exampleAccount.id}
source: Microsoft.Storage
Create EncryptionScope Resource
new EncryptionScope(name: string, args: EncryptionScopeArgs, opts?: CustomResourceOptions);
@overload
def EncryptionScope(resource_name: 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)
@overload
def EncryptionScope(resource_name: str,
args: EncryptionScopeArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
andMicrosoft.Storage
.- Storage
Account stringId 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 boolRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- Key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- Storage
Account stringId 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 boolRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- Key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account StringId 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 BooleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault StringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account stringId 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 booleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage_
account_ strid 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_ boolrequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key_
vault_ strkey_ id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account StringId 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 BooleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault StringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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.
- Infrastructure
Encryption boolRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- Key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- Storage
Account stringId 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 boolRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- Key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- Storage
Account stringId 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 BooleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault StringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account StringId 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 booleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault stringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account stringId 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_ boolrequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key_
vault_ strkey_ id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage_
account_ strid 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 BooleanRequired Is a secondary layer of encryption with Platform Managed Keys for data applied? Changing this forces a new resource to be created.
- key
Vault StringKey Id The ID of the Key Vault Key. Required when
source
isMicrosoft.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
andMicrosoft.Storage
.- storage
Account StringId 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.