pulumi-azure-native-kotlin/com.pulumi.azurenative.storage.kotlin/EncryptionScopeArgs

EncryptionScopeArgs

data class EncryptionScopeArgs(val accountName: Output<String>? = null, val encryptionScopeName: Output<String>? = null, val keyVaultProperties: Output<EncryptionScopeKeyVaultPropertiesArgs>? = null, val requireInfrastructureEncryption: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val source: Output<Either<String, EncryptionScopeSource>>? = null, val state: Output<Either<String, EncryptionScopeState>>? = null) : ConvertibleToJava<EncryptionScopeArgs>

The Encryption Scope resource. Uses Azure REST API version 2022-09-01. In version 1.x of the Azure Native provider, it used API version 2021-02-01. Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01, 2024-01-01.

Example Usage

StorageAccountPutEncryptionScope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var encryptionScope = new AzureNative.Storage.EncryptionScope("encryptionScope", new()
    {
        AccountName = "{storage-account-name}",
        EncryptionScopeName = "{encryption-scope-name}",
        ResourceGroupName = "resource-group-name",
    });
});
Content copied to clipboard
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewEncryptionScope(ctx, "encryptionScope", &storage.EncryptionScopeArgs{
			AccountName:         pulumi.String("{storage-account-name}"),
			EncryptionScopeName: pulumi.String("{encryption-scope-name}"),
			ResourceGroupName:   pulumi.String("resource-group-name"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.EncryptionScope;
import com.pulumi.azurenative.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 encryptionScope = new EncryptionScope("encryptionScope", EncryptionScopeArgs.builder()
            .accountName("{storage-account-name}")
            .encryptionScopeName("{encryption-scope-name}")
            .resourceGroupName("resource-group-name")
            .build());
    }
}
Content copied to clipboard

StorageAccountPutEncryptionScopeWithInfrastructureEncryption

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var encryptionScope = new AzureNative.Storage.EncryptionScope("encryptionScope", new()
    {
        AccountName = "{storage-account-name}",
        EncryptionScopeName = "{encryption-scope-name}",
        RequireInfrastructureEncryption = true,
        ResourceGroupName = "resource-group-name",
    });
});
Content copied to clipboard
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewEncryptionScope(ctx, "encryptionScope", &storage.EncryptionScopeArgs{
			AccountName:                     pulumi.String("{storage-account-name}"),
			EncryptionScopeName:             pulumi.String("{encryption-scope-name}"),
			RequireInfrastructureEncryption: pulumi.Bool(true),
			ResourceGroupName:               pulumi.String("resource-group-name"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.EncryptionScope;
import com.pulumi.azurenative.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 encryptionScope = new EncryptionScope("encryptionScope", EncryptionScopeArgs.builder()
            .accountName("{storage-account-name}")
            .encryptionScopeName("{encryption-scope-name}")
            .requireInfrastructureEncryption(true)
            .resourceGroupName("resource-group-name")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:storage:EncryptionScope {encryption-scope-name} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(accountName: Output<String>? = null, encryptionScopeName: Output<String>? = null, keyVaultProperties: Output<EncryptionScopeKeyVaultPropertiesArgs>? = null, requireInfrastructureEncryption: Output<Boolean>? = null, resourceGroupName: Output<String>? = null, source: Output<Either<String, EncryptionScopeSource>>? = null, state: Output<Either<String, EncryptionScopeState>>? = null)

Properties

Link copied to clipboard
val accountName: Output<String>? = null

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Link copied to clipboard
val encryptionScopeName: Output<String>? = null

The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.

Link copied to clipboard
val keyVaultProperties: Output<EncryptionScopeKeyVaultPropertiesArgs>? = null

The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.

Link copied to clipboard
val requireInfrastructureEncryption: Output<Boolean>? = null

A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group within the user's subscription. The name is case insensitive.

Link copied to clipboard
val source: Output<Either<String, EncryptionScopeSource>>? = null

The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.

Link copied to clipboard
val state: Output<Either<String, EncryptionScopeState>>? = null

The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

Functions

Link copied to clipboard
open override fun toJava(): EncryptionScopeArgs