Registry Data References - Get Blob Reference SAS

Reference

Service:: Machine Learning

API Version:: 2023-10-01

Get blob reference SAS Uri.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{name}/versions/{version}?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Data reference name. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$`
registryName	path	True	string	Name of Azure Machine Learning registry. This is case-insensitive Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{2,32}$`
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.
version	path	True	string	Version identifier.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
assetId	string	Id of the asset to be accessed
blobUri	string	Blob uri of the asset to be accessed

Responses

Name	Type	Description
200 OK	GetBlobReferenceSASResponseDto	Success
Other Status Codes	ErrorResponse	Error

Examples

GetBlobReferenceSAS Data Reference.

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/registries/registryName/datareferences/string/versions/string?api-version=2023-10-01

{
  "assetId": "string",
  "blobUri": "https://www.contoso.com/example"
}

Sample response

Status code:: 200

{
  "blobReferenceForConsumption": {
    "blobUri": "https://www.contoso.com/example",
    "storageAccountArmId": "string",
    "credential": {
      "credentialType": "NoCredentials"
    }
  }
}

Definitions

Name	Description
AnonymousAccessCredential	Access credential with no credentials
DataReferenceCredentialType	Enum to determine the DataReference credentials type.
DockerCredential	Credential for docker with username and password
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GetBlobReferenceForConsumptionDto
GetBlobReferenceSASRequestDto	BlobReferenceSASRequest for getBlobReferenceSAS API
GetBlobReferenceSASResponseDto	BlobReferenceSASResponse for getBlobReferenceSAS API
ManagedIdentityCredential	Credential for user managed identity
SASCredential	Access with full SAS uri

AnonymousAccessCredential

Access credential with no credentials

Name	Type	Description
credentialType	string: NoCredentials	[Required] Credential type used to authentication with storage.

DataReferenceCredentialType

Enum to determine the DataReference credentials type.

Name	Type	Description
DockerCredentials	string
ManagedIdentity	string
NoCredentials	string
SAS	string

DockerCredential

Credential for docker with username and password

Name	Type	Description
credentialType	string: DockerCredentials	[Required] Credential type used to authentication with storage.
password	string	DockerCredential user password
userName	string	DockerCredential user name

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.

GetBlobReferenceForConsumptionDto

Name	Type	Description
blobUri	string	Blob uri, example: https://blob.windows.core.net/Container/Path
credential	DataReferenceCredential: AnonymousAccessCredential DockerCredential ManagedIdentityCredential SASCredential	Credential info to access storage account
storageAccountArmId	string	The ARM id of the storage account

GetBlobReferenceSASRequestDto

BlobReferenceSASRequest for getBlobReferenceSAS API

Name	Type	Description
assetId	string	Id of the asset to be accessed
blobUri	string	Blob uri of the asset to be accessed

GetBlobReferenceSASResponseDto

BlobReferenceSASResponse for getBlobReferenceSAS API

Name	Type	Description
blobReferenceForConsumption	GetBlobReferenceForConsumptionDto	Blob reference for consumption details

ManagedIdentityCredential

Credential for user managed identity

Name	Type	Description
credentialType	string: ManagedIdentity	[Required] Credential type used to authentication with storage.
managedIdentityType	string	ManagedIdentityCredential identity type
userManagedIdentityClientId	string	ClientId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.
userManagedIdentityPrincipalId	string	PrincipalId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.
userManagedIdentityResourceId	string	Full arm scope for the Id. For ManagedIdentityType = SystemManaged, this field is null.
userManagedIdentityTenantId	string	TenantId for the UAMI. For ManagedIdentityType = SystemManaged, this field is null.

SASCredential

Access with full SAS uri

Name	Type	Description
credentialType	string: SAS	[Required] Credential type used to authentication with storage.
sasUri	string	Full SAS Uri, including the storage, container/blob path and SAS token

Share via