Encryption Scopes - Get

Dienst:

Storage Resource Provider

API-Version:

2024-01-01

Gibt die Eigenschaften für den angegebenen Verschlüsselungsbereich zurück.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Die Namen von Speicherkonten müssen zwischen 3 und 24 Zeichen lang sein und nur Zahlen und Kleinbuchstaben verwenden.
encryptionScopeName	path	True	string minLength: 3 maxLength: 63	Der Name des Verschlüsselungsbereichs innerhalb des angegebenen Speicherkontos. Verschlüsselungsbereichsnamen müssen zwischen 3 und 63 Zeichen lang sein und Zahlen, Nur Kleinbuchstaben und Gedankenstriche (-) verwenden. Jedem Gedankenstrich (-) Zeichen muss unmittelbar ein Buchstabe oder eine Zahl vorangestellt und gefolgt werden.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	EncryptionScope	OK - Abrufen des Verschlüsselungsbereichsvorgangs erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

StorageAccountGetEncryptionScope

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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"
  }
}

Definitionen

Name	Beschreibung
EncryptionScope	Die Verschlüsselungsbereichsressource.
EncryptionScopeKeyVaultProperties	Die Schlüsseltresoreigenschaften für den Verschlüsselungsbereich. Dies ist ein pflichtfeld, wenn das Attribut des Verschlüsselungsbereichs "source" auf "Microsoft.KeyVault" festgelegt ist.
EncryptionScopeSource	Der Anbieter für den Verschlüsselungsbereich. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Storage, Microsoft.KeyVault.
EncryptionScopeState	Der Status des Verschlüsselungsbereichs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Aktiviert, deaktiviert.
ErrorResponse	Eine Fehlerantwort des Speicherressourcenanbieters.
ErrorResponseBody	Fehlerantworttext-Vertrag.

EncryptionScope

Objekt

Die Verschlüsselungsbereichsressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.creationTime	string (date-time)	Ruft das Erstellungsdatum und die Uhrzeit des Verschlüsselungsbereichs in UTC ab.
properties.keyVaultProperties	EncryptionScopeKeyVaultProperties	Die Schlüsseltresoreigenschaften für den Verschlüsselungsbereich. Dies ist ein pflichtfeld, wenn das Attribut des Verschlüsselungsbereichs "source" auf "Microsoft.KeyVault" festgelegt ist.
properties.lastModifiedTime	string (date-time)	Ruft das Datum und die Uhrzeit der letzten Änderung des Verschlüsselungsbereichs in UTC ab.
properties.requireInfrastructureEncryption	boolean	Ein boolescher Wert, der angibt, ob der Dienst eine sekundäre Verschlüsselungsebene mit plattformverwalteten Schlüsseln für ruhende Daten anwendet.
properties.source	EncryptionScopeSource	Der Anbieter für den Verschlüsselungsbereich. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Storage, Microsoft.KeyVault.
properties.state	EncryptionScopeState	Der Status des Verschlüsselungsbereichs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Aktiviert, deaktiviert.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

EncryptionScopeKeyVaultProperties

Objekt

Die Schlüsseltresoreigenschaften für den Verschlüsselungsbereich. Dies ist ein pflichtfeld, wenn das Attribut des Verschlüsselungsbereichs "source" auf "Microsoft.KeyVault" festgelegt ist.

Name	Typ	Beschreibung
currentVersionedKeyIdentifier	string	Der Objektbezeichner des aktuell versionsierten Key Vault-Schlüssels.
keyUri	string	Der Objektbezeichner für ein Key Vault-Schlüsselobjekt. Bei Anwendung verwendet der Verschlüsselungsbereich den Schlüssel, auf den der Bezeichner verweist, um die Unterstützung von vom Kunden verwalteten Schlüsseln für diesen Verschlüsselungsbereich zu ermöglichen.
lastKeyRotationTimestamp	string (date-time)	Zeitstempel der letzten Drehung des Key Vault-Schlüssels.

EncryptionScopeSource

Enumeration

Der Anbieter für den Verschlüsselungsbereich. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Storage, Microsoft.KeyVault.

Wert	Beschreibung
Microsoft.KeyVault
Microsoft.Storage

EncryptionScopeState

Enumeration

Der Status des Verschlüsselungsbereichs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Aktiviert, deaktiviert.

Wert	Beschreibung
Disabled
Enabled

ErrorResponse

Objekt

Eine Fehlerantwort des Speicherressourcenanbieters.

Name	Typ	Beschreibung
error	ErrorResponseBody	Fehlerantworttext des Azure Storage-Ressourcenanbieters.

ErrorResponseBody

Objekt

Fehlerantworttext-Vertrag.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.