Модуль azure.azcollection.azure_rm_apimanagement — управление экземплярами API Azure

ad_user

string

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

adfs_authority_url

string

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

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

api_id

string / обязательный

Идентификатор редакции API. Он должен быть уникальным в текущем экземпляре службы API Management.

api_profile

string

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

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

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

api_revision

string

Описывает редакцию API.

Если значение не указано, создается редакция 1 по умолчанию

api_revision_description

string

Описание редакции API.

api_type

string

Тип создаваемого API.

http создает API для преобразования SOAP в REST.

soap создает API для прямой передачи SOAP.

Варианты:

• "soap"
• "http"

api_version

string

Указывает идентификатор версии API, если для API включено управление версиями

api_version_description

string

Описание версии API.

api_version_set

dictionary

Сведения о наборе версий

description

string

Описание набора версий API.

id

string

Идентификатор существующего набора версий API

Не указывайте это значение, чтобы создать новый набор версий.

name

string

Отображаемое имя набора версий API.

version_header_name

string

Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение `header`.

version_query_name

string

Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение `query`.

versioning_scheme

string

Значение, определяющее, где в HTTP-запросе будет размещен идентификатор версии API.

Варианты:

• "Segment"
• "Query"
• "Header"

api_version_set_id

string

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

append_tags

boolean

Определяет, является ли поле tags каноническим или только дополняет существующие теги.

Если поле каноническое, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

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

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"

authentication_settings

dictionary

Набор параметров аутентификации, включенных в этот API.

o_auth2

dictionary

Параметры аутентификации OAuth2

authorization_server_id

string

Идентификатор сервера авторизации OAuth.

scope

string

Область действия операций.

openid

dictionary

Параметры аутентификации OpenID Connect

bearer_token_sending_methods

list / elements=string

Способ передачи токена на сервер.

Варианты:

• "authorizationHeader"
• "query"

openid_provider_id

string

Идентификатор сервера авторизации OAuth.

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"

description

string

Описание API.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

display_name

string

Отображаемое имя API. Длина должна составлять от 1 до 300 символов.

format

string

Формат содержимого, из которого импортируется API.

Варианты:

• "wadl-xml"
• "wadl-link-json"
• "swagger-json"
• "swagger-link-json"
• "wsdl"
• "wsdl-link"
• "openapi"
• "openapi+json"
• "openapi-link"

is_current

boolean

Указывает, является ли редакция API текущей.

Варианты:

• false
• true

log_mode

string

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

log_path

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

path

string

Относительный URL, уникально идентифицирующий этот API.

profile

string

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

protocols

list / elements=string

Описывает протоколы, по которым можно вызывать операции этого API.

Варианты:

• "http"
• "https"

resource_group

string / обязательный

Имя группы ресурсов.

secret

string

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

service_name

string / обязательный

Имя службы API Management.

service_url

string

Абсолютный URL-адрес серверной службы, реализующей этот API

Длина не должна превышать 2000 символов.

source_api_id

string

Идентификатор исходного API.

state

string

Состояние API.

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

Варианты:

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

subscription_id

string

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

subscription_key_parameter_names

dictionary

Протоколы, по которым предоставляется API.

header

string

Имя заголовка ключа подписки.

query

string

Имя параметра строки запроса для ключа подписки.

subscription_required

boolean

Указывает, требуется ли подписка на API или продукт для доступа к API.

Варианты:

• false
• true

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с использованием указанных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время в тегах зон Azure DNS и служб Traffic Manager также нельзя использовать пробелы.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

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

thumbprint

string

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

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

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

Обязательный параметр, если задан x509_certificate_path.

type

string

Тип API

Варианты:

• "http"
• "soap"

value

string

Значение содержимого при импорте API.

wsdl_selector

dictionary

Критерии для ограничения импорта WSDL частью документа.

wsdl_endpoint_name

string

Имя конечной точки (порта) для импорта из WSDL.

wsdl_service_name

string

Имя службы для импорта из WSDL.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

id

string

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

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