@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The Encryption Scope resource.
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01, 2025-01-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native storage [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class EncryptionScope extends pulumi.CustomResource {
/**
* Get an existing EncryptionScope resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): EncryptionScope;
/**
* Returns true if the given object is an instance of EncryptionScope. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is EncryptionScope;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Gets the creation date and time of the encryption scope in UTC.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
*/
readonly keyVaultProperties: pulumi.Output<outputs.storage.EncryptionScopeKeyVaultPropertiesResponse | undefined>;
/**
* Gets the last modification date and time of the encryption scope in UTC.
*/
readonly lastModifiedTime: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
*/
readonly requireInfrastructureEncryption: pulumi.Output<boolean | undefined>;
/**
* The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
*/
readonly source: pulumi.Output<string | undefined>;
/**
* The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.
*/
readonly state: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a EncryptionScope resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EncryptionScopeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a EncryptionScope resource.
*/
export interface EncryptionScopeArgs {
/**
* 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.
*/
accountName: pulumi.Input<string>;
/**
* 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.
*/
encryptionScopeName?: pulumi.Input<string>;
/**
* The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
*/
keyVaultProperties?: pulumi.Input<inputs.storage.EncryptionScopeKeyVaultPropertiesArgs>;
/**
* A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
*/
requireInfrastructureEncryption?: pulumi.Input<boolean>;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
*/
source?: pulumi.Input<string | enums.storage.EncryptionScopeSource>;
/**
* The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.
*/
state?: pulumi.Input<string | enums.storage.EncryptionScopeState>;
}