Class: Ansible::Ruby::Modules::Azure_rm_storageblob

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb

Overview

Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#blob ⇒ String?

Returns Name of a blob object within the container.

Returns:

  • (String, nil) —

    Name of a blob object within the container.



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 15

attribute :blob

#cache_control ⇒ Object?

Returns Set the blob cache-control header.

Returns:

  • (Object, nil) —

    Set the blob cache-control header.



27
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 27

attribute :cache_control

#container ⇒ String

Returns Name of a blob container within the storage account.

Returns:

  • (String) —

    Name of a blob container within the storage account.



19
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 19

attribute :container

#content_disposition ⇒ Object?

Returns Set the blob content-disposition header.

Returns:

  • (Object, nil) —

    Set the blob content-disposition header.



30
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 30

attribute :content_disposition

#content_encoding ⇒ Object?

Returns Set the blob encoding header.

Returns:

  • (Object, nil) —

    Set the blob encoding header.



33
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 33

attribute :content_encoding

#content_language ⇒ Object?

Returns Set the blob content-language header.

Returns:

  • (Object, nil) —

    Set the blob content-language header.



36
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 36

attribute :content_language

#content_md5 ⇒ Object?

Returns Set the blob md5 hash value.

Returns:

  • (Object, nil) —

    Set the blob md5 hash value.



39
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 39

attribute :content_md5

#content_type ⇒ String?

Returns Set the blob content-type header. For example, ‘image/png’.

Returns:

  • (String, nil) —

    Set the blob content-type header. For example, ‘image/png’.



23
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 23

attribute :content_type

#dest ⇒ String?

Returns Destination file path. Use with state ‘present’ to download a blob.

Returns:

  • (String, nil) —

    Destination file path. Use with state ‘present’ to download a blob.



42
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 42

attribute :dest

#force ⇒ Boolean?

Returns Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs.

Returns:

  • (Boolean, nil) —

    Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs.



46
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 46

attribute :force

#public_access ⇒ :container, ...

Returns Determine a container’s level of public access. By default containers are private. Can only be set at time of container creation.

Returns:

  • (:container, :blob, nil) —

    Determine a container’s level of public access. By default containers are private. Can only be set at time of container creation.



62
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 62

attribute :public_access

#resource_group ⇒ String

Returns Name of the resource group to use.

Returns:

  • (String) —

    Name of the resource group to use.



50
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 50

attribute :resource_group

#src ⇒ String?

Returns Source file path. Use with state ‘present’ to upload a blob.

Returns:

  • (String, nil) —

    Source file path. Use with state ‘present’ to upload a blob.



54
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 54

attribute :src

#state ⇒ :absent, ...

Returns Assert the state of a container or blob.,Use state ‘absent’ with a container value only to delete a container. Include a blob value to remove a specific blob. A container will not be deleted, if it contains blobs. Use the force option to override, deleting the container and all associated blobs.,Use state ‘present’ to create or update a container and upload or download a blob. If the container does not exist, it will be created. If it exists, it will be updated with configuration options. Provide a blob name and either src or dest to upload or download. Provide a src path to upload and a dest path to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten unless the force parameter is true.

Returns:

  • (:absent, :present, nil) —

    Assert the state of a container or blob.,Use state ‘absent’ with a container value only to delete a container. Include a blob value to remove a specific blob. A container will not be deleted, if it contains blobs. Use the force option to override, deleting the container and all associated blobs.,Use state ‘present’ to create or update a container and upload or download a blob. If the container does not exist, it will be created. If it exists, it will be updated with configuration options. Provide a blob name and either src or dest to upload or download. Provide a src path to upload and a dest path to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten unless the force parameter is true.



58
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 58

attribute :state

#storage_account_name ⇒ String

Returns Name of the storage account to use.

Returns:

  • (String) —

    Name of the storage account to use.



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_storageblob.rb', line 11

attribute :storage_account_name