Spec-Zone.ru › AWS CLI v2

[ aws . license-manager-user-subscriptions ]

start-product-subscription

Описание

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

Примечание

Ожидаемая сумма счёта за пользователе и сопутствующие расходы отобразится через 48 часов для платёжных периодов, которые ещё не закрыты (со статусом выставления счёта Pending) в Amazon Web Services Billing. Для получения дополнительной информации см. раздел «Просмотр ежемесячных расходов» в руководстве пользователя Amazon Web Services Billing.

См. также: Документация API AWS

Синтаксис

  start-product-subscription
[--domain <value>]
--identity-provider <value>
--product <value>
[--tags <value>]
--username <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--domain (строка)

Имя домена Active Directory, содержащего пользователя, для которого нужно запустить подписку на продукт.

--identity-provider (структура помеченного объединения)

Объект, определяющий сведения о поставщике удостоверений.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: ActiveDirectoryIdentityProvider.

ActiveDirectoryIdentityProvider -> (структура)

Ресурс ActiveDirectoryIdentityProvider содержит параметры и другие сведения о конкретном поставщике удостоверений Active Directory.

ActiveDirectorySettings -> (структура)

Ресурс ActiveDirectorySettings содержит сведения об Active Directory, включая сведения о сетевом доступе, такие как имя домена и IP-адреса, а также поставщика учетных данных для управления пользователями.

DomainCredentialsProvider -> (структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: SecretsManagerCredentialsProvider.

SecretsManagerCredentialsProvider -> (структура)

Указывает секрет Secrets Manager, содержащий учетные данные, необходимые для управления пользователями в Active Directory.

SecretId -> (строка)

Идентификатор секрета Secrets Manager, содержащего учетные данные.

DomainIpv4List -> (список)

Список IP-адресов IPv4 домена, используемых для Active Directory.

(строка)

DomainName -> (строка)

Имя домена Active Directory.

DomainNetworkSettings -> (структура)

Ресурс DomainNetworkSettings содержит массив подсетей, применимых для Active Directory.

Subnets -> (список)

Содержит список подсетей, применимых для домена Active Directory.

(строка)

ActiveDirectoryType -> (строка)

Тип Active Directory — либо автономный Active Directory, либо управляемый Amazon Web Services Active Directory.

DirectoryId -> (строка)

Идентификатор каталога для поставщика удостоверений Active Directory.

Синтаксис JSON:

{
  "ActiveDirectoryIdentityProvider": {
    "ActiveDirectorySettings": {
      "DomainCredentialsProvider": {
        "SecretsManagerCredentialsProvider": {
          "SecretId": "string"
        }
      },
      "DomainIpv4List": ["string", ...],
      "DomainName": "string",
      "DomainNetworkSettings": {
        "Subnets": ["string", ...]
      }
    },
    "ActiveDirectoryType": "SELF_MANAGED"|"AWS_MANAGED",
    "DirectoryId": "string"
  }
}

--product (строка)

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

Допустимые значения: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

--tags (массив)

Теги, применяемые к подписке на продукт.

ключ -> (строка)

значение -> (строка)

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--username (строка)

Имя пользователя от поставщика удостоверений пользователя.

--cli-input-json | --cli-input-yaml (строка) Чтение аргументов из предоставленной строки JSON. Строка JSON соответствует формату, заданному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Использовать определённую область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата корневого удостоверения для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок, fileb:// всегда будет обрабатываться как двоичное значение и будет использоваться содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод пагинатора CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

ProductUserSummary -> (структура)

Метаданные, описывающие операцию запуска подписки на продукт.

Domain -> (строка)

Имя домена Active Directory, содержащего сведения о пользователе для подписки на продукт.

IdentityProvider -> (структура помеченного объединения)

Объект, определяющий сведения о поставщике удостоверений.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: ActiveDirectoryIdentityProvider.

ActiveDirectoryIdentityProvider -> (структура)

Ресурс ActiveDirectoryIdentityProvider содержит параметры и другие сведения о конкретном поставщике удостоверений Active Directory.

ActiveDirectorySettings -> (структура)

Ресурс ActiveDirectorySettings содержит сведения об Active Directory, включая сведения о сетевом доступе, такие как имя домена и IP-адреса, а также поставщика учетных данных для управления пользователями.

DomainCredentialsProvider -> (структура помеченного объединения)

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

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: SecretsManagerCredentialsProvider.

SecretsManagerCredentialsProvider -> (структура)

Указывает секрет Secrets Manager, содержащий учетные данные, необходимые для управления пользователями в Active Directory.

SecretId -> (строка)

Идентификатор секрета Secrets Manager, содержащего учетные данные.

DomainIpv4List -> (список)

Список IP-адресов IPv4 домена, используемых для Active Directory.

(строка)

DomainName -> (строка)

Имя домена Active Directory.

DomainNetworkSettings -> (структура)

Ресурс DomainNetworkSettings содержит массив подсетей, применимых для Active Directory.

Subnets -> (список)

Содержит список подсетей, применимых для домена Active Directory.

(строка)

ActiveDirectoryType -> (строка)

Тип Active Directory — либо автономный Active Directory, либо управляемый Amazon Web Services Active Directory.

DirectoryId -> (строка)

Идентификатор каталога для поставщика удостоверений Active Directory.

Product -> (строка)

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

ProductUserArn -> (строка)

Amazon Resource Name (ARN) для этого пользователя продукта.

Status -> (строка)

Статус продукта для этого пользователя.

StatusMessage -> (строка)

Сообщение состояния для продукта для этого пользователя.

SubscriptionEndDate -> (строка)

Дата окончания подписки.

SubscriptionStartDate -> (строка)

Дата начала подписки.

Username -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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