Class: Google::Cloud::StorageTransfer::V1::AzureBlobStorageData

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

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.

Defined Under Namespace

Classes: FederatedIdentityConfig

Instance Attribute Summary collapse

Instance Attribute Details

#azure_credentials ⇒ ::Google::Cloud::StorageTransfer::V1::AzureCredentials

Returns 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:



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#container ⇒ ::String

Returns Required. The container to transfer from the Azure Storage account.

Returns:

  • (::String) —

    Required. The container to transfer from the Azure Storage account.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#credentials_secret ⇒ ::String

Returns 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.

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.

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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#federated_identity_config ⇒ ::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData::FederatedIdentityConfig

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

If federated_identity_config is specified, do not specify azure_credentials or credentials_secret.

Returns:



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#path ⇒ ::String

Returns 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 '/'.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#storage_account ⇒ ::String

Returns Required. The name of the Azure Storage account.

Returns:

  • (::String) —

    Required. The name of the Azure Storage account.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 370

class AzureBlobStorageData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The identity of an Azure application through which Storage Transfer Service
  # can authenticate requests using Azure workload identity federation.
  #
  # Storage Transfer Service can issue requests to Azure Storage through
  # registered Azure applications, eliminating the need to pass credentials to
  # Storage Transfer Service directly.
  #
  # To configure federated identity, see
  # [Configure access to Microsoft Azure
  # Storage](https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#option_3_authenticate_using_federated_identity).
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Required. The client (application) ID of the application with federated
  #     credentials.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Required. The tenant (directory) ID of the application with federated
  #     credentials.
  class FederatedIdentityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end