Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_storageaccount_info – Получение фактов о хранилище

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные зависимости. Подробнее см. Требования.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_storageaccount_info.

Добавлена в azure.azcollection 0.1.2

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Получение фактов для одного хранилища или всех хранилищ в группе ресурсов.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, с которого выполняются модули из azure.azcollection.
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

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

adfs_authority_url

string

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "latest"

auth_source

string

added in 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 могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

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

msi был добавлен в Ansible 2.6.

Варианты:

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

cert_validation_mode

string

added in 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

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

disable_instance_discovery

boolean

added in 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

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

password

string

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

profile

string

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

resource_group

aliases: 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 / elements=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 вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с помощью az login.
  • Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
  • Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы, данные аутентификации могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход в Azure CLI

Как войти с помощью команды az login.

Примеры

- name: Get facts for one account
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup
    name: clh0002

- name: Get facts for all accounts in a resource group
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup

- name: Get facts for all accounts by tags
  azure_rm_storageaccount_info:
    tags:
      - testing
      - foo:bar

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

azure_storageaccounts

список / элементы=строка

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

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

Пример: [{"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

сложный

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

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

access_tier

строка

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

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

Пример: "Hot"

account_type

строка

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

Standard_ZRS и Premium_LRS учетные записи нельзя изменить на другие типы учетных записей.

Другие типы учетных записей нельзя изменить на Standard_ZRS или Premium_LRS.

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

Пример: "Standard_ZRS"

allow_blob_public_access

булево

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

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

Пример: true

allow_cross_tenant_replication

булево

Разрешение или запрет репликации объектов из разных областей AAD.

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

Пример: true

allow_shared_key_access

булево

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

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

Пример: true

custom_domain

сложный

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

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

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

name

строка

Исходный CNAME.

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

Пример: "testaccount"

use_sub_domain

булево

Использовать домен-поддомен.

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

Пример: true

default_to_o_auth_authentication

булево

Флаг булевого типа, указывающий, является ли стандартная авторизация OAuth или нет.

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

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

Пример: true

enable_nfs_v3

булево

Протокол NFS 3.0.

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

Пример: false

encryption

сложный

Настройки шифрования в учетной записи хранения.

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

key_source

строка

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

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

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

require_infrastructure_encryption

булево

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

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

Пример: false

services

словарь

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

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

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

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

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

Пример: false

id

string

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

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

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

is_hns_enabled

boolean

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

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

Пример: true

kind

string

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

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

Пример: "Storage"

large_file_shares_state

string

Разрешить большие файловые ресурсы, если установлено значение «Включено».

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

Пример: "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"}], "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

added in 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"}

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

Ссылки на сборку

  • Отслеживание ошибок
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_storageaccount_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API