genvid.toolbox.AzureStorageAccount

class genvid.toolbox.AzureStorageAccount(bastionAPI, default_region=None)

ベースクラス: object

Azure ストレージアカウントを作成して操作するためのユーティリティ。

AZURE_STORAGE_ACCOUNT

AZURE_STORAGE_ACCOUNT のミラーで、Azure ストレージアカウントの名前を指定します。

AZURE_RESOURCE_GROUP

AZURE_RESOURCE_GROUP のミラーで、Azure リソースグループ名を指定します。

AZURE_DEFAULT_REGION
戻り値:デフォルトの領域名。
get_storage_account_name()

使用するストレージアカウント名を取得します。

注釈

ストレージアカウントの名前は、3 文字以上 24 文字以下でユニークである必要があり、数字と小文字のみを使用することができます。

戻り値:環境変数が設定されている場合は、self.AZURE_STORAGE_ACCOUNT。それ以外の場合は、操作されたストレージアカウント名が返されます。
create_storage_account(storage_account_name: str, resource_group: str = None)

ストレージアカウントが存在しない場合に作成します。

create コマンドは、アカウントが存在しない場合にアカウントを作成します。アカウントが存在する場合は、このコマンドは無視されます。

パラメータ:
  • storage_account_name – 作成するストレージアカウント名。
  • resource_group – 使用するリソースグループ。
list_storage_accounts(resource_group: str = None) → list

リソースグループのストレージアカウントを一覧表示します。

パラメータ:resource_group – 使用するリソースグループ。
get_connection_string(storage_account_name: str, resource_group: str = None) → str

ストレージアカウントの接続文字列を取得します。

パラメータ:
  • storage_account_name – 接続文字列の取得が必要なストレージアカウントの名前。
  • resource_group – 使用するリソースグループ。
戻り値:

ストレージアカウントの接続文字列。
create_resource_group(region: str = None, resource_group: str = None)

リソースグループが存在しない場合に作成します。

リソースグループが存在する場合は、何の処理も行いません。それ以外の場合は、指定の領域にリソースグループが作成されます。

パラメータ:
  • region – リソースグループの作成が必要な領域。
  • resource_group – 作成するリソースグループ。
check_resource_group_exist(resource_group: str = None)

リソースグループが存在するかをチェックします。

パラメータ:resource_group – チェックするリソースグループ。
戻り値:リソースグループが存在する場合は True、存在しない場合は False。
get_tenant_id()

azure アカウントのテナント ID を取得します。

戻り値:azureアカウントのテナントID。
upload_blob(storage_account_name: str, container_name: str, blob_name: str, filepath: typing.Union[str, pathlib.Path], resource_group: str = None)

Azure コンテナに特定の blob をアップロードします。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • container_name – 処理を行うコンテナ名。
  • blob_name – アップロードする blob 名。
  • filepath – アップロードするファイルのパス。
  • resource_group – ストレージアカウントが存在するリソースグループ。
add_allowed_ip(storage_account_name: str, ip: str)

IP アドレスを許可リストに追加します。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • ip – 追加する IP アドレス。
delete_blob(storage_account_name: str, container_name: str, blob_name: str, resource_group: str = None)

Azure コンテナに特定の blob を削除します。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • container_name – 処理を行うコンテナ名。
  • blob_name – 削除する blob 名
  • resource_group – ストレージアカウントが存在するリソースグループ。
create_container(storage_account_name: str, container_name: str, access_level: str = 'blob', resource_group: typing.Union[str, NoneType] = None)

Azure コンテナを作成します。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • container_name – 処理を行うコンテナ名。
  • access_level – blob のアクセスレベル。
  • resource_group – ストレージアカウントが存在するリソースグループ。
list_containers(storage_account_name: str, resource_group: str = None)

ストレージアカウントのコンテナを一覧表示します。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • resource_group – ストレージアカウントが存在するリソースグループ。
list_allowed_ips(storage_account_name: str) → list

ストレージアカウントに許可されている IP アドレスを一覧表示します。

パラメータ:storage_account_name – ストレージアカウント名。
戻り値:許可された IP アドレスの一覧。
list_images(storage_account_name: str, container_name: str, prefix: str, resource_group: str = None)

コンテナ内の特定のパスの画像の一覧です。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • container_name – 処理を行うコンテナ名。
  • prefix – image/blob のプレフィックス。
戻り値:

Images/blobs の一覧。

共有イメージギャラリーのリスト。

戻り値:共有イメージギャラリーのリスト。

指定したリソースグループに共有イメージギャラリーを作成する。

:param resource_group:Resource group to be created if it does not exists. :param gallery_name: Shared Gallery name to be created.

ギャラリーイメージ定義のリスト。

パラメータ:
  • gallery_name – 共有イメージギャラリー名。
  • resource_group – 共有イメージギャラリーが存在するリソースグループ。
戻り値:

Images/blobs の一覧。
create_image_definition(resource_group: str, gallery_name: str, image_definition_name: str, publisher: str, image_sku: str, image_offer: str, os_type: str)

ギャラリーイメージ定義を作成する。

パラメータ:
  • resource_group – リソースグループ名。
  • gallery_name – 共有イメージギャラリー名。
  • image_defintion_name – ギャラリーイメージ定義。
  • publisher – イメージパブリッシャー。
  • image_sku – イメージ sku。
  • image_offer – blob のアクセスレベル。
  • os_type – ストレージアカウント名。
delete_storage_account(storage_account_name: str, resource_group: str = None)

指定したストレージアカウントを削除する。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • resource_group – ストレージアカウントが存在するリソースグループ。
delete_container(container_name: str, storage_account_name: str, resource_group: str = None)

指定したコンテナを削除する。

パラメータ:
  • storage_account_name – ストレージアカウント名。
  • container_name – 削除するコンテナ名。
  • resource_group – ストレージアカウントが存在するリソースグループ。
delete_resource_group(resource_group: str)

指定したリソースグループを削除する。

パラメータ:resource_group – リソースグループ名。
class azure_storage.AzureStorageAccount

genvid.toolbox.AzureStorageAccount の実装