Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AzureBlobStorageData.
An AzureBlobStorageData resource can be a data source, but not a data sink.
An AzureBlobStorageData resource represents one Azure container. The storage
account determines theAzure
endpoint.
In an AzureBlobStorageData resource, a blobs's name is theAzure Blob
Storage blob's key
name.
Generated from protobuf messagegoogle.storagetransfer.v1.AzureBlobStorageData
Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, seeUser credentials.
↳ container
string
Required. The container to transfer from the Azure Storage account.
↳ path
string
Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
↳ credentials_secret
string
Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" }GoogleServiceAccountmust be grantedroles/secretmanager.secretAccessorfor the resource. SeeConfigure access to a source: Microsoft Azure Blob Storagefor more information. Ifcredentials_secretis specified, do not specifyazure_credentials. Format:projects/{project_number}/secrets/{secret_name}
Optional. Federated identity config of a user registered Azure application. Iffederated_identity_configis specified, do not specifyazure_credentialsorcredentials_secret.
getStorageAccount
Required. The name of the Azure Storage account.
Returns
Type
Description
string
setStorageAccount
Required. The name of the Azure Storage account.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAzureCredentials
Required. Input only. Credentials used to authenticate API requests to
Azure.
For information on our data retention policy for user credentials, seeUser credentials.
Required. The container to transfer from the Azure Storage account.
Returns
Type
Description
string
setContainer
Required. The container to transfer from the Azure Storage account.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPath
Root path to transfer objects.
Must be an empty string or full path name that ends with a '/'. This field
is treated as an object prefix. As such, it should generally not begin with
a '/'.
Returns
Type
Description
string
setPath
Root path to transfer objects.
Must be an empty string or full path name that ends with a '/'. This field
is treated as an object prefix. As such, it should generally not begin with
a '/'.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCredentialsSecret
Optional. The Resource name of a secret in Secret Manager.
The Azure SAS token must be stored in Secret Manager in JSON format:
{
"sas_token" : "SAS_TOKEN"
}GoogleServiceAccountmust
be grantedroles/secretmanager.secretAccessorfor the resource.
SeeConfigure access to a source: Microsoft Azure Blob Storagefor more information.
Ifcredentials_secretis specified, do not specifyazure_credentials.
Format:projects/{project_number}/secrets/{secret_name}
Returns
Type
Description
string
setCredentialsSecret
Optional. The Resource name of a secret in Secret Manager.
The Azure SAS token must be stored in Secret Manager in JSON format:
{
"sas_token" : "SAS_TOKEN"
}GoogleServiceAccountmust
be grantedroles/secretmanager.secretAccessorfor the resource.
SeeConfigure access to a source: Microsoft Azure Blob Storagefor more information.
Ifcredentials_secretis specified, do not specifyazure_credentials.
Format:projects/{project_number}/secrets/{secret_name}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFederatedIdentityConfig
Optional. Federated identity config of a user registered Azure application.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Storage Transfer V1 Client - Class AzureBlobStorageData (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData)\n- [2.2.0](/php/docs/reference/cloud-storage-transfer/2.2.0/V1.AzureBlobStorageData)\n- [2.1.1](/php/docs/reference/cloud-storage-transfer/2.1.1/V1.AzureBlobStorageData)\n- [2.0.2](/php/docs/reference/cloud-storage-transfer/2.0.2/V1.AzureBlobStorageData)\n- [1.5.0](/php/docs/reference/cloud-storage-transfer/1.5.0/V1.AzureBlobStorageData)\n- [1.4.5](/php/docs/reference/cloud-storage-transfer/1.4.5/V1.AzureBlobStorageData)\n- [1.3.1](/php/docs/reference/cloud-storage-transfer/1.3.1/V1.AzureBlobStorageData)\n- [1.2.0](/php/docs/reference/cloud-storage-transfer/1.2.0/V1.AzureBlobStorageData)\n- [1.1.1](/php/docs/reference/cloud-storage-transfer/1.1.1/V1.AzureBlobStorageData)\n- [1.0.6](/php/docs/reference/cloud-storage-transfer/1.0.6/V1.AzureBlobStorageData) \nReference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AzureBlobStorageData.\n\nAn AzureBlobStorageData resource can be a data source, but not a data sink.\n\nAn AzureBlobStorageData resource represents one Azure container. The storage\naccount determines the [Azure\nendpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints).\nIn an AzureBlobStorageData resource, a blobs's name is the [Azure Blob\nStorage blob's key\nname](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).\n\nGenerated from protobuf message `google.storagetransfer.v1.AzureBlobStorageData`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getStorageAccount\n\nRequired. The name of the Azure Storage account.\n\n### setStorageAccount\n\nRequired. The name of the Azure Storage account.\n\n### getAzureCredentials\n\nRequired. Input only. Credentials used to authenticate API requests to\nAzure.\n\nFor information on our data retention policy for user credentials, see\n[User credentials](/storage-transfer/docs/data-retention#user-credentials).\n\n### hasAzureCredentials\n\n### clearAzureCredentials\n\n### setAzureCredentials\n\nRequired. Input only. Credentials used to authenticate API requests to\nAzure.\n\nFor information on our data retention policy for user credentials, see\n[User credentials](/storage-transfer/docs/data-retention#user-credentials).\n\n### getContainer\n\nRequired. The container to transfer from the Azure Storage account.\n\n### setContainer\n\nRequired. The container to transfer from the Azure Storage account.\n\n### getPath\n\nRoot path to transfer objects.\n\nMust be an empty string or full path name that ends with a '/'. This field\nis treated as an object prefix. As such, it should generally not begin with\na '/'.\n\n### setPath\n\nRoot path to transfer objects.\n\nMust be an empty string or full path name that ends with a '/'. This field\nis treated as an object prefix. As such, it should generally not begin with\na '/'.\n\n### getCredentialsSecret\n\nOptional. The Resource name of a secret in Secret Manager.\n\nThe Azure SAS token must be stored in Secret Manager in JSON format:\n{\n\"sas_token\" : \"SAS_TOKEN\"\n}\n[GoogleServiceAccount](/php/docs/reference/cloud-storage-transfer/latest/V1.GoogleServiceAccount) must\nbe granted `roles/secretmanager.secretAccessor` for the resource.\nSee [Configure access to a source: Microsoft Azure Blob Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)\nfor more information.\nIf `credentials_secret` is specified, do not specify\n[azure_credentials](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__).\nFormat: `projects/{project_number}/secrets/{secret_name}`\n\n### setCredentialsSecret\n\nOptional. The Resource name of a secret in Secret Manager.\n\nThe Azure SAS token must be stored in Secret Manager in JSON format:\n{\n\"sas_token\" : \"SAS_TOKEN\"\n}\n[GoogleServiceAccount](/php/docs/reference/cloud-storage-transfer/latest/V1.GoogleServiceAccount) must\nbe granted `roles/secretmanager.secretAccessor` for the resource.\nSee [Configure access to a source: Microsoft Azure Blob Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)\nfor more information.\nIf `credentials_secret` is specified, do not specify\n[azure_credentials](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__).\nFormat: `projects/{project_number}/secrets/{secret_name}`\n\n### getFederatedIdentityConfig\n\nOptional. Federated identity config of a user registered Azure application.\n\nIf `federated_identity_config` is specified, do not specify\n[azure_credentials](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__)\nor\n[credentials_secret](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getCredentialsSecret__).\n\n### hasFederatedIdentityConfig\n\n### clearFederatedIdentityConfig\n\n### setFederatedIdentityConfig\n\nOptional. Federated identity config of a user registered Azure application.\n\nIf `federated_identity_config` is specified, do not specify\n[azure_credentials](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__)\nor\n[credentials_secret](/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getCredentialsSecret__)."]]
