Encryption Scopes - Get

Service:

Azure AI Services

API Version:

2024-10-01

Gets the specified EncryptionScope associated with the Cognitive Services account.

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	The name of Cognitive Services account.
encryptionScopeName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	The name of the encryptionScope associated with the Cognitive Services Account
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	EncryptionScope	OK -- Get the EncryptionScopes properties successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

GetEncryptionScope

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName?api-version=2024-10-01

Java

/**
 * Samples for EncryptionScopes Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * GetEncryptionScope.json
     */
    /**
     * Sample code: GetEncryptionScope.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        getEncryptionScope(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.encryptionScopes().getWithResponse("resourceGroupName", "accountName", "encryptionScopeName",
            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.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python 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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.encryption_scopes.get(
        resource_group_name="resourceGroupName",
        account_name="accountName",
        encryption_scope_name="encryptionScopeName",
    )
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.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 armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.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 := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEncryptionScopesClient().Get(ctx, "resourceGroupName", "accountName", "encryptionScopeName", 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 = armcognitiveservices.EncryptionScope{
	// 	Name: to.Ptr("encryptionScopeName"),
	// 	Type: to.Ptr("Microsoft.CognitiveServices/accounts/encryptionScopes"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName"),
	// 	Etag: to.Ptr("\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armcognitiveservices.EncryptionScopeProperties{
	// 		KeySource: to.Ptr(armcognitiveservices.KeySourceMicrosoftKeyVault),
	// 		KeyVaultProperties: &armcognitiveservices.KeyVaultProperties{
	// 			IdentityClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			KeyName: to.Ptr("DevKeyWestUS2"),
	// 			KeyVaultURI: to.Ptr("https://devkvwestus2.vault.azure.net/"),
	// 			KeyVersion: to.Ptr("9f85549d7bf14ff4bf178c10d3bdca95"),
	// 		},
	// 		ProvisioningState: to.Ptr(armcognitiveservices.EncryptionScopeProvisioningStateSucceeded),
	// 		State: to.Ptr(armcognitiveservices.EncryptionScopeStateEnabled),
	// 	},
	// 	SystemData: &armcognitiveservices.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-06-08T06:35:08.066Z"); return t}()),
	// 		CreatedBy: to.Ptr("xxx@microsoft.com"),
	// 		CreatedByType: to.Ptr(armcognitiveservices.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-06-08T06:35:08.066Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("xxx@microsoft.com"),
	// 		LastModifiedByType: to.Ptr(armcognitiveservices.CreatedByTypeUser),
	// 	},
	// }
}

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 { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the specified EncryptionScope associated with the Cognitive Services account.
 *
 * @summary Gets the specified EncryptionScope associated with the Cognitive Services account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.json
 */
async function getEncryptionScope() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const encryptionScopeName = "encryptionScopeName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(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.CognitiveServices.Models;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/GetEncryptionScope.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 CognitiveServicesEncryptionScopeResource created on azure
// for more information of creating CognitiveServicesEncryptionScopeResource, please refer to the document of CognitiveServicesEncryptionScopeResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
string encryptionScopeName = "encryptionScopeName";
ResourceIdentifier cognitiveServicesEncryptionScopeResourceId = CognitiveServicesEncryptionScopeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, encryptionScopeName);
CognitiveServicesEncryptionScopeResource cognitiveServicesEncryptionScope = client.GetCognitiveServicesEncryptionScopeResource(cognitiveServicesEncryptionScopeResourceId);

// invoke the operation
CognitiveServicesEncryptionScopeResource result = await cognitiveServicesEncryptionScope.GetAsync();

// 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
CognitiveServicesEncryptionScopeData 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

Sample response

Status code:

200

{
  "name": "encryptionScopeName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/encryptionScopes/encryptionScopeName",
  "type": "Microsoft.CognitiveServices/accounts/encryptionScopes",
  "systemData": {
    "createdBy": "xxx@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-06-08T06:35:08.0662558Z",
    "lastModifiedBy": "xxx@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-06-08T06:35:08.0662558Z"
  },
  "etag": "\"00000000-0000-0000-0000-000000000000\"",
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Enabled",
    "keySource": "Microsoft.KeyVault",
    "keyVaultProperties": {
      "keyName": "DevKeyWestUS2",
      "keyVersion": "9f85549d7bf14ff4bf178c10d3bdca95",
      "keyVaultUri": "https://devkvwestus2.vault.azure.net/",
      "identityClientId": "00000000-0000-0000-0000-000000000000"
    }
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
EncryptionScope	Cognitive Services EncryptionScope
EncryptionScopeProperties	Properties to EncryptionScope
EncryptionScopeProvisioningState	Gets the status of the resource at the time the operation was called.
EncryptionScopeState	The encryptionScope state.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
keySource	Enumerates the possible value of keySource for Encryption
KeyVaultProperties	Properties to configure keyVault Properties
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EncryptionScope

Object

Cognitive Services EncryptionScope

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	EncryptionScopeProperties	Properties of Cognitive Services EncryptionScope.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

EncryptionScopeProperties

Object

Properties to EncryptionScope

Name	Type	Default value	Description
keySource	keySource	Microsoft.KeyVault	Enumerates the possible value of keySource for Encryption
keyVaultProperties	KeyVaultProperties		Properties of KeyVault
provisioningState	EncryptionScopeProvisioningState		Gets the status of the resource at the time the operation was called.
state	EncryptionScopeState		The encryptionScope state.

EncryptionScopeProvisioningState

Enumeration

Gets the status of the resource at the time the operation was called.

Value	Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
Canceled

EncryptionScopeState

Enumeration

The encryptionScope state.

Value	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

keySource

Enumeration

Enumerates the possible value of keySource for Encryption

Value	Description
Microsoft.CognitiveServices
Microsoft.KeyVault

KeyVaultProperties

Object

Properties to configure keyVault Properties

Name	Type	Description
identityClientId	string
keyName	string	Name of the Key from KeyVault
keyVaultUri	string	Uri of KeyVault
keyVersion	string	Version of the Key from KeyVault

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.