# Google Cloud Storage Transfer V1 Client - Class AzureBlobStorageData (2.4.0)

2.4.0 (latest) 2.3.2 2.2.1 2.1.1 2.0.2 1.5.0 1.4.5 1.3.1 1.2.0 1.1.1 1.0.6 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 the [Azure
endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints).
In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob
Storage blob's key
name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).

Generated from protobuf message `google.storagetransfer.v1.AzureBlobStorageData`

## Namespace

Google \\ Cloud \\ StorageTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ storage_account` | `string` Required. The name of the Azure Storage account. |
| `↳ azure_credentials` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureCredentials` Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](https://docs.cloud.google.com/storage-transfer/docs/data-retention#user-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" } [GoogleServiceAccount](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GoogleServiceAccount) must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify [azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__). Format: `projects/{project_number}/secrets/{secret_name}` |
| `↳ federated_identity_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData.FederatedIdentityConfig` Optional. Federated identity config of a user registered Azure application. If `federated_identity_config` is specified, do not specify [azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__) or [credentials_secret](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getCredentialsSecret__). |

### 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, see
[User credentials](https://docs.cloud.google.com/storage-transfer/docs/data-retention#user-credentials).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureCredentials|null` |   |

### hasAzureCredentials

### clearAzureCredentials

### setAzureCredentials

Required. Input only. Credentials used to authenticate API requests to
Azure.

For information on our data retention policy for user credentials, see
[User credentials](https://docs.cloud.google.com/storage-transfer/docs/data-retention#user-credentials).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureCredentials` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getContainer

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"
}
[GoogleServiceAccount](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GoogleServiceAccount) must
be granted `roles/secretmanager.secretAccessor` for the resource.
See [Configure access to a source: Microsoft Azure Blob Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
for more information.
If `credentials_secret` is specified, do not specify
[azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__).
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"
}
[GoogleServiceAccount](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.GoogleServiceAccount) must
be granted `roles/secretmanager.secretAccessor` for the resource.
See [Configure access to a source: Microsoft Azure Blob Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
for more information.
If `credentials_secret` is specified, do not specify
[azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__).
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.

If `federated_identity_config` is specified, do not specify
[azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__)
or
[credentials_secret](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getCredentialsSecret__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData.FederatedIdentityConfig|null` |   |

### hasFederatedIdentityConfig

### clearFederatedIdentityConfig

### setFederatedIdentityConfig

Optional. Federated identity config of a user registered Azure application.

If `federated_identity_config` is specified, do not specify
[azure_credentials](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getAzureCredentials__)
or
[credentials_secret](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData#_Google_Cloud_StorageTransfer_V1_AzureBlobStorageData__getCredentialsSecret__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AzureBlobStorageData.FederatedIdentityConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |