Azure Native v1.103.0, Jun 2 23

azure-native.storage.getEncryptionScope

Explore with Pulumi AI

Returns the properties for the specified encryption scope. API Version: 2021-02-01.

Using getEncryptionScope

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEncryptionScope(args: GetEncryptionScopeArgs, opts?: InvokeOptions): Promise<GetEncryptionScopeResult>
function getEncryptionScopeOutput(args: GetEncryptionScopeOutputArgs, opts?: InvokeOptions): Output<GetEncryptionScopeResult>

def get_encryption_scope(account_name: Optional[str] = None,
                         encryption_scope_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetEncryptionScopeResult
def get_encryption_scope_output(account_name: Optional[pulumi.Input[str]] = None,
                         encryption_scope_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetEncryptionScopeResult]

func LookupEncryptionScope(ctx *Context, args *LookupEncryptionScopeArgs, opts ...InvokeOption) (*LookupEncryptionScopeResult, error)
func LookupEncryptionScopeOutput(ctx *Context, args *LookupEncryptionScopeOutputArgs, opts ...InvokeOption) LookupEncryptionScopeResultOutput

> Note: This function is named LookupEncryptionScope in the Go SDK.

public static class GetEncryptionScope 
{
    public static Task<GetEncryptionScopeResult> InvokeAsync(GetEncryptionScopeArgs args, InvokeOptions? opts = null)
    public static Output<GetEncryptionScopeResult> Invoke(GetEncryptionScopeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEncryptionScopeResult> getEncryptionScope(GetEncryptionScopeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:storage:getEncryptionScope
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: 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.
EncryptionScopeName 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.
ResourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.

AccountName string: 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.
EncryptionScopeName 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.
ResourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.

accountName String: 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.
encryptionScopeName 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.
resourceGroupName String: The name of the resource group within the user's subscription. The name is case insensitive.

accountName string: 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.
encryptionScopeName 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.
resourceGroupName string: The name of the resource group within the user's subscription. The name is case insensitive.

account_name str: 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.
encryption_scope_name str: 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.
resource_group_name str: The name of the resource group within the user's subscription. The name is case insensitive.

accountName String: 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.
encryptionScopeName 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.
resourceGroupName String: The name of the resource group within the user's subscription. The name is case insensitive.

getEncryptionScope Result

The following output properties are available:

CreationTime string: Gets the creation date and time of the encryption scope in UTC.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastModifiedTime string: Gets the last modification date and time of the encryption scope in UTC.
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
KeyVaultProperties Pulumi.AzureNative.Storage.Outputs.EncryptionScopeKeyVaultPropertiesResponse: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
RequireInfrastructureEncryption bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
Source string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
State string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

CreationTime string: Gets the creation date and time of the encryption scope in UTC.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
LastModifiedTime string: Gets the last modification date and time of the encryption scope in UTC.
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
KeyVaultProperties EncryptionScopeKeyVaultPropertiesResponse: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
RequireInfrastructureEncryption bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
Source string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
State string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

creationTime String: Gets the creation date and time of the encryption scope in UTC.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedTime String: Gets the last modification date and time of the encryption scope in UTC.
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVaultProperties EncryptionScopeKeyVaultPropertiesResponse: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
requireInfrastructureEncryption Boolean: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
source String: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
state String: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

creationTime string: Gets the creation date and time of the encryption scope in UTC.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedTime string: Gets the last modification date and time of the encryption scope in UTC.
name string: The name of the resource
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVaultProperties EncryptionScopeKeyVaultPropertiesResponse: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
requireInfrastructureEncryption boolean: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
source string: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
state string: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

creation_time str: Gets the creation date and time of the encryption scope in UTC.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
last_modified_time str: Gets the last modification date and time of the encryption scope in UTC.
name str: The name of the resource
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
key_vault_properties EncryptionScopeKeyVaultPropertiesResponse: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
require_infrastructure_encryption bool: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
source str: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
state str: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

creationTime String: Gets the creation date and time of the encryption scope in UTC.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
lastModifiedTime String: Gets the last modification date and time of the encryption scope in UTC.
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
keyVaultProperties Property Map: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.
requireInfrastructureEncryption Boolean: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.
source String: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
state String: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

Supporting Types

EncryptionScopeKeyVaultPropertiesResponse

CurrentVersionedKeyIdentifier string: The object identifier of the current versioned Key Vault Key in use.
LastKeyRotationTimestamp string: Timestamp of last rotation of the Key Vault Key.
KeyUri string: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

CurrentVersionedKeyIdentifier string: The object identifier of the current versioned Key Vault Key in use.
LastKeyRotationTimestamp string: Timestamp of last rotation of the Key Vault Key.
KeyUri string: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

currentVersionedKeyIdentifier String: The object identifier of the current versioned Key Vault Key in use.
lastKeyRotationTimestamp String: Timestamp of last rotation of the Key Vault Key.
keyUri String: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

currentVersionedKeyIdentifier string: The object identifier of the current versioned Key Vault Key in use.
lastKeyRotationTimestamp string: Timestamp of last rotation of the Key Vault Key.
keyUri string: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

current_versioned_key_identifier str: The object identifier of the current versioned Key Vault Key in use.
last_key_rotation_timestamp str: Timestamp of last rotation of the Key Vault Key.
key_uri str: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

currentVersionedKeyIdentifier String: The object identifier of the current versioned Key Vault Key in use.
lastKeyRotationTimestamp String: Timestamp of last rotation of the Key Vault Key.
keyUri String: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0