Модуль azure.azcollection.azure_rm_storageaccount_info — получение сведений об учетных записях хранения

ad_user

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте этот параметр для аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_mode

string

добавлено в azure.azcollection 3.10.0

Режим выполнения команды. Режим login будет напрямую использовать ваши учетные данные для аутентификации.

Устаревший режим key попытается получить ключ учетной записи, если параметры аутентификации для учетной записи не указаны.

Также можно задать с помощью переменной среды AZURE_STORAGE_AUTH_MODE.

Варианты:

• "key" ← (по умолчанию)
• "login"

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), порядок приоритета следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные считываются из переменных среды.

Если задано значение credential_file, профиль считывается из ~/.azure/credentials.

Если задано значение cli, учетные данные берутся из профиля Azure CLI. Для определения идентификатора подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае используется подписка Azure CLI по умолчанию.

Если задано значение msi, хост-компьютер должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае выбирается первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный хост центра является допустимым и надежным.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

log_mode

string

Аргумент родительского элемента.

log_path

string

Аргумент родительского элемента.

name

string

Показывать результаты только для указанной учетной записи.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

псевдонимы: resource_group_name

string

Ограничить результаты указанной группой ресурсов. Обязателен при фильтрации по имени.

secret

string

Секрет клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы.

show_blob_cors

boolean

Показывать параметры CORS для blob-объектов, связанных с учетной записью хранения.

Получение данных обо всех учетных записях хранения займет много времени.

Варианты:

• false
• true

show_connection_string

boolean

Показывать строку подключения для каждой конечной точки учетной записи хранения.

Для удобства использования параметр show_connection_string также отображает ключи доступа для каждой конечной точки учетной записи хранения.

Обратите внимание, что получение списка всех учетных записей хранения, а не запрос одной учетной записи, займет много времени.

Варианты:

• false
• true

show_georeplication_stats

boolean

Показывать статистику георепликации для каждой учетной записи хранения.

Использование этого параметра для учетной записи, не поддерживающей георепликацию, замедлит получение результатов.

Варианты:

• false
• true

subscription_id

string

Идентификатор вашей подписки Azure.

tags

list / элементы=string

Ограничить результаты, указав список тегов. Задавайте теги в формате «ключ» или «ключ:значение».

tenant

string

Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте этот параметр для аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, использованному для создания субъекта-службы.

Сертификат должен быть добавлен после закрытого ключа.

Используйте этот параметр для аутентификации с помощью субъекта-службы.

azure_storageaccounts

list / elements=string

Список словарей учетных записей хранения.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/myResourceGroups/testing/providers/Microsoft.Storage/storageAccounts/testaccount001", "location": "eastus2", "name": "testaccount001", "properties": {"accountType": "Standard_LRS", "creationTime": "2016-03-28T02:46:58.290113Z", "primaryEndpoints": {"blob": "https://testaccount001.blob.core.windows.net/", "file": "https://testaccount001.file.core.windows.net/", "queue": "https://testaccount001.queue.core.windows.net/", "table": "https://testaccount001.table.core.windows.net/"}, "primaryLocation": "eastus2", "provisioningState": "Succeeded", "statusOfPrimary": "Available"}, "tags": {}, "type": "Microsoft.Storage/storageAccounts"}]

storageaccounts

complex

Список словарей учетных записей хранения в формате параметров модуля ресурсов.

Возвращается: всегда

access_tier

string

Уровень доступа для этой учетной записи хранения.

Возвращается: всегда

Пример: "Hot"

account_type

string

Тип учетной записи хранения.

Учетные записи Standard_ZRS и Premium_LRS нельзя преобразовать в учетные записи других типов.

Учетные записи других типов нельзя преобразовать в Standard_ZRS или Premium_LRS.

Возвращается: всегда

Пример: "Standard_ZRS"

allow_blob_public_access

boolean

Разрешает или запрещает публичный доступ ко всем большим двоичным объектам или контейнерам в учетной записи хранения.

Возвращается: всегда

Пример: true

allow_cross_tenant_replication

boolean

Разрешает или запрещает репликацию объектов между клиентами AAD.

Возвращается: всегда

Пример: true

allow_shared_key_access

boolean

Указывает, разрешает ли учетная запись хранения авторизовать запросы с помощью ключа доступа к учетной записи через Shared Key.

Возвращается: всегда

Пример: true

custom_domain

complex

Пользовательский домен, назначенный учетной записи хранения.

Должен быть словарем с ключами name и use_sub_domain, где name — источник CNAME.

Возвращается: всегда

name

string

Источник CNAME.

Возвращается: всегда

Пример: "testaccount"

use_sub_domain

boolean

Определяет, следует ли использовать поддомен.

Возвращается: всегда

Пример: true

default_to_o_auth_authentication

boolean

Логический флаг, указывающий, используется ли OAuth для аутентификации по умолчанию.

