Spec-Zone.ru › Ansible 2.10

azure.azcollection.azure_rm_storageaccount_info – Получение фактов о хранилище учетной записи

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач, укажите: azure.azcollection.azure_rm_storageaccount_info.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа службы.
adfs_authority_url
строка
добавлено в 0.0.1 из azure.azcollection
URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой полномочий ADFS.
api_profile
строка
добавлено в 0.0.1 из azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 0.0.1 из azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через 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.
cert_validation_mode
строка
добавлено в 0.0.1 из azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или подключении к Azure Stack, возможно, потребуется отключить это поведение, передав ignore. Также может быть задано в файле профиля учетных данных или переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с принципом службы.
cloud_environment
строка
добавлено в 0.0.1 из azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано в файле профиля учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT.
name
строка
Показывать результаты только для определенной учетной записи.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Ограничить результаты группой ресурсов. Необходимо при фильтрации по имени.

псевдонимы: resource_group_name
secret
строка
Секрет клиента Azure. Используется при аутентификации с принципом службы.
show_blob_cors
логический тип
    Варианты:
  • no
  • yes
Показать параметры CORS для BLOB для каждой BLOB, связанной с хранилищем учетной записи.
Запрос всех учетных записей хранилища займет много времени.
show_connection_string
логический тип
    Варианты:
  • no
  • yes
Показать строку подключения для каждого из точек входа хранилища учетной записи.
Для удобства использования, show_connection_string также отобразит ключи доступа для каждого из точек входа хранилища учетной записи.
Обратите внимание, что это займет много времени при перечислении всех учетных записей хранилища, а не запроса одной.
subscription_id
строка
Ваш идентификатор Azure подписки.
tags
строка
Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant
строка
Идентификатор Azure клиента. Используется при аутентификации с принципом службы.

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или выполнить вход перед запуском задач или книги задач с помощью 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': 'Успешно завершено', 'statusOfPrimary': 'Доступно'}, 'tags': {}, 'type': 'Microsoft.Storage/storageAccounts'}]
storageaccounts
сложное
всегда
Список словарей учетных записей хранилища в формате параметров модуля ресурсов.
access_tier
строка
всегда
Уровень доступа для этой учетной записи хранилища.

Пример:
Активный
account_type
строка
всегда
Тип учетной записи хранилища.
Standard_ZRS и Premium_LRS учетные записи не могут быть изменены на другие типы учетных записей.
Другие типы учетных записей не могут быть изменены на Standard_ZRS или Premium_LRS.

Пример:
Standard_ZRS
custom_domain
сложное
всегда
Пользовательский домен, назначенный учетной записи хранилища.
Должен быть словарем с ключами name и use_sub_domain, где name — источник CNAME.
name
строка
всегда
Источник CNAME.

Пример:
testaccount
use_sub_domain
булево
всегда
Использовать домен уровня домена.

Пример:
True
https_only
булево
всегда
Разрешить только трафик HTTPS в службу хранилища, если значение установлено в true.

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

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t estaccount001
kind
строка
всегда
Тип хранилища.

Пример:
Хранилище
location
строка
всегда
Действительное расположение Azure. По умолчанию — расположение группы ресурсов.

Пример:
eastus
name
строка
всегда
Имя учетной записи хранилища для обновления или создания.

Пример:
testaccount001
network_acls
словарь
всегда
Набор правил брандмауэра и виртуальной сети

Пример:
{'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
сложное
всегда
URL-адреса для получения объекта blob, file, queue или table.
Обратите внимание, что Standard_ZRS и Premium_LRS учетные записи возвращают только конечную точку blob.
blob
сложное
всегда
Первичная конечная точка и строка подключения blob.
connectionstring
строка
всегда
Строка подключения к конечной точке blob.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X
endpoint
строка
всегда
Первичная конечная точка blob.

Пример:
https://testaccount001.blob.core.windows.net/
file
сложное
всегда
Первичная конечная точка и строка подключения file.
connectionstring
строка
всегда
Строка подключения к конечной точке file.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X
endpoint
строка
всегда
Первичная конечная точка file.

Пример:
https://testaccount001.file.core.windows.net/
key
строка
всегда
Ключ учетной записи для primary_endpoints

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
queue
сложное
всегда
Первичная конечная точка и строка подключения queue.
connectionstring
строка
всегда
Строка подключения к конечной точке queue.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X
endpoint
строка
всегда
Первичная конечная точка queue.

Пример:
https://testaccount001.queue.core.windows.net/
table
сложное
всегда
Первичная конечная точка и строка подключения table.
connectionstring
строка
всегда
Строка подключения к конечной точке table.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X
endpoint
строка
всегда
Первичная конечная точка table.

Пример:
https://testaccount001.table.core.windows.net/
primary_location
строка
всегда
Расположение первичного центра обработки данных для учетной записи хранилища.

Пример:
eastus
provisioning_state
строка
всегда
Статус учетной записи хранилища на момент вызова операции.
Возможные значения: Creating, ResolvingDNS, Succeeded.

Пример:
Успешно завершено
secondary_endpoints
сложное
всегда
URL-адреса для получения объекта blob, file, queue или table из вторичного расположения.
Доступно только если SKU name=Standard_RAGRS.
blob
сложное
всегда
Вторичная конечная точка и строка подключения blob.
connectionstring
строка
всегда
Строка подключения к конечной точке blob.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X
endpoint
строка
всегда
Вторичная конечная точка blob.

Пример:
https://testaccount001.blob.core.windows.net/
файл
complex
всегда
Вторичный конечный пункт и строка подключения к файлу.
строка_подключения
строка
всегда
Строка подключения к конечному пункту файла.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X
конечный_пункт
строка
всегда
Вторичный конечный пункт файла.

Пример:
https://testaccount001.file.core.windows.net/
ключ
строка
успех
Ключ учетной записи для вторичных конечных пунктов

Пример:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
очередь
complex
всегда
Вторичный конечный пункт и строка подключения к очереди.
строка_подключения
строка
всегда
Строка подключения к конечному пункту очереди.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X
конечный_пункт
строка
всегда
Вторичный конечный пункт очереди.

Пример:
https://testaccount001.queue.core.windows.net/
таблица
complex
всегда
Вторичный конечный пункт и строка подключения к таблице.
строка_подключения
строка
всегда
Строка подключения к конечному пункту таблицы.

Пример:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X
конечный_пункт
строка
всегда
Вторичный конечный пункт таблицы.

Пример:
https://testaccount001.table.core.windows.net/
вторическое_местоположение
строка
всегда
Местоположение вторичного гео-реплицированного сервера для учетной записи хранилища.
Доступно только в случае account_type=Standard_GRS или account_type=Standard_RAGRS.

Пример:
westus
состояние_первичного
строка
всегда
Состояние первичного расположения учетной записи хранилища; либо available или unavailable.

Пример:
доступно
состояние_вторичного
строка
всегда
Состояние вторичного расположения учетной записи хранилища; либо available или unavailable.

Пример:
доступно
метки
словарь
всегда
Теги ресурсов.

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


Авторы

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

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

Spec-Zone.ru

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