Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::AzureBlobStorageData (v1.0.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::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. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#azure_credentials

def azure_credentials() -> ::Google::Cloud::StorageTransfer::V1::AzureCredentials

Returns

(::Google::Cloud::StorageTransfer::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.

#azure_credentials=

def azure_credentials=(value) -> ::Google::Cloud::StorageTransfer::V1::AzureCredentials

Parameter

value (::Google::Cloud::StorageTransfer::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.

Returns

(::Google::Cloud::StorageTransfer::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.

#container

def container() -> ::String

Returns

(::String) — Required. The container to transfer from the Azure Storage account.

#container=

def container=(value) -> ::String

Parameter

value (::String) — Required. The container to transfer from the Azure Storage account.

Returns

(::String) — Required. The container to transfer from the Azure Storage account.

#credentials_secret

def credentials_secret() -> ::String

Returns

(::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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Microsoft Azure Blob Storage for more information.

If credentials_secret is specified, do not specify azure_credentials.

This feature is in preview.

Format: projects/{project_number}/secrets/{secret_name}

#credentials_secret=

def credentials_secret=(value) -> ::String

Parameter

value (::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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Microsoft Azure Blob Storage for more information.

If credentials_secret is specified, do not specify azure_credentials.

This feature is in preview.

Format: projects/{project_number}/secrets/{secret_name}

Returns

(::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 must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Microsoft Azure Blob Storage for more information.

If credentials_secret is specified, do not specify azure_credentials.

This feature is in preview.

Format: projects/{project_number}/secrets/{secret_name}

#path

def path() -> ::String

Returns

(::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 '/'.

#path=

def path=(value) -> ::String

Parameter

value (::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 '/'.

Returns

(::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 '/'.

#storage_account

def storage_account() -> ::String

Returns

(::String) — Required. The name of the Azure Storage account.

#storage_account=

def storage_account=(value) -> ::String

Parameter

value (::String) — Required. The name of the Azure Storage account.

Returns

(::String) — Required. The name of the Azure Storage account.