По умолчанию для этого свойства используется значение false.

Возвращается: всегда

Пример: true

enable_nfs_v3

boolean

Протокол NFS 3.0.

Возвращается: всегда

Пример: false

encryption

complex

Параметры шифрования учетной записи хранения.

Возвращается: всегда

encryption_identity

dictionary

Удостоверение, используемое для шифрования данных на стороне службы при хранении.

Возвращается: всегда

Пример: {"encryption_user_assigned_identity": "/subscriptions/xxxx/resourcegroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-11"}

key_source

string

Источник ключа шифрования (поставщик).

Возвращается: всегда

Пример: "Microsoft.Storage"

key_vault_properties

dictionary

Словарь свойств Microsoft Key Vault.

Создайте учетную запись хранения с включенным шифрованием с помощью Microsoft Key Vault для CMK.

Возвращается: всегда

Пример: {"key_name": "testkey", "key_vault_uri": "https://vxxxxxxx01.vault.azure.net/", "key_version": "0bd2556671c64fc998xxxxeb12"}

require_infrastructure_encryption

boolean

Логическое значение, указывающее, применяет ли служба дополнительный уровень шифрования данных при хранении с помощью ключей, управляемых платформой.

Возвращается: всегда

Пример: false

services

dictionary

Список служб, поддерживающих шифрование.

Возвращается: всегда

blob

dictionary

Функция шифрования службы хранилища больших двоичных объектов.

Возвращается: всегда

Пример: {"enabled": true}

file

dictionary

Функция шифрования службы хранилища файлов.

Возвращается: всегда

Пример: {"enabled": true}

queue

dictionary

Функция шифрования службы хранилища очередей.

Возвращается: всегда

Пример: {"enabled": true}

table

dictionary

Функция шифрования службы хранилища таблиц.

Возвращается: всегда

Пример: {"enabled": true}

failover_in_progress

boolean

Состояние, указывающее, что в настоящее время выполняется переключение учетной записи хранения на ее вторичное расположение.

Возвращается: всегда

Пример: false

georeplication_stats

complex

Параметры, связанные с состоянием георепликации.

Для учетных записей, не поддерживающих георепликацию, это значение будет равно null.

Возвращается: всегда

can_failover

boolean

Свойство, указывающее, поддерживается ли переключение для учетной записи.

Возвращается: при успешном выполнении

Пример: true

last_sync_time

string

Гарантируется, что записи в первичное расположение, сделанные до этого времени, будут реплицированы во вторичное расположение.

Возвращается: при успешном выполнении

Пример: "2023-04-10T21:22:15+00:00"

sync_status

string

Свойство, показывающее состояние вторичного региона.

Допустимые значения: «Live», «Bootstrap» и «Unavailable».

Возвращается: при успешном выполнении

Пример: "Live"

https_only

boolean

Если установлено значение true, для службы хранения разрешается только HTTPS-трафик.

Возвращается: всегда

Пример: false

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t estaccount001"

immutable_storage_with_versioning

complex

Это свойство является неизменяемым и может быть установлено в true только при создании учетной записи.

При значении true для всех контейнеров учетной записи по умолчанию включается неизменяемость на уровне объектов.

Возвращается: при использовании

enabled

boolean

Логический флаг, включающий неизменяемость на уровне учетной записи.

Для всех контейнеров в такой учетной записи по умолчанию включается неизменяемость на уровне объектов.

Возвращается: при использовании

Пример: true

immutability_policy

dictionary

Задает политику неизменяемости по умолчанию на уровне учетной записи. Она наследуется и применяется к объектам, для которых не задана явная политика неизменяемости на уровне объекта.

Политика неизменяемости на уровне объекта имеет более высокий приоритет, чем политика на уровне контейнера, которая, в свою очередь, имеет более высокий приоритет, чем политика на уровне учетной записи.

Возвращается: при использовании

allow_protected_append_writes

boolean

Это свойство можно изменить только для отключенных и разблокированных политик хранения с ограничением по времени.

Если эта возможность включена, в большой двоичный объект типа append можно записывать новые блоки, сохраняя защиту от изменений и соответствие требованиям.

Можно добавлять только новые блоки; существующие блоки нельзя изменять или удалять.

Возвращается: при использовании

Пример: true

immutability_period_since_creation_in_days

integer

Период неизменяемости больших двоичных объектов в контейнере с момента создания политики, в днях.

Возвращается: при использовании

Пример: true

state

string

Состояние ImmutabilityPolicy определяет режим политики.

Возвращается: при использовании

Пример: "Unlocked"

is_hns_enabled

boolean

Иерархическое пространство имен учетной записи включено, если установлено значение true.

Возвращается: всегда

Пример: true

kind

string

Тип хранилища.

Возвращается: всегда

Пример: "Storage"

large_file_shares_state

string

Разрешает большие общие папки, если установлено значение Enabled.

