Datastores - List Secrets

Get datastore secrets.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets?api-version=2023-10-01

URI Parameters

Name In Required Type Description
name
path True

string

Datastore name.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

Name of Azure Machine Learning workspace.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK DatastoreSecrets:

Success

Other Status Codes

ErrorResponse

Error

Examples

Get datastore secrets.

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/datastores/string/listSecrets?api-version=2023-10-01

Sample Response

{
  "secretsType": "AccountKey",
  "key": "string"
}

Definitions

Name Description
AccountKeyDatastoreSecrets

Datastore account key secrets.

CertificateDatastoreSecrets

Datastore certificate secrets.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

SasDatastoreSecrets

Datastore SAS secrets.

SecretsType

Enum to determine the datastore secrets type.

ServicePrincipalDatastoreSecrets

Datastore Service Principal secrets.

AccountKeyDatastoreSecrets

Datastore account key secrets.

Name Type Description
key

string

Storage account key.

secretsType string:

AccountKey

[Required] Credential type used to authentication with storage.

CertificateDatastoreSecrets

Datastore certificate secrets.

Name Type Description
certificate

string

Service principal certificate.

secretsType string:

Certificate

[Required] Credential type used to authentication with storage.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

SasDatastoreSecrets

Datastore SAS secrets.

Name Type Description
sasToken

string

Storage container SAS token.

secretsType string:

Sas

[Required] Credential type used to authentication with storage.

SecretsType

Enum to determine the datastore secrets type.

Name Type Description
AccountKey

string

Certificate

string

Sas

string

ServicePrincipal

string

ServicePrincipalDatastoreSecrets

Datastore Service Principal secrets.

Name Type Description
clientSecret

string

Service principal secret.

secretsType string:

ServicePrincipal

[Required] Credential type used to authentication with storage.