Модуль azure.azcollection.azure_rm_resource — создание любого ресурса Azure

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"

api_version

string

Используемая версия API.

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"

body

any

Тело HTTP-запроса или ответа веб-службы.

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

idempotency

boolean

Если параметр включен, сначала будет выполнена проверка идемпотентности с помощью method=GET, а затем результат будет сравнен с body.

Варианты:

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

log_mode

string

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

log_path

string

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

method

string

Метод HTTP-запроса или ответа. Должен быть указан в верхнем регистре.

Варианты:

• "GET"
• "PUT" ← (по умолчанию)
• "POST"
• "HEAD"
• "PATCH"
• "DELETE"
• "MERGE"

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, а не субъекта-службы.

polling_interval

integer

Если параметр включен, сначала будет выполнена проверка идемпотентности с помощью method=GET, а затем результат будет сравнен с body.

По умолчанию: 60

polling_timeout

integer

Если параметр включен, сначала будет выполнена проверка идемпотентности с помощью method=GET, а затем результат будет сравнен с body.

По умолчанию: 0

profile

string

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

provider

string

Тип поставщика.

Обязателен, если URL-адрес не указан.

resource_group

string

Используемая группа ресурсов.

Обязателен, если URL-адрес не указан.

resource_name

string

Имя ресурса.

Обязательно, если URL-адрес не указан.

resource_type

string

Тип ресурса.

Обязателен, если URL-адрес не указан.

secret

string

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

state

string

Задайте требуемое состояние ресурса. Используйте present для создания или обновления ресурса либо absent для удаления ресурса.

Варианты:

• "absent"
• "present" ← (по умолчанию)

status_code

list / elements=integer

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

По умолчанию: [200, 201, 202]

subresource

list / elements=dictionary

Список подресурсов.

По умолчанию: []

name

string

Имя подресурса.

namespace

string

Пространство имен подресурса.

type

string

Тип подресурса.

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

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

url

string

URL-адрес ресурса Azure RM.

x509_certificate_path

path

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

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

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

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

response

complex

Ответ, специфичный для типа ресурса.

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

id

string

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

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

Пример: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183"

kind

string

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

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

Пример: "Storage"

location

string

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

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

Пример: "eastus"

name

string

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

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

Пример: "staccb57dc95183"

properties

dictionary

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

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

Пример: {"creationTime": "2019-06-13T06:34:33.0996676Z", "encryption": {"keySource": "Microsoft.Storage", "services": {"blob": {"enabled": true, "lastEnabledTime": "2019-06-13T06:34:33.1934074Z"}, "file": {"enabled": true, "lastEnabledTime": "2019-06-13T06:34:33.1934074Z"}}}, "networkAcls": {"bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], "virtualNetworkRules": []}, "primaryEndpoints": {"blob": "https://staccb57dc95183.blob.core.windows.net/", "file": "https://staccb57dc95183.file.core.windows.net/", "queue": "https://staccb57dc95183.queue.core.windows.net/", "table": "https://staccb57dc95183.table.core.windows.net/"}, "primaryLocation": "eastus", "provisioningState": "Succeeded", "secondaryLocation": "westus", "statusOfPrimary": "available", "statusOfSecondary": "available", "supportsHttpsTrafficOnly": false}

sku

dictionary

Артикул учетной записи хранения (SKU).

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

Пример: {"name": "Standard_GRS", "tier": "Standard"}

tags

dictionary

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

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

Пример: {"key1": "value1"}

type

string

Тип ресурса.

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

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