Возвращается: всегда

Пример: "Enabled"

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

Возвращается: всегда

Пример: "eastus"

minimum_tls_version

string

Минимальная версия TLS, разрешенная для запросов к хранилищу.

Возвращается: всегда

Пример: "TLS1_2"

name

string

Имя учетной записи хранения для обновления или создания.

Возвращается: всегда

Пример: "testaccount001"

network_acls

dictionary

Набор правил брандмауэра, виртуальной сети и экземпляров ресурсов.

Возвращается: всегда

Пример: {"bypass": "AzureServices", "default_action": "Deny", "ip_rules": [{"action": "Allow", "value": "1.2.3.4"}, {"action": "Allow", "value": "123.234.123.0/24"}], "resource_access_rules": [{"resource_id": "/subscriptions/.../BackupVaults/myBackupVault", "tenant_id": "myTenantId"}], "virtual_network_rules": [{"action": "Allow", "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/                                     providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"}]}

primary_endpoints

complex

URL-адреса для получения общедоступных объектов blob, file, queue или table.

Обратите внимание, что для учетных записей Standard_ZRS и Premium_LRS возвращается только конечная точка blob.

Возвращается: всегда

blob

complex

Основная конечная точка blob и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки blob.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X"

endpoint

string

Основная конечная точка blob.

Возвращается: всегда

Пример: "https://testaccount001.blob.core.windows.net/"

file

complex

Основная конечная точка file и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки file.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X"

endpoint

string

Основная конечная точка file.

Возвращается: всегда

Пример: "https://testaccount001.file.core.windows.net/"

key

string

Ключ учетной записи для primary_endpoints

Возвращается: всегда

Пример: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

queue

complex

Основная конечная точка queue и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки queue.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X"

endpoint

string

Основная конечная точка queue.

Возвращается: всегда

Пример: "https://testaccount001.queue.core.windows.net/"

table

complex

Основная конечная точка table и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки table.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X"

endpoint

string

Основная конечная точка table.

Возвращается: всегда

Пример: "https://testaccount001.table.core.windows.net/"

primary_location

string

Расположение основного центра обработки данных учетной записи хранения.

Возвращается: всегда

Пример: "eastus"

provisioning_state

string

Состояние учетной записи хранения на момент вызова операции.

Возможные значения: Creating, ResolvingDNS, Succeeded.

Возвращается: всегда

Пример: "Succeeded"

public_network_access

string

Доступ к учетной записи хранения через общедоступную сеть разрешен или запрещен.

Возвращается: всегда

Пример: "Enabled"

secondary_endpoints

complex

URL-адреса для получения общедоступного объекта blob, file, queue или table из вторичного расположения.

Доступно только для SKU name=Standard_RAGRS.

Возвращается: всегда

blob

complex

Вторичная конечная точка blob и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки blob.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X"

endpoint

string

Вторичная конечная точка blob.

Возвращается: всегда

Пример: "https://testaccount001.blob.core.windows.net/"

file

complex

Вторичная конечная точка file и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки file.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X"

endpoint

string

Вторичная конечная точка file.

Возвращается: всегда

Пример: "https://testaccount001.file.core.windows.net/"

key

string

Ключ учетной записи для secondary_endpoints

Возвращается: при успешном выполнении

Пример: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

queue

complex

Вторичная конечная точка queue и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки queue.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X"

endpoint

string

Вторичная конечная точка queue.

Возвращается: всегда

Пример: "https://testaccount001.queue.core.windows.net/"

table

complex

Вторичная конечная точка table и строка подключения.

Возвращается: всегда

connectionstring

string

Строка подключения конечной точки table.

Возвращается: всегда

Пример: "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X"

endpoint

string

Вторичная конечная точка table.

Возвращается: всегда

Пример: "https://testaccount001.table.core.windows.net/"

secondary_location

string

Расположение геореплицированной вторичной копии учетной записи хранения.

Доступно только при значении account_type=Standard_GRS или account_type=Standard_RAGRS.

Возвращается: всегда

Пример: "westus"

static_website

complex

добавлено в azure.azcollection 1.13.0

Конфигурация статического веб-сайта для учетной записи хранения.

Возвращается: всегда

enabled

boolean

Указывает, размещает ли эта учетная запись статический веб-сайт.

Возвращается: всегда

Пример: true

error_document404_path

string

Абсолютный путь к пользовательской странице 404.

Возвращается: всегда

Пример: "error.html"

index_document

string

Имя индексной страницы по умолчанию для каждого каталога.

Возвращается: всегда

Пример: "index.html"

status_of_primary

string

Состояние основного расположения учетной записи хранения: available или unavailable.

Возвращается: всегда

Пример: "available"

status_of_secondary

string

Состояние вторичного расположения учетной записи хранения: available или unavailable.

Возвращается: всегда

Пример: "available"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"tag1": "abc"}