Encryption Scopes - Get

Serviço:

Storage Resource Provider

Versão da API:

2024-01-01

Retorna as propriedades do escopo de criptografia especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}?api-version=2024-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres de comprimento e usar apenas números e letras minúsculas.
encryptionScopeName	path	True	string minLength: 3 maxLength: 63	O nome do escopo de criptografia dentro da conta de armazenamento especificada. Os nomes de escopo de criptografia devem ter entre 3 e 63 caracteres de comprimento e números de uso, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	O nome do grupo de recursos na assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	EncryptionScope	OK – Obter a operação de escopo de criptografia concluída com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

StorageAccountGetEncryptionScope

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/accountname/encryptionScopes/{encryption-scope-name}?api-version=2024-01-01

Java

/**
 * Samples for EncryptionScopes Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/
     * StorageAccountGetEncryptionScope.json
     */
    /**
     * Sample code: StorageAccountGetEncryptionScope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetEncryptionScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getEncryptionScopes().getWithResponse("resource-group-name",
            "accountname", "{encryption-scope-name}", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_encryption_scope.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.encryption_scopes.get(
        resource_group_name="resource-group-name",
        account_name="accountname",
        encryption_scope_name="{encryption-scope-name}",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetEncryptionScope.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetEncryptionScope.json
func ExampleEncryptionScopesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEncryptionScopesClient().Get(ctx, "resource-group-name", "accountname", "{encryption-scope-name}", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.EncryptionScope = armstorage.EncryptionScope{
	// 	Name: to.Ptr("{encyrption-scope-name}"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/encryptionScopes"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/accountname/encryptionScopes/{encryption-scope-name}"),
	// 	EncryptionScopeProperties: &armstorage.EncryptionScopeProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-16T02:42:41.763Z"); return t}()),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-16T02:42:41.763Z"); return t}()),
	// 		Source: to.Ptr(armstorage.EncryptionScopeSourceMicrosoftStorage),
	// 		State: to.Ptr(armstorage.EncryptionScopeStateEnabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Returns the properties for the specified encryption scope.
 *
 * @summary Returns the properties for the specified encryption scope.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetEncryptionScope.json
 */
async function storageAccountGetEncryptionScope() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "resource-group-name";
  const accountName = "accountname";
  const encryptionScopeName = "{encryption-scope-name}";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.encryptionScopes.get(
    resourceGroupName,
    accountName,
    encryptionScopeName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetEncryptionScope.json
// this example is just showing the usage of "EncryptionScopes_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "resource-group-name";
string accountName = "accountname";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);

// get the collection of this EncryptionScopeResource
EncryptionScopeCollection collection = storageAccount.GetEncryptionScopes();

// invoke the operation
string encryptionScopeName = "{encryption-scope-name}";
NullableResponse<EncryptionScopeResource> response = await collection.GetIfExistsAsync(encryptionScopeName);
EncryptionScopeResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EncryptionScopeData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/accountname/encryptionScopes/{encryption-scope-name}",
  "name": "{encyrption-scope-name}",
  "type": "Microsoft.Storage/storageAccounts/encryptionScopes",
  "properties": {
    "source": "Microsoft.Storage",
    "state": "Enabled",
    "creationTime": "2018-10-16T02:42:41.7633306Z",
    "lastModifiedTime": "2018-10-16T02:42:41.7633306Z"
  }
}

Definições

Nome	Description
EncryptionScope	O recurso escopo de criptografia.
EncryptionScopeKeyVaultProperties	As propriedades do cofre de chaves para o escopo de criptografia. Esse é um campo necessário se o atributo 'source' do escopo de criptografia estiver definido como 'Microsoft.KeyVault'.
EncryptionScopeSource	O provedor para o escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Storage, Microsoft.KeyVault.
EncryptionScopeState	O estado do escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Habilitado, Desabilitado.
ErrorResponse	Uma resposta de erro do provedor de recursos de armazenamento.
ErrorResponseBody	Contrato do corpo da resposta de erro.

EncryptionScope

Objeto

O recurso escopo de criptografia.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.creationTime	string (date-time)	Obtém a data e a hora de criação do escopo de criptografia em UTC.
properties.keyVaultProperties	EncryptionScopeKeyVaultProperties	As propriedades do cofre de chaves para o escopo de criptografia. Esse é um campo necessário se o atributo 'source' do escopo de criptografia estiver definido como 'Microsoft.KeyVault'.
properties.lastModifiedTime	string (date-time)	Obtém a data e a hora da última modificação do escopo de criptografia em UTC.
properties.requireInfrastructureEncryption	boolean	Um booliano que indica se o serviço aplica ou não uma camada secundária de criptografia com chaves gerenciadas pela plataforma para dados em repouso.
properties.source	EncryptionScopeSource	O provedor para o escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Storage, Microsoft.KeyVault.
properties.state	EncryptionScopeState	O estado do escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Habilitado, Desabilitado.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

EncryptionScopeKeyVaultProperties

Objeto

As propriedades do cofre de chaves para o escopo de criptografia. Esse é um campo necessário se o atributo 'source' do escopo de criptografia estiver definido como 'Microsoft.KeyVault'.

Nome	Tipo	Description
currentVersionedKeyIdentifier	string	O identificador de objeto da chave do Key Vault com versão atual em uso.
keyUri	string	O identificador de objeto para um objeto de chave do cofre de chaves. Quando aplicado, o escopo de criptografia usará a chave referenciada pelo identificador para habilitar o suporte à chave gerenciada pelo cliente nesse escopo de criptografia.
lastKeyRotationTimestamp	string (date-time)	Carimbo de data/hora da última rotação da Chave do Key Vault.

EncryptionScopeSource

Enumeração

O provedor para o escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Storage, Microsoft.KeyVault.

Valor	Description
Microsoft.KeyVault
Microsoft.Storage

EncryptionScopeState

Enumeração

O estado do escopo de criptografia. Valores possíveis (que não diferenciam maiúsculas de minúsculas): Habilitado, Desabilitado.

Valor	Description
Disabled
Enabled

ErrorResponse

Objeto

Uma resposta de erro do provedor de recursos de armazenamento.

Nome	Tipo	Description
error	ErrorResponseBody	Corpo da resposta de erro do Provedor de Recursos de Armazenamento do Azure.

ErrorResponseBody

Objeto

Contrato do corpo da resposta de erro.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.