Раздел параметры: Параметры загрузки Windows (включая безопасный режим)

Содержание

Как убрать надпись Активация Windows 10 навсегда с экрана

Иногда пользователи предпочитают работать в Windows 10 без активации и это вполне возможно (об этом в отдельном материале: Можно ли пользоваться Windows 10 без активации, как долго и с какими ограничениями), но через какое-то время в правом нижнем углу экрана появится надпись «Активация Windows» с пояснением: Чтобы активировать Windows, перейдите в раздел Параметры, предполагающим, что вы перейдете в Параметры — Обновления и безопасность — Активация и введете ключ продукта. Однако, убрать надпись с экрана можно и без этого.

В этой инструкции подробно о том, как навсегда убрать надпись Активация Windows на экране Windows 10 несколькими способами — вручную и с помощью сторонних программ, а также дополнительная информация, которая может оказаться полезной.

Убираем надпись «Активация Windows» с помощью редактора реестра

Первый способ — использовать редактор реестра для отключения показа надписи об активации Windows 10. Если вы уже пробовали этот метод, но параметры возвращались в исходное состояние, решение для этого также будет предложено в этом разделе.

Шаги будут следующими:

  1. Запустите редактор реестра: нажмите клавиши Win+R (Win — клавиша с эмблемой Windows), введите regedit и нажмите Enter.
  2. Перейдите к разделу реестра
    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SoftwareProtectionPlatform\Activation
  3. Обратите внимание на параметр Manual в правой части окна редактора. Дважды нажмите по нему и задайте значение 1.
  4. Проделайте то же самое для параметра NotificationDisabled
  5. После перезагрузки надпись исчезнет, но не торопитесь перезагружать: через некоторое время система может убрать ваши изменения. Чтобы этого не произошло, нажмите правой кнопкой мыши по разделу (папке) Activation слева и выберите пункт «Разрешения».
  6. Выбрав пункты «Система» и «TrustedInstaller» отметьте для них «Запретить» в списке разрешений и нажмите кнопку «Применить».
  7. Нажмите кнопку «Дополнительно», а на следующем экране нажмите «Отключить наследования», подтвердите, а затем удалите пункты TrustedInstaller и Система, для которых в «Тип» указано «Разрешить».
  8. Примените сделанные настройки и перезагрузите Windows

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

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SoftwareProtectionPlatform\Activation]
"ActivationInterval"=dword:000dbba0
"Manual"=dword:00000001
"NotificationDisabled"=dword:00000001
"DownlevelActivation"=dword:00000002

Еще один метод в дополнение к вышеописанному — отключение службы «Быстрая проверка». Сделать это можно в services.msc (установить тип запуска службы в «Отключена», применить и перезагрузить компьютер), либо в редакторе реестра: в разделе реестра

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\svsvc следует изменить параметр Start на 4, а затем перезагрузить компьютер.

Программа Universal Watermark Disabler

Еще один способ убрать надпись «Активация Windows» в углу экрана — использовать простую бесплатную утилиту Universal Watermark Disabler, скачать которую можно с официального сайта https://winaero.com/download.php?view.1794. После загрузки утилиты, распакуйте архив и запустите файл uwd.exe

Нажмите кнопку «Install» (может потребоваться подтверждение установки в неподдерживаемой сборке, обычно всё работает), а после этого нажмите «Ок» для выхода из системы.

После автоматического выхода из системы и последующего входа надпись не всегда пропадает, но, если после этого выполнить перезагрузку компьютера или ноутбука — обычно исчезает (но, по моим тестам, не всегда).

Видео инструкция

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

remontka.pro в Телеграм | Другие способы подписки

А вдруг и это будет интересно:

Управление инструментом «Параметры» в Windows 10 — как скрыть или отобразить разделы? — Starus Recovery

В этой статье мы рассмотрим два способа, которые позволят вам не только восстановить отображение скрытых разделов, но и скрыть их самостоятельно.

  • Что такое “Параметры Windows” и причины исчезновения меню параметров
  • Как восстановить отображение разделов в параметрах Windows

  • Что такое “Параметры Windows” и причины исчезновения меню параметров

    Параметры Windows — это приложение, которое собирает в себе все доступные пользователю инструменты по взаимодействию с операционной системой. Утилита позволяет не только изменить текущее оформление рабочего стола, но и, в критических ситуациях, восстановить Windows. Эти особенности делают приложение полезным в любой ситуации, когда нам нужно так или иначе работать с операционной системой.

     

    К сожалению, иногда нам приходится сталкиваться с трудностями в работе ОС. С выходом обновления под названием “Windows 10 Creators Update”, компания Microsoft выпустила новую функцию, позволяющую скрывать и отключать ненужные разделы конфигурации. Поэтому, если вы хотите ограничить круг лиц, которые будут иметь доступ к определенным параметрам компьютера, вы можете с легкостью отключить любой из них. Например, вы не хотите допустить создания новых аккаунтов на ПК — в этой ситуации можно отключить раздел “Учетные записи”.

     

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

    Для окна “Параметры Windows” ситуация выглядит следующим образом:

    Примите во внимание тот факт, что картина на вашем экране может в определенной степени отличаться. Это вызвано тем, другой пользователь или вредоносное ПО могут скрыть иные разделы, отличные от тех, которые представлены на изображении выше.

    Помимо основного окна параметров, разделы могут исчезать и в других узкоспециализированных настройках (например, раздел “Система” или “Устройства”.

    На скриншоте ниже отсутствуют параметры “Шрифты”, “Пуск” и “Панель задач”.

    Как восстановить отображение разделов в параметрах Windows

    Всего существует два способа восстановления разделов: с помощью редактора локальной групповой политики и редактора реестра. Давайте изучим их подробнее.

    Способ №1. Редактор локальной групповой политики (gpedit.msc)

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

    Выполнить. Запустить инструмент можно:

    1. Нажав правой кнопкой по меню Пуск и выбрав параметр Выполнить.

    2. Открыв меню Пуск и перейдя в раздел Служебные — Windows. Там вы найдете интересующую утилиту.

    3. И, наконец, использовав комбинацию клавиш Windows + R, которая позволит в считанные секунды открыть диалоговое окно программы.

    Чтобы восстановить отображение разделов параметров Windows с помощью редактора локальной групповой политики, выполните следующее:

    1. Откройте утилиту Выполнить любым представленным выше способом.

    2. В диалоговом окне введите команду

    gpedit.msc и нажмите клавишу Enter.

    3. В открывшемся редакторе перейдите по следующему пути: Конфигурация компьютера > Административные шаблоны > Панель управления.

    4. В правом окне вы увидите параметр Отображение страницы параметров. Именно на нем лежит груз ответственности за сокрытие/отображение отдельных разделов “Параметров Windows”.

    Работа политики отображений работает по следующему принципу: вы можете либо указать какие разделы будут скрыты или же какие разделы будут отображаться. Таким образом, вы можете выбрать для себя наиболее удобную модель работы с утилитой.

    1. Щелкните по политике Отображение страницы параметров правой кнопкой мыши и нажмите

    Изменить.

    2. Измените состояние политики в режим Включено.

    Пользуясь представленным ниже шаблоном, вы можете настроить отображение разделов параметров Windows.

    hide:page_URI;page_URI;page_URI

    showonly:page_URI;page_URI;page_URI

    Выбирайте в зависимости от интересующего вас механизма работы (скрыть конкретные разделы или показать конкретные разделы).

    3. Введите, например, команду showonly:personalization-background;themes;colors
    Как результат действий перед вами окажется окно Персонализации с перечисленными вами параметрами. Таким образом вы можете легко управлять отображаемостью разделов.

    4. Аналогична ситуация с использованием команды

    hide, однако выполняется она в обратном порядке.
    hide:display;nightlight;notifications
    Как вы видите, в разделе Система мы скрыли параметры Дисплей, Дисплей — Настройки ночного освещения и Уведомления и действия.

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

    Раздел

    Система

    Устройства

    Телефон

    Сеть и Интернет

    Персонали- зация

    Приложения

    Учетные записи

    Время и язык

    Игры

    Специальные возможности

    Конфиденциаль- ность

    Обновление и безопасность

    Поиск

    Подраздел

    Дисплей

    Дисплей — Ночное освещение

    Уведомления и действия

    Питание и спящий режим

    Батарея

    Использование заряда батареи конкретными приложениями

    Память устройства

    Режим планшета

    Многозадачность

    Проецирование на этот компьютер

    Общие возможности

    Удаленный рабочий стол

    О системе

    Bluetooth и другие устройства

    Принтеры и сканеры

    Мышь

    Сенсорная панель

    Ввод

    Перо и Windows Ink

    Автозапуск

    USB

    Телефон

    Состояние

    Wi-Fi

    Ethernet

    Набор номера

    VPN

    Режим в самолете

    Мобильный хот-спот

    Использование данных

    Прокси-сервер

    Фон

    Цвета

    Экран блокировки

    Темы

    Шрифты

    Пуск

    Панель задач

    Приложения и возможности

    Приложения по умолчанию

    Автономные карты

    Приложения для веб-сайтов

    Воспроизведение видео

    Ваши данные

    Адрес электронной почты; записи приложений

    Параметры входа

    Доступ к учетной записи места работы

    Семья и другие люди

    Синхронизация ваших параметров

    Дата и время

    Регион и язык

    Распознавание голоса

    Меню игры

    DVR для игр

    Трансляция

    Игровой режим

    TruePlay

    Сеть Xbox

    Экранный диктор

    Экранная лупа

    Высокая контрастность

    Скрытые субтитры

    Клавиатура

    Мышь

    Другие параметры

    Общие

    Речь, рукописный ввод и ввод текста

    Диагностика и отзывы

    Расположение

    Камера

    Микрофон

    Уведомления

    Сведения учетной записи

    Контакты

    Календарь

    Журнал вызовов

    Электронная почта

    Задачи

    Обмен сообщениями

    Радио

    Другие устройства

    Фоновые приложения

    Диагностика приложения

    Автоматическое скачивание файлов

    Центр обновления Windows

    Центр обновления Windows — Проверить наличие обновлений

    Центр обновления Windows — Журнал обновлений

    Центр обновления Windows — Параметры перезагрузки

    Центр обновления Windows — Дополнительные параметры

    Безопасность Windows

    Служба архивации

    Устранение неполадок

    Восстановление

    Активация

    Поиск устройства

    Для разработчиков

    Программа предварительной оценки Windows

    Разрешения и журнал

    Подробнее

    Команда

    display

    nightlight

    notifications

    powersleep

    batterysaver

    batterysaver-usagedetails

    storagesense

    tabletmode

    multitasking

    project

    crossdevice

    remotedesktop

    about

    bluetooth

    printers

    mousetouchpad

    devices-touchpad

    typing

    pen

    autoplay

    usb

    mobile-devices

    network-status

    network-wifi

    network-ethernet

    network-dialup

    network-vpn

    network-airplanemod

    network-mobilehotspot

    datausage

    network-proxy

    personalization-background

    colours

    lockscreen

    themes

    fonts

    personalization-start

    taskbar

    appsfeatures

    defaultapps

    maps

    appsforwebsites

    videoplayback

    yourinfo

    emailandaccounts

    signinoptions

    workplace

    otherusers

    sync

    dateandtime

    regionlanguage

    speech

    gaming-gamebar

    gaming-gamedvr

    gaming-broadcasting

    gaming-gamemode

    gaming-trueplay

    gaming-xboxnetworking

    easeofaccess-narrator

    easeofaccess-magnifier

    easeofaccess-highcontrast

    easeofaccess-closedcapttioning

    easeofaccess-keyboard

    easeofaccess-mouse

    easeofaccess-otheroptions

    privacy-general

    privacy-speechtyping

    privacy-feedback

    privacy-location

    privacy-webcam

    privacy-microphone

    privacy-notifications

    privacy-accountinfo

    privacy-contacts

    privacy-calendar

    privacy-callhistory

    privacy-email

    privacy-tasks

    privacy-messaging

    privacy-radios

    privacy-customdevices

    privacy-backgroundapps

    privacy-appdiagnostics

    privacy-automaticfiledownloads

    windowsupdate

    windowsupdate-action

    windowsupdate-history

    windowsupdate-restartoptions

    windowsupdate-options

    windowsdefender

    backup

    troubleshoot

    recovery

    activation

    findmydevice

    developers

    windowsinsiders

    cortana-permissions

    cortana-moredetails

    Отключить скрытие разделов можно путем изменения статуса политики Отображения страницы параметров на Отключено.

    Способ №2. Редактор реестра (regedit)

    Применение редактора реестра является единственным решением для пользователей, работающих с операционной системой “Windows 10 Home Edition”. В ней отсутствует редактор локальной групповой политики и, следовательно, как-то повлиять на отображение разделов параметров Windows можно только с помощью реестра.

    Обратите внимание! Внося какие-либо изменения в реестр операционной системы, вы рискуете повредить ее, совершив неосторожные или необдуманные действия. Поэтому, перед тем как начинать работу, настоятельно рекомендуем вам сделать резервную копию текущего состояния.

    По завершению копирования, давайте приступим непосредственно к редактированию.

    1. Откройте утилиту Выполнить с помощью клавиш Windows + R.

    2. В диалоговом окне введите команду regedit и нажмите Enter.

    3. В появившемся окне с текстом “Разрешить этому приложению вносить изменения на вашем устройстве? подтвердите операцию.

    4. Перед вами появится редактор реестра.

    5. Проследуйте по следующему пути: Компьютер\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Explorer
    При желании, вы можете скопировать адрес и вставить его в диалоговое окно. Это значительно ускорит поиски.

    6. Щелкните правой кнопкой мыши по правой панели редактора и создайте новый Строковый параметр.

    7. Присвойте строке имя PageVisibilitySettings.

    8. Щелкните по новому параметру правой кнопкой мыши и нажмите Изменить.

    9. Примените знания из Способа № 1, чтобы скрыть или отобразить разделы параметров Windows.

    Готово.

    Отключить скрытие разделов можно путем удаления созданной строки.

    Надеемся, представленный материал помог вам решить вопрос скрытия и отображения пропавших разделов утилиты “Параметры Windows”.

     

     


    Похожие статьи про восстановление данных:


    Дата:

    Теги: Windows, Как восстановить, Носитель информации, Программа

    Раздел Параметры

    Раздел Параметры Пожалуйста, включите Javascript в браузере!

    Раздел Параметры

    Развернуть все | Свернуть все

    Раздел Параметры веб-интерфейса программы может содержать следующие закладки:

    • Развертывание

      На закладке Развертывание в разделе Параметры (см. рис. ниже) вы можете просматривать сведения об узлах с установленными компонентами программы, о сетевых интерфейсах и точках мониторинга на узлах. Если подключение к Серверу выполнено под учетной записью пользователя с ролью Администратор, на этой закладке также доступно управление точками мониторинга.

      Раздел Параметры. Закладка Развертывание

      Закладка Развертывание содержит карточки узлов с установленными компонентами программы (слева) и карточки сетевых интерфейсов на узлах (справа от каждого узла). При выборе карточки узла или карточки сетевого интерфейса в правой части окна появляется область деталей.

    • Технологии

      На закладке Технологии в разделе Параметры (см. рис. ниже) вы можете управлять технологиями и методами для анализа трафика в Kaspersky Industrial CyberSecurity for Networks. Закладка Технологии отображается, если подключение к Серверу выполнено под учетной записью пользователя с ролью Администратор.

      Раздел Параметры. Закладка Технологии

      Закладка Технологии содержит список технологий и методов, для которых можно изменять состояния и режимы работы.

    • Пользователи

      На закладке Пользователи в разделе Параметры (см. рис. ниже) вы можете управлять учетными записями пользователей программы. Закладка Пользователи отображается, если подключение к Серверу выполнено под учетной записью пользователя с ролью Администратор.

      Раздел Параметры. Закладка Пользователи

      Закладка Пользователи содержит карточки пользователей программы и карточку со знаком плюс (+) для добавления учетных записей пользователей.

    • Сообщения программы

      На закладке Сообщения программы в разделе Параметры (см. рис. ниже) вы можете просматривать сообщения о работе программы.

      Раздел Параметры. Закладка Сообщения программы

      В верхней части закладки Сообщения программы расположена панель инструментов, которая содержит следующие элементы управления:

      • Поле ввода для поиска – позволяет ввести запрос для поиска сообщений в таблице.
      • Период – позволяет выполнить фильтрацию сообщений программы по периоду времени. Вы можете выбрать один из четырех стандартных периодов или указать период вручную с помощью варианта Задать период. При настройке периода вручную появляются дополнительные поля для выбора даты и времени начала и окончания периода. Если вы указываете период вручную, таблица перестает обновляться.
      • Статусы – позволяет настроить фильтрацию сообщений по их статусам.
      • Очистить фильтр – сбрасывает заданные параметры фильтрации и поиска сообщений в состояние по умолчанию. Кнопка отображается, если заданы параметры фильтрации или поиска.

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

    • Аудит

      На закладке Аудит в разделе Параметры (см. рис. ниже) вы можете просматривать записи журнала аудита, а также включать и выключать аудит действий пользователей. Закладка Аудит отображается, если подключение к Серверу выполнено под учетной записью пользователя с ролью Администратор.

      Раздел Параметры. Закладка Аудит

      В верхней части закладки Аудит расположена панель инструментов, которая содержит следующие элементы управления:

      • Настроить таблицу – открывает окно для настройки отображения таблицы записей аудита. В окне вы можете указать отображаемые графы и изменить порядок их отображения.
      • Поле ввода для поиска – позволяет ввести запрос для поиска записей в таблице.
      • Аудит действий пользователей: включен / выключен – включает и выключает аудит действий пользователей.
      • Период – позволяет выполнить фильтрацию записей аудита по периоду времени. Вы можете выбрать один из четырех стандартных периодов или указать период вручную с помощью варианта Задать период. При настройке периода вручную появляются дополнительные поля для выбора даты и времени начала и окончания периода. Если вы указываете период вручную, таблица перестает обновляться.
      • Результат – группирует кнопки для включения и выключения фильтрации записей аудита по результатам действий: Успешно  и Неуспешно .
      • Очистить фильтр – сбрасывает заданные параметры фильтрации и поиска записей в состояние по умолчанию. Кнопка отображается, если заданы параметры фильтрации или поиска.

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

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

    В начало

    Раздел Параметры

    Показать все | Скрыть все

    В разделе Параметры представлены основные параметры работы Сервера администрирования. В блоке Параметры подключения к Серверу администрирования можно указать порты подключения к Серверу администрирования.

    Номер порта

    В этом поле указывается номер порта, по которому осуществляется подключение к Серверу администрирования. По умолчанию используется порт 14000.

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

    Номер SSL-порта

    В этом поле указывается номер SSL-порта, по которому осуществляется защищенное подключение к Серверу администрирования с использованием протокола SSL. По умолчанию установлен номер порта 13000.

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

    Порт SSL для Консоли администрирования

    В этом поле можно указать номер SSL-порта для подключения Сервера администрироваия к Консоли администрирования.

    По умолчанию используется порт 13291.

    Порт SSL для прокси-сервера активации

    В этом поле можно указать номер SSL-порта для подключения Kaspersky Endpoint Security 10 для Windows к серверам активации «Лаборатории Касперского».

    По умолчанию используется порт 17000.

    Открывать порт для мобильных устройств

    Если флажок установлен, на Сервере администрирования будет открыт порт для мобильных устройств.

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

    По умолчанию флажок снят.

    Порт для мобильных устройств

    В этом поле указывается номер порта, по которому будет осуществляться подключение мобильных устройств к Серверу администрирования. По умолчанию используется порт 13292.

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

    Порт активации мобильных клиентов

    В этом поле можно указать порт подключения Kaspersky Endpoint Security 10 для мобильных устройств к серверам активации «Лаборатории Касперского».

    По умолчанию используется порт 17000.

    HTTP-порт Веб-сервера

    В этом поле можно указать номер порта HTTP, по которому выполняется подключение Веб-сервера к Серверу администрирования.

    По умолчанию используется порт 8060.

    HTTPS-порт Веб-сервера

    В этом поле можно указать номер порта HTTPS, по которому выполняется подключение Веб-сервера к Серверу администрирования.

    По умолчанию используется порт 8061.

    Максимальное количество событий, хранящихся в базе данных

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

    Автоматически назначать компьютеры агентами обновлений

    Если флажок установлен, агенты обновлений назначаются автоматически без участия пользователя.

    По умолчанию флажок снят.

    Пользовательская настройка представления Быстрый доступ в разделе Параметры Fiery

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

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

    Функция Быстрый доступ не поддерживает параметры печати, такие как Базовые настройки и Профессиональные настройки на вкладке Цвет или Смешанные материалы для печати на вкладке Материал для печати, которые открываются в новом окне при выборе.

    Все параметры печати на панели Быстрый доступ находятся за пределами раздела Параметры задания драйвера принтера. При их выборе они переопределяют любые выбранные ранее наборы настроек. Если вы применяете набор настроек и изменили любые настройки на панели Быстрый доступ (за исключением копий), имя набора настроек сбрасывается на пустое.

    1. В приложении нажмите , после чего выберите сервер Fiery Server в качестве принтера.
    2. Нажмите Параметры Fiery в раскрывающемся списке.
    3. Нажмите Настроить, чтобы настроить параметры на панели Быстрый доступ.
    4. Чтобы добавить или удалить сочетание клавиш, выберите его и переместите из списка Возможные клавиши в список Текущие клавиши или из него.

      Примечание: Представление Быстрый доступ не может быть пустым. В случае удаления всех параметров из вкладки Быстрый доступ в ней восстанавливается группа параметров по умолчанию.

    5. Нажмите ОК для сохранения изменений.

      Примечание: Кнопка Настроить для двунаправленной связи не отображается в драйверах принтера для Mac OS X версии 10.7 и более поздних версий.

    Раздел Параметры

    Показать все | Скрыть все

    В разделе Параметры можно настроить параметры задачи удаленной деинсталляции программы.

    Программа для деинсталляции

    В поле отображается название программы, для которой создана задача.

    В блоке параметров Форсировать загрузку утилиты деинсталляции можно выбрать один или несколько способов загрузки утилиты деинсталляции.

    Если установлен флажок С помощью Агента администрирования, файлы будут доставлены средствами Microsoft Windows только в случае невозможности использования средств Агента администрирования.

    Для компьютеров, подключенных к виртуальному Серверу администрирования, передачу файлов средствами Microsoft Windows можно осуществлять только с помощью агентов обновлений этого виртуального Сервера администрирования.

    С помощью Агента администрирования

    Если флажок установлен, загрузка утилиты деинсталляции на клиентские компьютеры будет выполнена с помощью Агента администрирования. Этот вариант можно выбрать, если на клиентском компьютере установлен Агент администрирования.

    По умолчанию флажок установлен.

    Средствами Microsoft Windows с помощью Сервера администрирования

    Если флажок установлен, загрузка утилиты деинсталляции на клиентские компьютеры будет выполнена с помощью Сервера администрирования. Этот вариант можно выбрать, если на клиентском компьютере не установлен Агент администрирования, но клиентский компьютер находится в той же сети, что и Сервер администрирования.

    По умолчанию флажок установлен.

    Средствами Microsoft Windows с помощью агентов обновлений

    Если флажок установлен, файлы передаются на клиентские компьютеры средствами Microsoft Windows через агенты обновлений. Этот вариант можно выбрать, если в сети есть хотя бы один агент обновлений.

    По умолчанию флажок установлен для задач, созданных на виртуальном Сервере администрирования.

    Максимальное количество одновременных загрузок

    В поле можно указать максимальное число клиентских компьютеров, которые могут одновременно загружать данные с Сервера администрирования.

    По умолчанию количество загрузок равно пяти.

    Количество попыток установки

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

    По умолчанию выполняются три попытки установки.

    Предварительно проверять версию операционной системы

    Если флажок установлен, перед загрузкой утилиты деинсталляции будет выполняться проверка версии операционной системы, установленной на клиентском компьютере, на соответствие требованиям к операционной системе.

    По умолчанию флажок снят.

    Где найти раздел параметры

    Привет всем посетителям блога!
    Настоящая статья начинает серию статей о новой операционной системе Windows 10 о ее возможностях и настройках, а также обо всем многом другом.

    В Windows 10 появилось новое приложение состоящие из нескольких страниц под названием «Параметры» которое способно заменить знакомую всем Панель управления.

    Сделано специально для удобства управления на сенсорных экранах, да и обычных тоже. Лично не имею сенсорного экрана поэтому не могу сказать, как это может работать, на простом все хорошо.

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

    Используя данный инструмент, вы можете производить какие-то свои настройки или изменять параметры. Думаю, вы должны знать об этом инструменте, чтобы потом быстро его применить при надобности, которая всегда обязательно периодически возникает.

    Ну так вот, из этой статьи узнаете, где находятся эти параметры системы Windows 10 и как туда попасть тремя путями – способами.

    3 способа как открыть параметры в Windows 10

    Входим Меню пуск видим там вкладку с шестеренкой нажимаем на нее, и мы на месте.


    На Рабочем столе кликаем по папке «мой компьютер» в появившемся окне сверху видим знакомую шестеренку «Открыть параметры».

    Самый быстрый потому как используются горячие клавиши просто нажимаем Win + I и входим сразу в панель параметров. Применяя любой из этих способов, вы легко войдете в параметры Windows 10 своего компьютера.

    На этом не большой сегодняшний обзор окончен.

    В Windows 10 появился новый раздел, который называется «Параметры». Во многом он напоминает панель управления, только имеет доступ к куда большему количеству всевозможных функций. В этой статье мы расскажем, как открыть раздел «Параметры», если вы этого еще не знаете. Способов будет несколько, каким пользоваться — решать вам, все они довольно простые.

    Меню «Пуск» (первый способ)

    Нажимаете на кнопку меню «Пуск» левой клавишей мыши, после чего кликаете по шестеренке.

    Видите перед собой окно «Параметры Windows».

    Меню «Пуск» (второй способ)

    Наводите курсор мыши на кнопку «Пуск» и нажмите на правую клавишу мыши, чтобы появилось меню. В нем выберите строку «Параметры».

    Это же меню можно открыть, если нажать клавиши Win+X на клавиатуре.

    Компьютер (проводник)

    Найдите значок «Компьютер» на рабочем столе и кликните два раза по нему ЛКМ.

    Здесь нажмите на кнопку «Компьютер», а затем — «Открыть параметры».

    Это вариант подойдет, если не работает меню «Пуск».

    Меню поиска

    Нажимаете на строку поиска на панели управления.

    Пишете параметры и нажимаете на приложение.

    Центр уведомлений

    Нажмите на иконку центра уведомлений, после чего выберите «Все параметры».

    Самый быстрый способ

    Все, что вам нужно, это нажать на клавиши Win+i на клавиатуре.

    И будет запущено меню «Параметры».

    Уважаемые пользователи! Если наш сайт вам помог или что-то в нем не понравилось, будем рады, если вы оставите комментарий. Заранее большое спасибо.

    Параметры папок и поиска в Windows 7

    В этой статье мы расскажем вам, где в Windows 7 находятся настройки папок и поиска, а заодно рассмотрим возможности этого интерфейса.

    В предыдущих русскоязычных версиях Windows интерфейс настроек папок носил название «Свойства папки». В русской локализации Windows 7 этот интерфейс получил непривычное, но более точное название – Параметры папок, из-за чего пользователи, которые впервые установили Windows 7, поначалу приходят в небольшое замешательство.

    Где находятся Параметры папок в Windows 7

    Открыть Параметры папок в Windows 7 можно несколькими способами:

    1) Открыть Панель управления (вид «Крупные значки»), затем кликнуть Параметры папок;

    2) Открыть любую папку, нажать Упорядочить и в появившемся меню выбрать Параметры папок и поиска;

    3) Открыть меню Пуск и набрать в строке поиска фразу параметры папок, затем нажать Ввод.

    Настройка параметров папок

    • Вкладка Общие

    1. В разделе Обзор папок пользователь может выбрать, как будут открываться вложенные папки на компьютере – каждая новая папка в том же окне, что и предыдущая (по умолчанию во всех версиях Windows) или каждая в новом окне.

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

    3. В разделе Область переходов настраивается отображение дерева папок в проводнике Windows. Если отметить галочкой пункт Показать все папки, то в Области переходов будут отображаться все папки рабочего стола, включая Корзину, Панель управления и папку вашей учетной записи. Если отметить галочкой пункт Автоматически разворачивать до текущей папки, то в Области переходов будут отображаться все папки, в которые вложена просматриваемая вами папка. Область переходов – это специальная панель, которая находится слева в каждой папке. Область переходов выполняет функцию командной оболочки, обеспечивая быстрый доступ к папкам, быстрое выполнение различных операций – таких, как копирование, удаление, архивирование файлов и папок и т.д.

    Здесь регулируются параметры отображения всех папок на компьютере.

    1. В разделе Представление папок можно применить стиль отображения значков конкретной папки ко всем папкам этого же типа. Например, если вы откроете папку с mp3-файлами, которую система определила как папку с музыкой, и настроите отображение ярлыков в ней в виде таблицы, то благодаря вкладке Вид вы сможете применить стиль её представления ко всем папкам с музыкой. Чтобы сделать это, нажмите кнопку Применить к папкам. В дальнейшем вы всегда сможете отменить эту операцию, нажав кнопку Сброс вида папок.

    2. В разделе Дополнительные параметры доступны несколько параметров. Чтобы включить тот или иной параметр, отметьте его галочкой или выберите нужное значение из предложенных вариантов.

    2.1. Всегда отображать значки, а не эскизы. Если включить этот параметр, то в проводнике Windows будут отображаться только значки и никогда не будут отображаться эскизы (например, в папках с фотографиями и видео).

    2.2. Всегда отображать меню. Если этот параметр включен, то в верхней части всех папок на компьютере появится стандартное меню (Файл, Правка, Вид, Сервис). Если этот параметр выключен, то стандартное меню в папках отображаться не будет, но вы всегда сможете вызвать его, если нажмете клавишу Alt .

    2.3. Выводить полный путь в строке заголовка. Этот параметр работает только в теме «Классическая» и заменяет отображение пути к открытой папке в адресной строке на классическое: C:/Program Files/Common Files/

    2.4. Запускать окна с папками в отдельном процессе. Если включить этот параметр, то каждая папка, открытая в новом окне, будет запускаться в отдельном процессе.

    2.5. Использовать мастер общего доступа. Этот параметр позволяет вам безопасно открывать общий доступ к файлам и папкам через сеть. Если вы никогда не открывали общий доступ к файлам и папкам и не имеете ясного представления о том, как это сделать, не нарушив безопасности, то настоятельно рекомендуем оставить данный параметр включенным.

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

    2.7. Отображать буквы дисков. Если параметр включен, то в папке Компьютер отображаются буквы и метки дисков. Если параметр выключен, то отображаются только метки (названия) дисков.

    2.8. Отображать значки файлов на эскизах. Если параметр включен, то при выключенном параметре 2.1 на каждом графическом файле и видеофайле будет отображаться значок в правом углу эскиза.

    2.9. Отображать обработчики просмотра в панели просмотра. Если параметр включен, то в области просмотра отображаются не только эскизы графических файлов, но и содержимое других файлов – например, текстовых документов. Область просмотра в Windows 7 по умолчанию выключена, и если вы хотите её включить, то откройте любую папку и нажмите кнопку Показать область предварительного просмотра.

    2.10. Отображать описание для папок и элементов рабочего стола. Если этот параметр включен, то при наведении указателя мыши на файл или папку, появляется всплывающая подсказка с информацией об этом файле или папке.

    2.11. Отображать сведения о размере файлов в подсказках папок. Если этот параметр включен, то при наведении указателя мыши на папку, будет выводиться информация о размере вложенных в нее файлов. Если выключить этот параметр, то во всплывающих подсказках будет выводиться только дата создания папки, что снижает нагрузку на жесткий диск. Этот параметр теряет смысл при включенном параметре 2.10.

    2.12. Отображать сжатые или зашифрованные файлы NTFS другим цветом. Если этот параметр включен, то названия сжатых и зашифрованных файлов будут отображаться синим цветом.

    2.13. При вводе текста в режиме «Список». Если этому параметру присвоено значение Выделять введенный элемент в списке (по умолчанию), то при открытии папки вы можете просто набрать на клавиатуре название элемента, и если элемент с таким названием есть в папке, то он будет выделен. Очень удобная функция, когда нужно найти файл в папке, где хранятся несколько десятков или сотен элементов. Функция работает не только в режиме «Список», а во всех режимах отображения элементов. Также можно настроить эту функцию так, чтобы при наборе названия элемента текст сразу вводился в поисковую строку Проводника Windows – для этого выберите значение Автоматически вводить текст в поле поиска.

    2.14. Скрывать защищенные системные файлы (рекомендуется). Если этот параметр включен, то служебные файлы и папки, необходимые для функционирования Windows 7, не будут отображаться даже если вы включите отображение скрытых файлов и папок на компьютере (параметр 2.16).

    2.15. Скрывать расширения для зарегистрированных типов файлов. Если этот параметр выключен, то в конце названия каждого файла будет отображаться его расширение. Расширение указывает на принадлежность файла к тому или иному типу файлов (например, файлы MP3 имеют расширение .mp3). Большинство типов файлов автоматически определяются операционной системой как соответствующие определенным программам. Такие типы файлов называются зарегистрированными и их расширения по умолчанию скрываются для удобства отображения.

    2.16. Скрытые файлы и папки. Если выбрать значение Не показывать скрытые файлы, папки и диски, то все элементы, в свойствах которых активирован атрибут «Скрытый», не будут отображаться.

    2.17. Скрыть пустые диски в папке «Компьютер». Если этот параметр включен, то пустые (новые) диски не будут отображаться в папке Компьютер.

    • Вкладка Поиск

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

    1. Раздел Что искать нужно настраивать, исходя из того, как настроено поисковое индексирование на вашем компьютере. Можно выбрать одно из двух значений:

    1.1. Проиндексированные расположения. Если выбрано это значение, то в непроиндексированных расположениях поиск будет проводиться только по названиям файлов, в проиндексированных – по названиям и по содержимому. Поиск по содержимому файлов важен, когда надо найти слово или фрагмент текста, а название текстового документа вы не помните или не знаете. Не выбирайте это значение, если хотите всегда проводить полнотекстовый поиск.

    1.2. Всегда искать по именам файлов и содержимому. Мы рекомендуем вам выбрать этот параметр, если вы отключили поисковую индексацию. Однако при большом количестве файлов на компьютере, полнотекстовый поиск в неиндексированных расположениях и файлах может затянуться на несколько часов.

    2. В разделе Как искать можно включить или отключить четыре параметра.

    2.1. Включать вложенные папки в результатах поиска при поиске в папках. Если этот параметр включен, то поиск будет проводиться не только в той папке, которая в данный момент открыта, но и во всех папках, которые она содержит.

    2.2. Поиск частичных совпадений. Если этот параметр выключен, то поиск будет проводиться только по полному совпадению с запросом. Например, если на компьютере есть файл с названием «Windows 7 – Впечатления и факты.txt», то при выключенном параметре Поиск частичных совпадений вы сможете найти его по запросам «Windows», «7″, «впечатления», «факты» и даже по таким запросам как «факты Windows 7″. Если поиск частичных совпадений включен, то вы сможете найти этот файл даже по таким запросам, как «Win».

    2.3. Использовать языковой поиск. Если этот параметр включен, то при вводе поискового запроса Windows 7 будет пытаться использовать морфологические особенности языка. Судя по нашим небольшим тестам, с русским языком у Windows 7 пока есть проблемы. Например, не получается найти файл с названием «Дубовый.txt», если вводить запрос «дубовая». Поэтому языковой поиск пока можно отключать в целях экономии системных ресурсов.

    2.4. Не использовать индекс при поиске системных файлов в папках. Если этот параметр включен, то поиск системных файлов будет проводиться каждый раз как впервые, что замедляет процесс поиска. При выключенном индексировании системных файлов, параметр лучше включить.

    3. Раздел При поиске в неиндексированных расположениях – доступны два параметра:

    3.1. Включать системные файлы. Если этот параметр выключен, то поиск системных файлов не будет проводиться.

    3.2. Включать сжатые файлы. Если этот параметр включен, то поиск будет проводиться не только по обычным файлам и папкам, но и по содержимому тех архивов, которые Windows 7 способна открыть своими средствами.

    Как использовать параметры в правилах раздела

    Сводка

    Правила раздела, созданные в V5.4SP2 +, имеют вкладку «Параметры» и могут принимать значения параметров. К значениям параметров можно получить доступ в определенных ситуациях в разделе. Значения для параметров могут быть установлены в других правилах — во время разработки приложения — или динамически во время выполнения.

    В этом разделе представлен пример параметризованного раздела.

    Предлагаемый подход

    Как и форма правила свойства HTML, форма действия и формы отчета, форма раздела имеет вкладку «Параметры».В V5.4SP2 вы можете ссылаться на значения параметров в любом из трех мест:

    • Как текст на этикетке
    • Как текст заголовка кнопки
    • В качестве источника значения параметра для правила свойства HTML.

    Параметризация способствует совместному использованию и повторному использованию, что позволяет создавать приложение с меньшим количеством правил разделов, которые необходимо поддерживать. Значения для параметров могут предоставляться либо во время разработки, либо динамически во время выполнения (если они вычисляются действием.)

    Шаг 1. Определите параметры

    Создайте правило раздела. Оставить автоматически созданный? установлен флажок (на вкладке HTML).

    Заполните вкладку «Параметры». Эта вкладка в форме раздела похожа на вкладку в других формах правил. Выберите имя для каждого параметра, которое начинается с буквы и использует только буквы и цифры.

    Введите текстовое описание и выберите тип ( String , Boolean или Integer ). Остальные столбцы необязательны.

    Шаг 2. Ссылка на параметры в разделе

    В правиле раздела используйте обозначение имя параметра для ссылки на значение параметра, где имя — это имя параметра.

    Например, в этом разделе — только для демонстрационных целей — есть по одному примеру каждого использования.

    Вторая строка содержит свойство, отформатированное с помощью правила свойства CurrencyAmount HTML, которое принимает параметр Size :

    Наконец, вы можете установить заголовок кнопки для значения параметра.

    Сохраните форму правила раздела. На этом этапе вы можете протестировать работу параметров с помощью кнопки «Выполнить» на панели инструментов.

    Шаг 3: Введите значения параметров во время разработки

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

    В демонстрационных целях раздел примера ThreeParams добавлен к действию потока с именем SectionParameters. Щелкните увеличительное стекло на вкладке «Раздел» на панели свойств ячейки, чтобы ввести значения параметров.

    В этом примере буквальные значения констант для трех параметров — «Метка», «Заголовок» и «15». Если тот же раздел включен в другое действие потока, могут быть предоставлены другие значения параметров.

    Во время выполнения пользователь действия потока видит эффект значений параметров:

    Или шаг 4: укажите значения параметров во время выполнения

    В качестве альтернативы ваше приложение может вычислять значения параметров во время выполнения с действием, сохраняя их на странице параметров действия, идентифицируя их как Out в столбце In / Out.

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

    Чтобы упростить пример, это действие просто устанавливает для параметров Out другие литеральные значения:

    Чтобы передать страницу параметров действия в раздел, установите флажок Передать текущую страницу параметров на панели параметров формы действия потока.

    Во время выполнения значения параметра Out , вычисленные действием, передаются в раздел (и в правило свойства HTML, указанное в разделе). Хотя это действие очень простое, другие действия могут использовать любые вычисления, подходящие для вычисления Out значения параметра.

    Параметры | Конфигурация StyleBook

    Этот раздел позволяет вам определить все параметры, которые вам требуются в вашей StyleBook для создания конфигурации.Он описывает ввод, который принимает ваш StyleBook. Хотя этот раздел является необязательным, большинству StyleBook он может понадобиться. Вы можете рассмотреть раздел параметров, чтобы определить поля для пользователей, которые используют StyleBook для создания конфигурации в экземпляре Citrix ADC.

    Когда вы импортируете StyleBook в Citrix Application Delivery and Management и используете его для создания конфигурации, графический интерфейс использует этот раздел StyleBook для отображения формы. Эта форма принимает входные данные для определенных значений параметров.

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

    «Имя»

    Имя параметра, который вы хотите определить. Вы можете указать буквенно-цифровое имя.

    Имя должно начинаться с алфавита и может включать дополнительные буквы, цифры, дефис (-) или подчеркивание (_).

    При написании StyleBook вы можете использовать этот атрибут «name» для ссылки на параметр в других разделах с помощью обозначения $ parameters.<имя>.

    Обязательно ? Да

    «Ярлык»

    Строка, отображаемая в графическом интерфейсе Citrix Application Delivery and Management GUI в качестве имени этого параметра.

    Обязательно ? №

    «Описание»

    Строка справки, описывающая, для чего используется параметр. Графический интерфейс доставки и управления приложениями Citrix отображает этот текст, когда пользователь щелкает значок справки для этого параметра.

    Обязательно ? №

    «Тип»

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

    • строка : массив символов. Если длина не указана, строковое значение может принимать любое количество символов. Однако вы можете ограничить длину строкового типа с помощью атрибутов min-length и max-length.

    • число : целое число. Вы можете указать минимальное и максимальное количество, которое может принимать этот тип, с помощью атрибутов min-value и max-value.

    • boolean : Может принимать значение true или false. YAML рассматривает все литералы как логические (например, Да или Нет).

    • ipaddress : строка, представляющая действительный адрес IPv4 или IPv6.

    • ipnetwork : состоит из двух частей. Первая часть — это IP-адрес, а вторая — сетевая маска.

      Сетевая маска представлена ​​длиной сетевой маски ( netmask-len ) или IP-адресом сетевой маски ( netmask_ip ).Длина маски сети — это целое число от 0–32 до 0–128 для адреса IPv6. Он используется для определения количества IP-адресов в сети.

    • tcp-port : число от 0 до 65535, которое представляет порт TCP или UDP.

    • пароль : представляет непрозрачное / секретное строковое значение. Когда в графическом пользовательском интерфейсе доставки и управления приложениями Citrix отображается значение этого параметра, оно отображается в виде звездочек (*****).

    • certfile : представляет файл сертификата.Это значение позволяет загружать файлы непосредственно из локальной системы при создании конфигурации StyleBook с помощью графического интерфейса Citrix Application Delivery and Management. Загруженный файл сертификата хранится в каталоге / var / mps / tenants / \ / ns_ssl_certs в Citrix Application Delivery and Management.

      Файл сертификата добавлен в список сертификатов, которым управляет Citrix Application Delivery and Management.

    • ключевой файл : представляет файл ключа сертификата.Это значение позволяет загружать файл непосредственно из локальной системы при создании конфигурации StyleBook с использованием графического интерфейса Citrix Application Delivery and Management. Загруженный файл сертификата хранится в каталоге / var / mps / tenants / \ / ns_ssl_keys в Citrix Application Delivery and Management.

      Файл ключа сертификата добавлен в список ключей сертификатов, которым управляет Citrix Application Delivery and Management.

    • certkey : этот тип используется, когда вы хотите разрешить пользователям выбирать сертификаты SSL из хранилища сертификатов Citrix Application Delivery and Management.В этом хранилище перечислены существующие сертификаты SSL, загруженные на сервер доставки и управления приложениями Citrix. Таким образом, вы можете хранить сертификаты SSL в одном месте, которое является хранилищем сертификатов Citrix Application Delivery and Management, и повторно использовать их при необходимости.

      При создании пакета конфигурации пользователь может добавлять или выбирать сертификаты SSL из хранилища сертификатов. Кроме того, пользователь может выбрать один и тот же сертификат для нескольких пакетов конфигурации.

    • файл : представляет файл.

    • объект : этот тип используется, когда вы хотите сгруппировать несколько связанных параметров под родительским элементом. Укажите родительский параметр типа «объект». Параметр типа «объект» может иметь вложенный раздел «параметры» для описания параметров, которые он содержит.

    • другой StyleBook : Когда вы используете этот тип параметра, тогда этот параметр ожидает, что его значение будет в форме параметров, определенных в StyleBook, обозначающих его тип.

    Параметр также может иметь тип , который является списком типов. Для этого добавьте [] в конце типа. Например, если атрибут типа строка [] , этот параметр принимает список строк в качестве входных. Вы можете указать одну, две или несколько строк для этого параметра при создании конфигурации из этой StyleBook.

    Обязательно ? Да

    «Сеть»

    Для типа : ipaddress можно указать атрибут network для автоматического выделения IP-адреса из сети Citrix Application Delivery and Management IPAM.

    Citrix Application Delivery and Management автоматически выделяет IP-адрес из сетевого атрибута при создании конфигурации StyleBook.

    Пример:

      имя: виртуальный IP
          label: "IP-адрес балансировщика нагрузки"
          тип: ipaddress
          сеть: "сеть-1"
          требуется: true
    
      

    В этом примере поле virtual-ip автоматически выделяет IP-адрес из сети network-1 .IP-адрес возвращается в сеть при удалении конфигурации.

    «Динамическое размещение»

    Атрибут динамического распределения добавлен в определение параметра типа : ipaddress . Используйте этот атрибут для динамического вывода списка IPAM-сетей Citrix Application Delivery and Management. Этот атрибут может принимать в качестве входных данных true или false . Для типа : ipaddress укажите атрибут dynamic-allocation: true , чтобы динамически отображать IPAM-сети Citrix Application Delivery and Management, которые находятся в Citrix Application Delivery and Management.В форме создания пакета конфигурации вы можете сделать следующее:

    1. Выберите из списка необходимую IPAM-сеть.

    2. Укажите IP-адрес, который вы хотите выделить из выбранной сети IPAM.

      Если IP-адрес не указан, Citrix Application Delivery and Management автоматически выделяет IP-адрес из выбранной сети IPAM.

    Пример:

      -
        имя: виртуальный IP
        label: "IP-адрес балансировщика нагрузки"
        тип: ipaddress
        динамическое распределение: истина
        требуется: true
    
      

    В этом примере в поле virtual-ip перечислены IPAM-сети Citrix Application Delivery and Management и Citrix Application Delivery and Management.Выберите сеть из списка для автоматического выделения IP-адреса из сети. IP-адрес возвращается в сеть при удалении конфигурации.

    «Ключ»

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

    StyleBook может иметь только один параметр, определенный как «ключевой».

    Когда вы создаете разные конфигурации из одной книги стилей (в одной или разных экземпляров ADC), каждая конфигурация имеет различное / уникальное значение для этого параметр.

    Значение по умолчанию — false.

    Обязательно ? №

    «Требуется»

    Укажите истину или ложь, чтобы указать, является ли параметр обязательным или необязательным. Если это установлено значение true, параметр является обязательным, и пользователь должен указать значение для этого параметр при создании конфигураций.

    Графический интерфейс доставки и управления приложениями Citrix заставляет пользователя указать допустимое значение для этого параметра.

    Значение по умолчанию — false.

    Обязательно ? №

    «Допустимые значения»

    Используйте этот атрибут, чтобы определить список допустимых значений для параметра, если для типа задано значение «строка».

    При создании конфигурации из графического интерфейса Citrix Application Delivery and Management пользователю предлагается выбрать значение параметра из этого списка. Этот список является статическим, пользователь может только выбрать значение из списка. Если вы хотите разрешить пользователю добавлять значения в список, используйте атрибут allow-new-values ​​.

    Примечание

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

    Пример 1 :

      -
          имя: ipaddress
          тип: строка
          допустимые значения:
                - ИСТОЧНИК
                - DEST IP
                -  НИКТО
    
      

    Пример 2 :

      -
          имя: Порт TCP
          тип: tcp-порт
          допустимые значения:
                - 80
                - 81
                - 8080
    
      

    Пример 3 :

    Список tcp-портов , где каждый элемент списка может иметь только значения, указанные в разрешенных значениях .

      -
          имя: tcpports
          тип: tcp-port []
          допустимые значения:
                - 80
                - 81
                - 8080
                - 8081
    
      

    Обязательно ? №

    «Allow-new-values»

    Используйте этот атрибут, чтобы добавить динамический список для параметра. При создании или обновлении конфигурации из графического интерфейса Citrix Application Delivery and Management, пользователь может добавлять значения в список.

    Укажите true, если вы хотите, чтобы пользователь добавил значение в список параметров.Вы можете использовать атрибуты allow-new-values ​​ и allowed-values ​​ в комбинации. Эта комбинация позволяет вам определить список предлагаемых значений для параметра, а также принять новые значения.

      -
          имя: порт
          тип: tcp-порт
          допустимые значения:
                - 80
                - 81
                - 8080
          разрешить новые значения: правда
    
      

    В этом примере пользователь может либо выбрать из 80, 81, 8080, либо ввести новое значение для параметра порт при создании или обновлении пакета конфигурации.

    «По умолчанию»

    Используйте этот атрибут, чтобы присвоить значение по умолчанию необязательному параметру. Когда пользователь создает конфигурацию без указания значения, используется значение по умолчанию.

    Параметр не принимает значения, если выполняются следующие условия:

    Пример 1 :

      -
          имя: тайм-аут
          тип: число
          по умолчанию: 20
    
      

    Пример 2 :

    Для вывода значений параметра по умолчанию:

      -
          имя: протоколы
          тип: строка []
          дефолт:
                - TCP
                - UDP
                - IP
    
      

    Пример 3 :

      -
          имя: тайм-аут
          тип: число
          по умолчанию: 20
    
      

    Пример 4 :

      -
          имя: tcpport
          тип: tcp-порт
          по умолчанию: 20
    
      

    Обязательно ? №

    «Узор»

    Используйте этот атрибут, чтобы определить шаблон (регулярное выражение) для допустимых значений этого параметр, если тип параметра — «строка.”

    Пример :

      -
          имя: имя приложения
          тип: строка
          узор: «[а-я] +»
    
      

    Обязательно ? №

    «Минимальное значение»

    Используйте этот атрибут, чтобы определить минимальное значение для параметров типа number или tcp-port .

    Пример :

      -
          имя: аудио-порт
          тип: tcp-порт
          минимальное значение: 5000
    
      

    Минимальное значение чисел может быть отрицательным.Однако минимальное значение для tcp-порта должно быть положительным.

    Обязательно ? №

    «Максимальное значение»

    Используйте этот атрибут, чтобы определить максимальное значение для параметров типа номер или TCP-порт .

    Убедитесь, что максимальное значение больше минимального, если оно определено.

    Пример :

      -
          имя: аудио-порт
          тип: tcp-порт
          минимальное значение: 5000
          максимальное значение: 15000
    
      

    Обязательно ? №

    «Минимальная длина»

    Используйте этот атрибут, чтобы определить минимальную длину значений, принимаемых для параметра введите «строка.”

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

    Пример :

      -
          имя: имя приложения
          тип: строка
          мин-длина: 3
    
      

    Обязательно ? №

    «Максимальная длина»

    Используйте этот атрибут, чтобы определить максимальную длину значений, принимаемых для параметра введите «строка».

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

    Пример :

      -
          имя: имя приложения
          тип: строка
          максимальная длина: 64
    
      

    Обязательно ? №

    ‘Min-items’

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

    Убедитесь, что минимальное количество элементов больше или равно нулю.

    Пример :

      -
          имя: server-ips
          тип: ipaddress []
          min-items: 2
    
      

    Обязательно ? №

    «Max-items»

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

    Убедитесь, что максимальное количество элементов превышает минимальное количество элементов, если оно определено.

    Пример :

      -
          имя: server-ips
          тип: ipaddress []
          min-items: 2
          макс. предметов: 250
    
      

    Обязательно ? №

    ‘Gui’

    Используйте этот атрибут для настройки макета параметра в графическом интерфейсе Citrix Application Delivery and Management.

    Обязательно ? №

    «Столбцы»

    Этот атрибут является податрибутом атрибута gui .Используйте этот атрибут, чтобы определить количество столбцов для отображения параметров type: object [] в графическом интерфейсе Citrix Application Delivery and Management.

    Обязательно ? №

    «Обновляемый»

    Этот атрибут является податрибутом атрибута gui . Используйте этот атрибут, чтобы указать, можно ли обновить параметр после создания конфигурации. Устанавливайте этот атрибут только для простых типов параметров, таких как строка, логическое значение или число.

    Если установлено значение false , поле параметра становится серым при обновлении конфигурации.

    Обязательно ? №

    «Collapse_pane»

    Этот атрибут является податрибутом атрибута gui . Используйте этот атрибут, чтобы указать, является ли панель, определяющая макет этого параметра объекта, сворачиваемой.

    Если задано значение true, пользователь может развернуть или свернуть дочерние параметры этого родительского параметра.

    Пример :

      графический интерфейс:
    
     collapse_pane: true
    
     столбцы: 2
    
      

    Пример полного раздела параметров:

     
    параметры:
    
       -
    
          имя: имя
    
          label: Имя
    
          описание: Название приложения
    
          тип: строка
    
          требуется: true
    
       -
    
          имя: ip
    
          метка: IP-адрес
    
          описание: виртуальный IP-адрес, используемый для этого приложения.
    
          тип: ipaddress
    
          требуется: true
    
       -
    
          имя: svc-серверы
    
          label: Серверы
    
          тип: объект \ [\]
    
          требуется: true
    
          параметры:
    
            -
    
                  имя: svc-ip
    
                  label: IP-адрес сервера
    
                  описание: IP-адрес сервера
    
                  тип: ipaddress
    
                  требуется: true
    
            -
    
                  имя: svc-port
    
                  label: Порт сервера
    
                  описание: TCP-порт сервера
    
                  тип: tcp-порт
    
                  по умолчанию: 80
    
            -
    
                  имя: lb-alg
    
                  label: Алгоритм балансировки нагрузки
    
                  тип: строка
    
                  допустимые значения:
    
                     - ПО-КРУГОВОЙ
    
                     - ПОДКЛЮЧЕНИЕ
    
                  по умолчанию: ROUNDROBIN
    
            -
    
                  имя: enable-healthcheck
    
                  label: Включить HealthCheck?
    
                  тип: логический
    
                  по умолчанию: true
    
      

    Ниже приведен пример, который определяет все атрибуты списка и значения, описанные в предыдущих разделах:

     
            -
                  имя: список-функций
    
                  тип: строка []
    
                  мин-длина: 1
    
                  максимальная длина: 3
    
                  min-items: 1
    
                  макс. предметов: 3
    
                  шаблон: "\ [A-Z \] +"
    
                  допустимые значения:
    
                    - СП
    
                    - ФУНТ
    
                    - CS
    
                  дефолт:
    
                    - ФУНТ
    
      

    «Макет»

    Этот атрибут является податрибутом атрибута gui .Используйте этот атрибут для отображения значений списка в виде переключателей. Установите для атрибута макета значение radio в разделе параметров определения StyleBook. Он применяется к параметру, имеющему атрибут разрешенных значений . Когда вы создаете пакет конфигурации, графический интерфейс Citrix Application Delivery and Management отображает значения из списка разрешенных значений в виде переключателей.

    Пример:

      -
        графический интерфейс:
            расположение: радио
        допустимые значения:
            - Один
            - Два
            - Три
    
      

    Значения «Один», «Два» и «Три» отображаются как переключатели в графическом интерфейсе Citrix Application Delivery and Management.

    «Зависимые параметры»

    Этот атрибут является податрибутом атрибута gui . Он динамически управляет внешним видом параметра или его начальным значением в форме конфигурации StyleBook на основе значения, указанного в другом параметре.

    Укажите этот атрибут в параметре источника, который управляет поведением параметра в форме. Вы можете включить несколько условий, которые управляют другими параметрами. Например, исходный параметр , протокол может иметь сертификат зависимого параметра , который появляется только в том случае, если значение параметра протокола равно SSL .

    Каждое условие может иметь следующие атрибуты:

    • целевой параметр : укажите целевой параметр, к которому применяется это условие.

    • соответствующие значения : укажите список значений исходного параметра, запускающих действие.

    • действие : Укажите одно из следующих действий над целевым параметром:

      • только для чтения : параметр доступен только для чтения.

      • показать : Параметр отображается в форме, если он скрыт.

      • скрыть : Параметр удален из формы.

      • set-value : значение параметра устанавливается равным значению, указанному в атрибуте value.

    • значение : значение целевого параметра, если действие - заданное значение .

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

    Пример:

      -
        имя: lb-виртуальный порт
        label: "Виртуальный порт приложения со сбалансированной нагрузкой"
        описание: «TCP-порт, представляющий приложение с балансировкой нагрузки»
        тип: tcp-порт
        графический интерфейс:
          обновляемый: false
          зависимые параметры:
                -
                  соответствующие значения:
                    - 80
                  целевой параметр: $ parameters.фунт-сервис-тип
                  действие: заданное значение
                  допустимые значения:
                  - HTTP
                  - TCP
                  - UDP
    
        по умолчанию: 80
    
    
      

    В этом примере зависимый параметр указан в параметре lb-virtual-port (параметр источника).

    Когда значение исходного параметра установлено на 80 , параметр lb-service-type запускает действие с заданным значением . В результате пользователь может выбрать один из следующих вариантов:

    Описание параметров

    OAS 2 Эта страница относится к OpenAPI Specification ver.2 (fka Swagger). Чтобы узнать о последней версии, посетите страницы OpenAPI 3.

    Описание параметров

    В Swagger параметры операции API определены в разделе параметры в определении операции. Каждый параметр имеет имя , значение тип (для параметров с примитивными значениями) или схему (для тела запроса) и необязательное описание . Вот пример:
      пути:
      / users / {userId}:
        получать:
          Сводка: получает пользователя по идентификатору.параметры:
            - в: путь
              имя: userId
              тип: целое число
              требуется: true
              описание: числовой идентификатор пользователя, которого нужно получить.
      
    Обратите внимание, что параметры - это массив, поэтому в YAML каждое определение параметра должно быть указано с тире () перед ним.

    Типы параметров

    Swagger различает следующие типы параметров в зависимости от их расположения. Местоположение определяется параметром в ключе , например в: query или в: path .

    Параметры запроса

    Параметры запроса - это наиболее распространенный тип параметров. Они появляются в конце URL-адреса запроса после вопросительного знака (? ) с разными парами имя = значение , разделенными амперсандами ( и ). Параметры запроса могут быть обязательными и необязательными.
      GET / pets / findByStatus? Status = available
    GET / notes? Смещение = 100 и лимит = 50
      
    Используйте в: query для обозначения параметров запроса:
      параметры:
            - в: запрос
              имя: смещение
              тип: целое число
              описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.- в: запрос
              имя: предел
              тип: целое число
              описание: количество возвращаемых товаров.
      

    Параметры запроса поддерживают только примитивные типы. У вас может быть массив , но элементы должны быть примитивным типом значения. Объекты не поддерживаются.

    Примечание: Для описания ключей API, переданных в качестве параметров запроса, используйте вместо этого определение безопасности. См. Ключи API.

    Параметры пути

    Параметры пути - это компоненты пути URL, которые могут варьироваться.Обычно они используются для указания на определенный ресурс в коллекции, например на пользователя, идентифицированного по идентификатору. URL-адрес может иметь несколько параметров пути, каждый из которых обозначен фигурными скобками {} .
      GET / пользователей / {id}
    ПОЛУЧИТЬ / cars / {carId} / drivers / {driverId}
      
    Каждый параметр пути должен быть заменен фактическим значением, когда клиент выполняет вызов API. В Swagger параметр пути определяется с помощью in: path и других необходимых атрибутов. Имя параметра должно быть таким же, как указано в пути.Также не забудьте добавить required: true , потому что параметры пути требуются всегда. Вот пример для GET / users / {id} :
      пути:
      / users / {id}:
        получать:
          параметры:
            - в: путь
              name: id # Обратите внимание, что имя такое же, как в пути
              требуется: true
              тип: целое число
              минимум: 1
              описание: ID пользователя.
           ответы:
             200:
               описание: ОК
      
    Параметры пути могут быть многозначными, например GET / users / 12,34,56 .Это достигается указанием типа параметра как массив . См. Раздел «Параметры массива и многозначные параметры» ниже. Для вызова API может потребоваться отправка настраиваемых заголовков с HTTP-запросом. Swagger позволяет определять настраиваемые заголовки запросов как в параметрах: header . Например, предположим, что для вызова GET / ping требуется заголовок X-Request-ID :
      GET / пинг HTTP / 1.1
    Хост: example.com
    X-Request-ID: 77e1c83b-7bb0-437b-bc50-a7a58e5660ac
      
    В Swagger вы бы определили эту операцию следующим образом:
      пути:
      /пинг:
        получать:
          Сводка: Проверяет, жив ли сервер.параметры:
            - в: заголовок
              имя: X-Request-ID
              тип: строка
              требуется: true
      

    Аналогичным образом вы можете определить собственные заголовки ответов.

    Примечание. В спецификации Swagger есть специальные ключевые слова для некоторых заголовков:

    Заголовок Swagger Ключевые слова Для получения дополнительной информации см. ...
    Content-Type потребляет (тип содержимого запроса)
    создает (тип содержимого ответа)
    Типы MIME
    Принять производит Типы MIME
    Авторизация безопасность Определения , безопасность Аутентификация

    Параметры формы

    Параметры формы используются для описания полезной нагрузки запросов с Content-Type из:
    • application / x-www-form-urlencoded (используется для POST примитивных значений и массивов примитивных значений).
    • multipart / form-data (используется для загрузки файлов или комбинации файлов и примитивных данных).
    То есть, свойство потребляет операции должно указывать один из этих типов содержимого. Параметры формы определены как в: formData . Это могут быть только примитивы (строки, числа, логические значения) или массивы примитивов (то есть вы не можете использовать $ ref в качестве значения items ). Кроме того, параметры формы не могут сосуществовать с параметром in: body , поскольку formData - это особый способ описания тела.Чтобы проиллюстрировать параметры формы, рассмотрим HTML-форму POST:
      
    Эта форма отправляет данные в конечную точку формы:
      POST / опрос HTTP / 1.1
    Хост: example.com
    Тип содержимого: application / x-www-form-urlencoded
    Длина содержимого: 29
    
    name = Эми + Смит & fav_number = 321
      
    В Swagger вы можете описать конечную точку следующим образом:
      пути:
      /опрос:
        Почта:
          Резюме: образец опроса.потребляет:
            - приложение / x-www-form-urlencoded
          параметры:
            - в: formData
              имя: имя
              тип: строка
              описание: Имя человека.
            - в: formData
              name: fav_number
              тип: число
              описание: Любимое число человека.
          ответы:
            200:
              описание: ОК
      
    Чтобы узнать, как определить параметры формы для загрузки файлов, см. Загрузка файла.

    Обязательные и дополнительные параметры

    По умолчанию Swagger рассматривает все параметры запроса как необязательные. Вы можете добавить required: true , чтобы пометить параметр как требуемый. Обратите внимание, что в параметрах пути должно быть указано required: true , потому что они требуются всегда.
      параметры:
            - в: путь
              имя: userId
              тип: целое число
              требуется: true # <----------
              описание: числовой идентификатор пользователя, которого нужно получить. 

    Значения параметров по умолчанию

    Вы можете использовать ключ по умолчанию , чтобы указать значение по умолчанию для необязательного параметра. Значение по умолчанию - это то, что сервер использует, если клиент не предоставляет значение параметра в запросе. Тип значения должен совпадать с типом данных параметра. Типичный пример - параметры подкачки, такие как смещение и ограничение:
      GET / пользователей
    GET / пользователи? Offset = 30 & limit = 10
      
    Предполагая, что смещение по умолчанию равно 0, а ограничение по умолчанию - 20 и находится в диапазоне от 0 до 100, вы должны определить эти параметры как:
      параметры:
            - в: запрос
              имя: смещение
              тип: целое число
              требуется: ложь
              по умолчанию: 0
              минимум: 0
              описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.- в: запрос
              имя: предел
              тип: целое число
              требуется: ложь
              по умолчанию: 20
              минимум: 1
              максимум: 100
              описание: количество возвращаемых товаров.
      
    Распространенные ошибки
    Есть две распространенные ошибки при использовании ключевого слова по умолчанию :
    • Использование по умолчанию с обязательными параметрами или свойствами , например, с параметрами пути.Это не имеет смысла - если значение требуется, клиент всегда должен его отправлять, а значение по умолчанию никогда не используется.
    • Использование по умолчанию для указания значения выборки. Это не предназначено для использования по умолчанию и может привести к неожиданному поведению в некоторых инструментах Swagger. Некоторые элементы спецификации поддерживают ключевое слово example или examples для этой цели.

    Параметры перечисления

    Ключевое слово enum позволяет ограничить значение параметра фиксированным набором значений.Значения перечисления должны быть того же типа, что и параметр типа .
      - в: запрос
              имя: статус
              тип: строка
              enum: [доступно, ожидает рассмотрения, продано]
      
    Дополнительная информация: Определение Enum.

    Массив и многозначные параметры

    Параметры пути, запроса, заголовка и формы могут принимать список значений, например:
      GET / пользователи / 12,34,56,78
    GET / ресурс? Param = значение1, значение2, значение3
    GET / resource? Param = value1 & param = value2 & param = value3
    
    POST / ресурс
    параметр = значение1 & параметр = значение2
      
    Параметр с несколькими значениями должен быть определен с типом : массив и соответствующий collectionFormat .
      # цвет = красный, черный, белый
          параметры:
            - в: запрос
              имя: цвет
              тип: массив
              collectionFormat: csv
              Предметы:
                тип: строка
      
    collectionFormat определяет формат массива (один параметр с несколькими параметрами или несколько параметров с одним и тем же именем) и разделитель для элементов массива.
    коллекцияФормат Описание Пример
    csv (по умолчанию) Значения, разделенные запятыми. foo, bar, baz
    SSV Значения, разделенные пробелами. foo bar baz
    цв Значения, разделенные табуляцией. "foo \ tbar \ tbaz"
    трубы Значения, разделенные конвейером. foo | bar | baz
    мульти Несколько экземпляров параметра вместо нескольких значений.Это поддерживается только для параметров in: query и in: formData . foo = значение & foo = другое_значение
    Дополнительно вы можете:
    • использовать minItems и maxItems для управления размером массива,
    • применять уникальные элементы ,
    • ограничивает элементы массива фиксированным набором из enum значений.
    Например:
      - в: запрос
              имя: цвет
              требуется: ложь
              тип: массив
              minItems: 1
              maxItems: 5
              uniqueItems: true
              Предметы:
                тип: строка
                enum: [черный, белый, серый, красный, розовый, оранжевый, желтый, зеленый, синий, фиолетовый, коричневый]
      
    Вы также можете указать массив по умолчанию, который сервер будет использовать, если этот параметр не указан:
      - в: запрос
              имя: сортировка
              требуется: ложь
              тип: массив
              Предметы:
                тип: строка
              по умолчанию: ["-modified", "+ id"]
      

    Постоянные параметры

    Вы можете определить постоянный параметр как обязательный параметр только с одним возможным значением:
      - требуется: true
      перечисление: [значение]
      

    Свойство перечисления определяет возможные значения.В этом примере можно использовать только одно значение, и это будет единственное значение, доступное в пользовательском интерфейсе Swagger для выбора пользователем.

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

    Параметры без значения

    Строка запроса и параметры данных формы могут иметь только имя и не иметь значения:
      GET / foo? Метаданные
    
    POST / что-то
    foo & bar & baz
      
    Используйте allowEmptyValue для описания таких параметров:
      - в: запрос
              имя: метаданные
              требуется: true
              тип: логический
              allowEmptyValue: true # <-----
      

    Общие параметры

    Общие параметры для всех методов пути
    Параметры могут быть определены в самом пути, в этом случае параметры существуют во всех операциях, описанных в этом пути.Типичным примером являются операции GET / PUT / PATCH / DELETE, которые управляют одним и тем же ресурсом, доступ к которому осуществляется через параметр пути.
      пути:
      /ID пользователя}:
        параметры:
          - в: путь
            имя: id
            тип: целое число
            требуется: true
            описание: ID пользователя.
    
        получать:
          Сводка: получает пользователя по идентификатору.
          ...
        пластырь:
          Сводка: обновляет существующего пользователя с указанным идентификатором.
          ...удалять:
          сводка: удаляет пользователя с указанным идентификатором.
          ...
      
    Любые дополнительные параметры, определенные на уровне операции, используются вместе с параметрами уровня пути:
      пути:
      / users / {id}:
        параметры:
          - в: путь
            имя: id
            тип: целое число
            требуется: true
            описание: ID пользователя.
    
        # GET / users / {id}? Metadata = true
        получать:
          Сводка: получает пользователя по идентификатору.# Обратите внимание, что мы определяем только параметр запроса, потому что {id} определяется на уровне пути.
          параметры:
            - в: запрос
              имя: метаданные
              тип: логический
              требуется: ложь
              описание: если true, конечная точка возвращает только метаданные пользователя.
          ответы:
            200:
              описание: ОК
      
    Определенные параметры уровня пути могут быть переопределены на уровне операции, но не могут быть удалены.
      пути:
      / users / {id}:
        параметры:
          - в: путь
            имя: id
            тип: целое число
            требуется: true
            описание: ID пользователя.
    
        # DELETE / users / {id} - использует один идентификатор.
        # Повторно использует определение параметра {id} на уровне пути.
        удалять:
          сводка: удаляет пользователя с указанным идентификатором.
          ответы:
            204:
              описание: Пользователь удален.
    
        # GET / users / id1, id2, id3 - использует один или несколько идентификаторов пользователей.# Переопределяет параметр {id} на уровне пути.
        получать:
          Сводка: получает одного или нескольких пользователей по идентификатору.
          параметры:
            - в: путь
              имя: id
              требуется: true
              описание: список идентификаторов пользователей, разделенных запятыми.
              тип: массив
              Предметы:
                тип: целое число
              collectionFormat: csv
              minItems: 1
          ответы:
            200:
              описание: ОК
      
    Общие параметры в разных путях
    Различные пути API могут иметь некоторые общие параметры, например параметры разбивки на страницы.Вы можете определить общие параметры в разделе глобальных параметров и ссылаться на них в отдельных операциях через $ ref .
      параметры:
      offsetParam: # <- Произвольное имя определения, которое будет использоваться для ссылки на него.
                    # Не обязательно совпадает с именем параметра.
        в: запрос
        имя: смещение
        требуется: ложь
        тип: целое число
        минимум: 0
        описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.limitParam:
        в: запрос
        имя: предел
        требуется: ложь
        тип: целое число
        минимум: 1
        максимум: 50
        по умолчанию: 20
        описание: количество возвращаемых товаров.
    пути:
      / пользователи:
        получать:
          Сводка: получает список пользователей.
          параметры:
            - $ ref: '# / parameters / offsetParam'
            - $ ref: '# / parameters / limitParam'
          ответы:
            200:
              описание: ОК
      / команды:
        получать:
          Summary: получает список команд.параметры:
            - $ ref: '# / parameters / offsetParam'
            - $ ref: '# / parameters / limitParam'
          ответы:
            200:
              описание: ОК
      
    Обратите внимание, что глобальные параметры не являются параметрами, применяемыми ко всем операциям - это просто глобальные определения, которые можно легко использовать повторно.

    Зависимости параметров

    Swagger не поддерживает зависимости параметров и взаимоисключающие параметры. На https: // github есть открытый запрос функции.com / OAI / OpenAPI-Specification / issues / 256. Что вы можете сделать, так это задокументировать ограничения в описании параметра и определить логику в ответе 400 Bad Request. Например, рассмотрим конечную точку / report , которая принимает либо относительный диапазон дат ( rdate, ), либо точный диапазон ( start_date + end_date ):
      GET / report? Rdate = Сегодня
    GET / report? Start_date = 2016-11-15 & end_date = 2016-11-20
      
    Вы можете описать эту конечную точку следующим образом:
      пути:
      /отчет:
        получать:
          параметры:
            - имя: rdate
              в: запрос
              тип: строка
              описание:>
                 Относительный диапазон дат для отчета, например «Сегодня» или «Последняя неделя».Для точного диапазона используйте вместо них start_date и end_date.
            - имя: start_date
              в: запрос
              тип: строка
              формат: дата
              описание:>
                Дата начала отчета. Должен использоваться вместе с `end_date`.
                Этот параметр несовместим с rdate.
            - имя: end_date
              в: запрос
              тип: строка
              формат: дата
              описание:>
                Дата окончания отчета.Должен использоваться вместе с start_date.
                Этот параметр несовместим с rdate.
          ответы:
            400:
              description: Требуются либо `rdate`, либо` start_date` + `end_date`.
      

    FAQ

    Когда следует использовать «тип» или «схему»?

    Схема

    используется только с параметрами in: body . Любые другие параметры предполагают примитивный тип, например тип: строка или массив примитивов.

    Можно ли использовать объект в качестве параметра запроса?

    Это возможно в OpenAPI 3.0, но не в 2.0.

    Не нашли то, что искали? Спросите у сообщества
    Нашли ошибку? Сообщите нам

    Структура и синтаксис шаблона - Azure Resource Manager

    • 14 минут на чтение

    В этой статье

    В этой статье описывается структура шаблона Azure Resource Manager (шаблон ARM).В нем представлены различные разделы шаблона и свойства, доступные в этих разделах.

    Эта статья предназначена для пользователей, знакомых с шаблонами ARM. Он предоставляет подробную информацию о структуре шаблона. Пошаговое руководство, которое проведет вас через процесс создания шаблона, см. В разделе Учебное пособие: создание и развертывание вашего первого шаблона ARM. Чтобы узнать о шаблонах ARM с помощью управляемого набора модулей в Microsoft Learn, см. Раздел Развертывание ресурсов в Azure и управление ими с помощью шаблонов ARM.

    Формат шаблона

    В своей простейшей структуре шаблон состоит из следующих элементов:

      {
      "$ schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "",
      "apiProfile": "",
      "параметры": {},
      "переменные": {},
      "функции": [],
      "Ресурсы": [  ],
      "выходы": {}
    }
      
    Имя элемента Обязательно Описание
    $ схема Есть Расположение файла схемы JavaScript Object Notation (JSON), описывающего версию языка шаблонов.Номер версии, которую вы используете, зависит от области развертывания и вашего редактора JSON.

    Если вы используете Visual Studio Code с расширением инструментов Azure Resource Manager, используйте последнюю версию для развертываний групп ресурсов:
    https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate. json #

    Другие редакторы (включая Visual Studio) могут быть не в состоянии обработать эту схему. Для этих редакторов используйте:
    https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json #

    Для развертывания подписки используйте:
    https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#

    Для развертывания групп управления используйте:
    https : //schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json#

    Для развертываний клиентов используйте:
    https://schema.management.azure.com/schemas/2019- 08-01 / tenantDeploymentTemplate.json #

    содержание Версия Есть Версия шаблона (например, 1.0.0.0). Вы можете указать любое значение для этого элемента. Используйте это значение, чтобы задокументировать значительные изменения в вашем шаблоне. При развертывании ресурсов с использованием шаблона это значение можно использовать, чтобы убедиться, что используется правильный шаблон.
    apiProfile Версия API, которая служит набором версий API для типов ресурсов. Используйте это значение, чтобы избежать необходимости указывать версии API для каждого ресурса в шаблоне. Если вы указываете версию профиля API и не указываете версию API для типа ресурса, Resource Manager использует версию API для того типа ресурса, который определен в профиле.

    Свойство профиля API особенно полезно при развертывании шаблона в различных средах, таких как Azure Stack и глобальная среда Azure. Используйте версию профиля API, чтобы убедиться, что ваш шаблон автоматически использует версии, которые поддерживаются в обеих средах. Список текущих версий профиля API и версий API ресурсов, определенных в профиле, см. В разделе Профиль API.

    Для получения дополнительной информации см. Отслеживание версий с помощью профилей API.

    параметры Значения, которые предоставляются при выполнении развертывания для настройки развертывания ресурсов.
    переменных Значения, которые используются как фрагменты JSON в шаблоне для упрощения выражений языка шаблонов.
    функций Пользовательские функции, доступные в шаблоне.
    ресурсов Есть Типы ресурсов, которые развертываются или обновляются в группе ресурсов или подписке.
    выходов Значения, возвращаемые после развертывания.

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

    Параметры

    В разделе шаблона параметры вы указываете, какие значения вы можете вводить при развертывании ресурсов. Вы ограничены 256 параметрами в шаблоне. Вы можете уменьшить количество параметров, используя объекты, содержащие несколько свойств.

    Доступные свойства для параметра:

      "параметры": {
      "<имя-параметра>": {
        "тип": "<значение-параметра-типа>",
        "defaultValue": "<параметр-значение-по-умолчанию>",
        "allowedValues": [""],
        "minValue": ,
        "maxValue": ,
        "minLength": <минимальная длина для строки или массива>,
        "maxLength": <максимальная длина строки или параметры массива>,
        "метаданные": {
          "description": "<описание-параметра>"
        }
      }
    }
      
    Имя элемента Обязательно Описание
    имя параметра Есть Имя параметра.Должен быть действующий идентификатор JavaScript.
    тип Есть Тип значения параметра. Допустимые типы и значения: string , securestring , int , bool , object , secureObject и array . См. Типы данных в шаблонах ARM.
    значение по умолчанию Значение по умолчанию для параметра, если для параметра не указано значение.
    разрешенные значения Массив допустимых значений параметра, чтобы убедиться, что задано правильное значение.
    мин Значение Минимальное значение для параметров типа int, это значение является включительно.
    maxValue Максимальное значение для параметров типа int, это значение включительно.
    мин Длина Минимальная длина для параметров типа строки, защищенной строки и массива, это значение является включительно.
    макс. Длина Максимальная длина для параметров типа строки, защищенной строки и массива, включая это значение.
    описание Описание параметра, который отображается пользователям через портал. Для получения дополнительной информации см. Комментарии в шаблонах.

    Примеры использования параметров см. В разделе «Параметры в шаблонах ARM».

    Переменные

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

    В следующем примере показаны доступные параметры для определения переменной:

      "переменные": {
      "<имя-переменной>": "<значение-переменной>",
      "<имя-переменной>": {
        <значение-типа-комплекса-переменной>
      },
      "<имя-переменной-объекта>": {
        "копия": [
          {
            "name": "",
            "count": <число-итераций>,
            "ввод": <объект-или-значение-повторять>
          }
        ]
      },
      "копия": [
        {
          "name": "<имя-массива-переменной>",
          "count": <число-итераций>,
          "ввод": <объект-или-значение-повторять>
        }
      ]
    }
      

    Для получения информации об использовании copy для создания нескольких значений для переменной см. Итерация переменных.

    Примеры использования переменных см. В разделе «Переменные в шаблоне ARM».

    Функции

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

    При определении пользовательской функции есть некоторые ограничения:

    • Функция не может получить доступ к переменным.
    • Функция может использовать только параметры, определенные в функции. Когда вы используете функцию параметров в пользовательской функции, вы ограничены параметрами для этой функции.
    • Функция не может вызывать другие пользовательские функции.
    • Функция не может использовать ссылочную функцию.
    • Параметры функции не могут иметь значений по умолчанию.
      «функции»: [
      {
        "пространство имен": "<пространство-для-функций>",
        "members": {
          "<имя-функции>": {
            "параметры": [
              {
                "name": "<имя-параметра>",
                "тип": "<значение-параметра-типа>"
              }
            ],
            "выход": {
              "тип": "<значение-вывода-типа>",
              "значение": "<возвращаемое-значение-функции>"
            }
          }
        }
      }
    ],
      
    Имя элемента Обязательно Описание
    пространство имен Есть Пространство имен для пользовательских функций.Используйте, чтобы избежать конфликтов имен с функциями шаблона.
    имя-функции Есть Имя пользовательской функции. При вызове функции объедините имя функции с пространством имен. Например, чтобы вызвать функцию с именем uniqueName в пространстве имен contoso, используйте "[contoso.uniqueName ()]" .
    имя параметра Имя параметра, который будет использоваться в пользовательской функции.
    значение параметра Тип значения параметра.Допустимые типы и значения: string , securestring , int , bool , object , secureObject и array .
    выходной Есть Тип выходного значения. Выходные значения поддерживают те же типы, что и входные параметры функции.
    выходное значение Есть Выражение языка шаблонов, которое вычисляется и возвращается функцией.

    Примеры использования пользовательских функций см. В разделе Пользовательские функции в шаблоне ARM.

    Ресурсы

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

    Вы определяете ресурсы со следующей структурой:

      «ресурсы»: [
      {
          "условие": "<истинный-to-deploy-this-resource>",
          "тип": "<пространство-имен-поставщика-ресурса / имя-типа-ресурса>",
          "apiVersion": "",
          "имя": "<имя-ресурса>",
          "комментарии": "",
          "location": "",
          "зависит от": [
              "<имя-связанного-ресурса-массива>"
          ],
          "теги": {
              "<имя-тега1>": "<значение-тега1>",
              "<имя-тега2>": "<значение-тега2>"
          },
          "личность": {
            "тип": "<идентификатор, присвоенный системе или пользователю>",
            "userAssignedIdentities": {
              "<идентификатор-ресурса>": {}
            }
          },
          "sku": {
              "name": "",
              "tier": "",
              "размер": "<размер>",
              "family": "",
              "емкость": <емкость-емкость>
          },
          "kind": "",
          "scope": "",
          "copy": {
              "name": "",
              "count": <число-итераций>,
              "режим": "<последовательный или параллельный>",
              "batchSize": <число-для-развертывания-серийно>
          },
          "план": {
              "name": "<имя-плана>",
              "PromotionCode": "<код-промо-акции>",
              "издатель": "<издатель-план>",
              "product": "",
              "версия": "<версия-плана>"
          },
          "характеристики": {
              "<настройки-для-ресурса>",
              "копия": [
                  {
                      "имя": ,
                      "считать": ,
                      "Вход": {}
                  }
              ]
          },
          "Ресурсы": [
              "<массив-детей-ресурсов>"
          ]
      }
    ]
      
    Имя элемента Обязательно Описание
    состояние Логическое значение, указывающее, будет ли ресурс предоставляться во время этого развертывания.Когда истинно , ресурс создается во время развертывания. Если false , ресурс пропускается для этого развертывания. См. Состояние.
    тип Есть Тип ресурса. Это значение представляет собой комбинацию пространства имен поставщика ресурсов и типа ресурса (например, Microsoft.Storage/storageAccounts ). Чтобы определить доступные значения, см. Справочник по шаблону. Для дочернего ресурса формат типа зависит от того, вложен ли он в родительский ресурс или определен вне родительского ресурса.См. Раздел Установка имени и типа для дочерних ресурсов.
    apiVersion Есть Версия REST API, используемая для создания ресурса. При создании нового шаблона установите для этого значения последнюю версию развертываемого ресурса. Пока шаблон работает должным образом, продолжайте использовать ту же версию API. Продолжая использовать ту же версию API, вы минимизируете риск того, что новая версия API изменит работу вашего шаблона. Рассматривайте обновление версии API только в том случае, если вы хотите использовать новую функцию, представленную в более поздней версии.Чтобы определить доступные значения, см. Справочник по шаблону.
    название Есть Название ресурса. Имя должно соответствовать ограничениям компонента URI, определенным в RFC3986. Службы Azure, которые предоставляют имя ресурса внешним сторонам, проверяют имя, чтобы убедиться, что это не попытка подделки другого удостоверения. Для дочернего ресурса формат имени зависит от того, вложен ли он в родительский ресурс или определен вне родительского ресурса. См. Раздел Установка имени и типа для дочерних ресурсов.
    комментариев Ваши заметки для документирования ресурсов в вашем шаблоне. Для получения дополнительной информации см. Комментарии в шаблонах.
    местонахождение Варьируется Поддерживаемые геолокации предоставленного ресурса. Вы можете выбрать любое из доступных мест, но обычно имеет смысл выбрать то, что близко к вашим пользователям. Обычно также имеет смысл размещать ресурсы, которые взаимодействуют друг с другом, в одном регионе.Для большинства типов ресурсов требуется расположение, но для некоторых типов (например, для назначения ролей) расположение не требуется. См. Раздел Установка местоположения ресурса.
    зависит от Ресурсы, которые необходимо развернуть перед развертыванием этого ресурса. Resource Manager оценивает зависимости между ресурсами и развертывает их в правильном порядке. Когда ресурсы не зависят друг от друга, они развертываются параллельно. Значение может быть списком разделенных запятыми имен ресурсов или уникальных идентификаторов ресурсов.Перечислить только ресурсы, развернутые в этом шаблоне. Ресурсы, которые не определены в этом шаблоне, уже должны существовать. Избегайте добавления ненужных зависимостей, поскольку они могут замедлить развертывание и создать циклические зависимости. Инструкции по настройке зависимостей см. В разделе Определение порядка развертывания ресурсов в шаблонах ARM.
    тегов Теги, связанные с ресурсом. Применяйте теги для логической организации ресурсов по вашей подписке.
    идентификация Некоторые ресурсы поддерживают управляемые удостоверения для ресурсов Azure. Эти ресурсы имеют объект идентификации на корневом уровне объявления ресурса. Вы можете указать, будет ли идентификатор назначаться пользователем или системой. Для удостоверений, назначаемых пользователем, предоставьте список идентификаторов ресурсов для удостоверений. Установите ключ для идентификатора ресурса и значение для пустого объекта. Дополнительные сведения см. В разделе Настройка управляемых удостоверений для ресурсов Azure на виртуальной машине Azure с помощью шаблонов.
    артикул Некоторые ресурсы допускают развертывание значений, определяющих SKU. Например, вы можете указать тип избыточности для учетной записи хранения.
    вид Некоторые ресурсы допускают значение, определяющее тип развертываемого ресурса. Например, вы можете указать тип создаваемой Cosmos DB.
    область применения Свойство области доступно только для типов ресурсов расширения.Используйте его при указании области, отличной от области развертывания. См. Раздел Настройка объема ресурсов расширения в шаблонах ARM.
    копия Если требуется более одного экземпляра, количество создаваемых ресурсов. Режим по умолчанию - параллельный. Укажите последовательный режим, если вы не хотите, чтобы все ресурсы или ресурсы развертывались одновременно. Дополнительные сведения см. В разделе Создание нескольких экземпляров ресурсов в Azure Resource Manager.
    план Некоторые ресурсы допускают значения, определяющие план развертывания.Например, вы можете указать образ торговой площадки для виртуальной машины.
    недвижимость Параметры конфигурации для конкретного ресурса. Значения свойств совпадают со значениями, которые вы указываете в теле запроса для операции REST API (метод PUT) для создания ресурса. Вы также можете указать массив копий для создания нескольких экземпляров свойства. Чтобы определить доступные значения, см. Справочник по шаблону.
    ресурсов Дочерние ресурсы, зависящие от определяемого ресурса.Предоставляйте только те типы ресурсов, которые разрешены схемой родительского ресурса. Зависимость от родительского ресурса не подразумевается. Вы должны явно определить эту зависимость. См. Раздел Установка имени и типа для дочерних ресурсов.

    Выходы

    В разделе выходов вы указываете значения, возвращаемые при развертывании. Обычно вы возвращаете значения из развернутых ресурсов.

    В следующем примере показана структура определения вывода:

      "выходы": {
      "<имя-выхода>": {
        "condition": "",
        "тип": "<значение-вывода-типа>",
        "значение": "<выражение-значение-вывода>",
        "copy": {
          "count": <число-итераций>,
          "ввод": <значения-для-переменной>
        }
      }
    }
      
    Имя элемента Обязательно Описание
    имя вывода Есть Имя выходного значения.Должен быть действующий идентификатор JavaScript.
    состояние Логическое значение, указывающее, возвращается ли это выходное значение. Когда истинно , значение включается в выходные данные для развертывания. Когда false , выходное значение пропускается для этого развертывания. Если не указано, значение по умолчанию - true .
    тип Есть Тип выходного значения. Выходные значения поддерживают те же типы, что и входные параметры шаблона.Если вы укажете securestring для типа вывода, значение не будет отображаться в истории развертывания и не может быть получено из другого шаблона. Чтобы использовать секретное значение более чем в одном шаблоне, сохраните секрет в Key Vault и сделайте ссылку на секрет в файле параметров. Дополнительные сведения см. В разделе Использование хранилища ключей Azure для передачи значения безопасного параметра во время развертывания.
    значение Выражение языка шаблонов, которое вычисляется и возвращается как выходное значение.Укажите значение или копию .
    копия Используется для возврата более одного значения для вывода. Укажите значение или скопируйте . Дополнительные сведения см. В разделе Итерация вывода в шаблонах ARM.

    Примеры использования выходов см. В разделе «Выходы в шаблоне ARM».

    У вас есть несколько вариантов добавления комментариев и метаданных к вашему шаблону.

    Комментарии

    Для встроенных комментариев вы можете использовать // или / *... * / .

    Примечание

    При использовании Azure CLI для развертывания шаблонов с комментариями используйте версию 2.3.0 или более позднюю и укажите переключатель --handle-extended-json-format .

      {
      "type": "Microsoft.Compute / virtualMachines",
      «apiVersion»: «2018-10-01»,
      "name": "[variables ('vmName')]", // чтобы настроить имя, измените его в переменных
      "location": "[parameters ('location')]", // по умолчанию - расположение группы ресурсов
      "dependsOn": [/ * сначала необходимо развернуть учетную запись хранения и сетевой интерфейс * /
        "[resourceId ('Microsoft.Storage / storageAccounts / ', переменные (' storageAccountName '))] »,
        "[resourceId ('Microsoft.Network/networkInterfaces/', переменные ('nicName'))]»
      ],
      

    В Visual Studio Code расширение Azure Resource Manager Tools может автоматически обнаруживать шаблон ARM и изменять языковой режим. Если вы видите Шаблон диспетчера ресурсов Azure в правом нижнем углу Visual Studio Code, вы можете использовать встроенные комментарии. Встроенные комментарии больше не помечаются как недопустимые.

    Метаданные

    Вы можете добавить объект метаданных практически в любом месте вашего шаблона.Диспетчер ресурсов игнорирует объект, но ваш редактор JSON может предупредить вас, что свойство недействительно. В объекте определите необходимые свойства.

      {
      "$ schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "метаданные": {
        "comments": "Этот шаблон был разработан в демонстрационных целях.",
        "author": "Пример имени"
      },
      

    Для параметров добавьте объект метаданных со свойством description .

      "параметры": {
      "adminUsername": {
        "тип": "строка",
        "метаданные": {
          "description": "Имя пользователя виртуальной машины".
        }
      },
      

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

    Для ресурсов добавьте элемент комментариев или объект метаданных . В следующем примере показаны как элемент комментариев , так и объект метаданных .

      «ресурсы»: [
      {
        "тип": "Microsoft.Storage/storageAccounts",
        «apiVersion»: «2018-07-01»,
        "имя": "[concat ('хранилище', uniqueString (resourceGroup (). id))]",
        "comments": "Учетная запись хранения, используемая для хранения дисков ВМ",
        "location": "[параметры ('location')]",
        "метаданные": {
          "comments": "Эти теги необходимы для соответствия политике".
        },
        "теги": {
          "Dept": "[параметры ('deptName')]",
          "Среда": "[параметры ('среда')]"
        },
        "sku": {
          "name": "Standard_LRS"
        },
        "kind": "Хранение",
        "характеристики": {}
      }
    ]
      

    Для выходов добавьте объект метаданных к выходному значению.

      "выходы": {
      "hostname": {
        "тип": "строка",
        "значение": "[ссылка (переменные ('publicIPAddressName')). dnsSettings.fqdn]",
        "метаданные": {
          "comments": "Вернуть полное доменное имя"
        }
      },
      

    Вы не можете добавить объект метаданных к пользовательским функциям.

    Многострочные струны

    Вы можете разбить строку на несколько строк. Например, см. Свойство location и один из комментариев в следующем примере JSON.

    Примечание

    Для развертывания шаблонов с многострочными строками используйте Azure PowerShell или Azure CLI. Для CLI используйте версию 2.3.0 или новее и укажите переключатель --handle-extended-json-format .

    Многострочные строки не поддерживаются при развертывании шаблона через портал Azure, конвейер DevOps или REST API.

      {
      "type": "Microsoft.Compute / virtualMachines",
      «apiVersion»: «2018-10-01»,
      "name": "[variables ('vmName')]", // чтобы настроить имя, измените его в переменных
      "место нахождения": "[
        параметры ('местоположение')
        ] ", // по умолчанию расположение группы ресурсов
      / *
        учетная запись хранения и сетевой интерфейс
        должен быть развернут в первую очередь
      * /
      "зависит от": [
        "[resourceId ('Microsoft.Storage / storageAccounts / ', переменные (' storageAccountName '))] »,
        "[resourceId ('Microsoft.Network/networkInterfaces/', переменные ('nicName'))]»
      ],
      

    Следующие шаги

    Использование параметров среды выполнения и типобезопасности - Azure Pipelines

    • 6 минут на чтение

    В этой статье

    Параметры времени выполнения позволяют лучше контролировать, какие значения могут быть переданы в конвейер.С параметрами выполнения вы можете:

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

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

    Параметры доступны только во время синтаксического анализа шаблона. Параметры раскрываются непосредственно перед запуском конвейера, поэтому значения, заключенные в $ {{}} , заменяются значениями параметров. Используйте переменные, если вам нужно, чтобы ваши значения были более доступны во время работы конвейера.

    Параметры должны содержать имя и тип данных. Параметры не могут быть необязательными. Значение по умолчанию должно быть назначено в вашем YAML-файле или при запуске конвейера. Если вы не назначите значение по умолчанию или установите default на false , будет использоваться первое доступное значение.

    Использовать параметры в трубопроводах

    Установить параметры времени выполнения в начале YAML. Этот пример конвейера принимает значение , изображение и затем выводит значение в задании. Для триггера установлено значение «Нет», поэтому вы можете выбрать значение изображение , когда вы вручную запускаете конвейер.

      параметры:
    - имя: изображение
      displayName: Изображение пула
      тип: строка
      по умолчанию: ubuntu-latest
      ценности:
      - windows-последняя версия
      - ubuntu-последний
      - последняя версия macOS
    
    триггер: нет
    
    вакансии:
    - работа: сборка
      displayName: build
      бассейн:
        vmImage: $ {{параметры.изображение }}
      шаги:
      - скрипт: эхо-построение $ (Build.BuildNumber) с помощью $ {{parameters.image}}
      

    При запуске конвейера вы выбираете образ пула. Если вы не сделаете выбор, будет использоваться вариант по умолчанию ubuntu-latest .

    Используйте условные выражения с параметрами

    Вы также можете использовать параметры как часть условной логики. С условными операторами часть YAML будет выполняться только в том случае, если она соответствует критериям , если .

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

    Этот конвейер выполняет шаг, только если логический параметр test истинен.

      параметры:
    - имя: изображение
      displayName: Изображение пула
      ценности:
      - windows-последняя версия
      - ubuntu-последний
      - последняя версия macOS
    - название: тест
      displayName: Выполнить тесты?
      тип: логический
      по умолчанию: false
    
    триггер: нет
    
    вакансии:
    - работа: сборка
      displayName: Сборка и тестирование
      бассейн:
        vmImage: $ {{parameters.image}}
      шаги:
      - скрипт: эхо-здание $ (Build.BuildNumber)
      - $ {{если eq (parameters.test, true)}}:
        - скрипт: echo "Запуск всех тестов"
      

    Используйте параметры, чтобы указать, какая конфигурация используется

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

      параметры:
    - имя: конфиги
      тип: строка
      по умолчанию: 'x86, x64'
    
    триггер: нет
    
    вакансии:
    - $ {{если содержит (parameters.configs, 'x86')}}:
      - работа: x86
        шаги:
        - скрипт: echo Building x86 ...
    - $ {{если содержит (parameters.configs, 'x64')}}:
      - работа: x64
        шаги:
        - скрипт: echo Building x64 ...
    - $ {{если содержит (parameters.configs, 'arm')}}:
      - работа: рука
        шаги:
        - скрипт: echo Building arm...
      

    Выборочно исключить этап

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

      параметры:
    - имя: runPerfTests
      тип: логический
      по умолчанию: false
    
    триггер: нет
    
    этапы:
    - этап: Сборка
      displayName: Сборка
      вакансии:
      - работа: Сборка
        шаги:
        - скрипт: эхо запускает сборку
    
    
    - этап: UnitTest
      displayName: Unit Test
      зависит от: Сборка
      вакансии:
      - задание: UnitTest
        шаги:
        - скрипт: эхо-запуск UnitTest
    
    
    - $ {{если эк (параметры.runPerfTests, true)}}:
      - этап: PerfTest
        displayName: Тест производительности
        зависит от: Сборка
        вакансии:
        - работа: PerfTest
          шаги:
          - скрипт: эхо запускает PerfTest
    
    
    - этап: развертывание
      displayName: Deploy
      зависит от: UnitTest
      вакансии:
      - задание: Развернуть
        шаги:
        - скрипт: эхо-запуск UnitTest
      

    Параметры прохода

    Вы также можете в цикле перебирать строковые, числовые и логические параметры.

    В этом примере вы просматриваете параметры в цикле и распечатываете имя и значение каждого параметра.

      # start.yaml
    параметры:
    - имя: myStringName
      тип: строка
      по умолчанию: строковое значение
    - имя: myMultiString
      тип: строка
      по умолчанию: по умолчанию
      ценности:
      - дефолт
      - убунту
    - имя: myNumber
      тип: число
      по умолчанию: 2
      ценности:
      - 1
      - 2
      - 4
      - 8
      - 16
    - имя: myBoolean
      тип: логический
      по умолчанию: true
    
    шаги:
    - $ {{каждый параметр в параметрах}}:
      - скрипт: echo $ {{параметр.Key}}
      - скрипт: echo $ {{parameter.Value}}
      
      # лазурь-трубопровод.ямл
    триггер: нет
    
    расширяется:
      шаблон: start.yaml
      

    Вы можете перебирать параметры в задаче PowerShell и устанавливать каждый параметр как переменную среды.

      # start.yaml
    
    параметры:
    - имя: myStringName
      тип: строка
      по умолчанию: строковое значение
    - имя: myMultiString
      тип: строка
      по умолчанию: по умолчанию
      ценности:
      - дефолт
      - убунту
    - имя: myNumber
      тип: число
      по умолчанию: 2
      ценности:
      - 1
      - 2
      - 4
      - 8
      - 16
    - имя: myBoolean
      тип: логический
      по умолчанию: true
    
    шаги:
      - задача: PowerShell @ 2
        env:
          $ {{каждый параметр в параметрах}}:
            $ {{параметр.Ключ}}: $ {{parameter.Value}}
        входы:
          filePath: test_script.ps1
          pwsh: правда
    
    
    
      
      # azure-pipeline.yaml
    триггер: нет
    
    расширяется:
      шаблон: start.yaml
      
      # test_script.ps1
    
    Write-Host "Hello, World!"
    Write-Host $ env: myStringName
    
      

    Проверить наличие пустого объекта параметра

    Вы можете использовать выражение length () , чтобы проверить, не имеет ли параметр объекта никакого значения.

      параметры:
    - имя: foo
      тип: объект
      дефолт: []
    
    шаги:
    - касса: нет
    - $ {{если eq (length (parameters.foo), 0)}}:
      - скрипт: echo Foo пуст
        displayName: Foo пусто
      

    Типы данных параметров

    Тип данных Примечания
    строка строка
    номер может быть ограничен значениями: , в противном случае допустима любая числовая строка
    логический истинно или ложно
    объект любая структура YAML
    шаг одноступенчатый
    stepList последовательность шагов
    работа разовая работа
    список вакансий последовательность работ
    развертывание одно задание по развертыванию
    список развертывания последовательность развертывания заданий
    ступень одноступенчатый
    stageList последовательность этапов

    Типы данных step, stepList, job, jobList, deployment, deploymentList, stage и stageList используют стандартный формат схемы YAML.Этот пример включает строку, число, логическое значение, объект, шаг и stepList.

      параметры:
    - имя: myString
      тип: строка
      по умолчанию: строка
    - имя: myMultiString
      тип: строка
      по умолчанию: по умолчанию
      ценности:
      - дефолт
      - убунту
    - имя: myNumber
      тип: число
      по умолчанию: 2
      ценности:
      - 1
      - 2
      - 4
      - 8
      - 16
    - имя: myBoolean
      тип: логический
      по умолчанию: true
    - имя: myObject
      тип: объект
      дефолт:
        foo: FOO
        бар: BAR
        вещи:
        - один
        - два
        - три
        вложенные:
          одно яблоко
          два: груша
          количество: 3
    - имя: myStep
      тип: шаг
      дефолт:
        сценарий: повторить мой шаг
    - имя: mySteplist
      тип: stepList
      дефолт:
        - скрипт: эхо, шаг первый
        - скрипт: эхо, шаг два
    
    триггер: нет
    
    вакансии:
    - задание: stepList
      шаги: $ {{параметры.mySteplist}}
    - работа: myStep
      шаги:
        - $ {{parameters.myStep}}
      

    FAQ

    Как я могу использовать переменные внутри шаблонов?

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

    В этом примере предопределенные переменные Build.SourceBranch и Build.Reason используются в условиях в template.yml.

      # Файл: azure-pipelines.yml
    курок:
    - главный
    
    расширяется:
      шаблон: template.yml
      
      # Файл: template.yml
    шаги:
    - скрипт: echo Build.SourceBranch = $ (Build.SourceBranch) # выводит refs / heads / main
    - скрипт: echo Build.Reason = $ (Build.Reason) # выводит IndividualCI
    - $ {{if eq (variables ['Build.SourceBranch'], 'refs / heads / main')}}:
      - скрипт: echo Запускаю только если Build.SourceBranch = refs / Heads / main
    - $ {{if eq (variables ['Build.Reason'], 'IndividualCI')}}:
      - скрипт: echo Запускаю, только если Build.Reason = IndividualCI
    - скрипт: эхо я запускаю после условий
      

    404 | Микро Фокус

  • Профессиональные услуги

    Сформируйте свою стратегию и преобразуйте гибридную ИТ-среду.


  • Профессиональные услуги по продуктам
  • Аналитика и большие данные

    Помогите вам встроить безопасность в цепочку создания стоимости ИТ и наладить сотрудничество между ИТ-подразделениями, приложениями и службами безопасности.

  • Компьютерная безопасность

    Помогите вам быстрее реагировать и получить конкурентное преимущество благодаря гибкости предприятия.

  • DevOps

    Ускорьте получение результатов гибридного облака с помощью услуг по консультированию, трансформации и внедрению.

  • Консультации по цепочке создания стоимости IT4IT

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

  • Управление доставкой приложений

    Услуги стратегического консалтинга для разработки вашей программы цифровой трансформации.

  • Жизненный цикл мобильного приложения

    Полнофункциональное моделирование сценариев использования с предварительно созданными интеграциями в портфеле программного обеспечения Micro Focus, демонстрирующее реальный сценарий использования

  • Управление гибридным облаком и брокерские услуги

    Услуги экспертной аналитики безопасности, которые помогут вам быстро спроектировать, развернуть и проверить реализацию технологии безопасности Micro Focus.

  • Автоматизация ЦОД

    Служба интеграции и управления услугами, которая оптимизирует доставку, гарантии и управление в условиях нескольких поставщиков.

  • Управление операциями

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

  • Управление услугами

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

  • Vertica

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

  • Глобальная аутентификация продукта

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

  • Управляемые службы

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

  • Модельные офисы

    Комплексные услуги по работе с большими данными для продвижения вашего предприятия.

  • Описание параметров

    OAS 3 Эта страница посвящена OpenAPI 3.0. Если вы используете OpenAPI 2.0, см. Наше руководство по OpenAPI 2.0.

    Описание параметров

    В OpenAPI 3.0 параметры определены в разделе parameters операции или пути.Чтобы описать параметр, вы указываете его имя , , расположение ( в ), тип данных (определяется схемой или содержимым ) и другие атрибуты, такие как описание или требуется . Вот пример:
      пути:
    / users / {userId}:
    получать:
    Сводка: Получите пользователя по идентификатору
    параметры:
    - в: путь
    имя: userId
    схема:
    тип: целое число
    требуется: true
    описание: Числовой идентификатор пользователя для получения  
    Обратите внимание, что параметры - это массив, поэтому в YAML каждое определение параметра должно быть указано с тире () перед ним.

    Типы параметров

    OpenAPI 3.0 различает следующие типы параметров в зависимости от их расположения. Местоположение определяется параметром в ключе , например в: query или в: path .

    Параметры пути

    Параметры пути - это переменные части пути URL. Обычно они используются для указания на определенный ресурс в коллекции, например на пользователя, идентифицированного по идентификатору. URL-адрес может иметь несколько параметров пути, каждый из которых обозначен фигурными скобками {} .
      GET / пользователей / {id}
    ПОЛУЧИТЬ / cars / {carId} / drivers / {driverId}
    ПОЛУЧИТЬ /report.{format}
      
    Каждый параметр пути должен быть заменен фактическим значением, когда клиент выполняет вызов API. В OpenAPI параметр пути определяется с помощью in: path . Имя параметра должно быть таким же, как указано в пути. Также не забудьте добавить required: true , потому что параметры пути требуются всегда. Например, конечная точка / users / {id} может быть описана как:
      пути:
    / users / {id}:
    получать:
    параметры:
    - в: путь
    name: id # Обратите внимание, что имя такое же, как в пути
    требуется: true
    схема:
    тип: целое число
    минимум: 1
    описание: ID пользователя  
    Параметры пути, содержащие массивы и объекты, можно сериализовать разными способами:
    • расширение стиля пути (матрица) - с префиксом точки с запятой, например / map / point; x = 50; y = 20
    • Расширение метки
    • - с префиксом точки, например / цвет.R = 100.G = 200.B = 150
    • простой стиль - разделенные запятыми, например / users / 12,34,56
    Метод сериализации определяется ключевыми словами style и explode . Чтобы узнать больше, см. Сериализация параметров.

    Параметры запроса

    Параметры запроса - это наиболее распространенный тип параметров. Они появляются в конце URL-адреса запроса после вопросительного знака (? ) с разными парами имя = значение , разделенными амперсандами ( и ).Параметры запроса могут быть обязательными и необязательными.
      GET / pets / findByStatus? Status = available
    GET / notes? Смещение = 100 и ограничение = 50  
    Используйте в: query для обозначения параметров запроса:
      параметры:
    - в: запрос
    имя: смещение
    схема:
    тип: целое число
    описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.
    - в: запрос
    имя: предел
    схема:
    тип: целое число
    описание: Количество возвращаемых товаров  

    Примечание: Чтобы описать ключи API, переданные в качестве параметров запроса, используйте вместо этого securitySchemes и security .См. Ключи API.

    Параметры запроса могут быть примитивными значениями, массивами и объектами. OpenAPI 3.0 предоставляет несколько способов сериализации объектов и массивов в строке запроса.

    Массивы можно сериализовать как:

    • форма - / products? Color = blue, green, red или / products? Color = blue & color = green , в зависимости от разнесения ключевое слово
    • spaceDelimited (то же, что и коллекция Формат: ssv в OpenAPI 2.0) - / products? Color = blue% 20green% 20red
    • pipeDelimited (то же, что и collectionFormat: pipe в OpenAPI 2.0) - / products? Color = blue | green | red
    Объекты можно сериализовать как:
    • форма - / точек? Color = R, 100, G, 200, B, 150 или / точек? R = 100 & G = 200 & B = 150 , в зависимости от разнесения ключевое слово
    • deepObject / точек? Color [R] = 100 & color [G] = 200 & color [B] = 150
    Метод сериализации определяется ключевыми словами style и explode .Чтобы узнать больше, см. Сериализация параметров.
    Зарезервированных символов в параметрах запроса
    RFC 3986 определяет набор зарезервированных символов : /? # [] @! $ & '() * +,; = , которые используются в качестве разделителей компонентов URI. Когда эти символы необходимо использовать буквально в значении параметра запроса, они обычно кодируются в процентах. Например, / кодируется как % 2F (или % 2f ), поэтому значение параметра quotes / h3g2.txt будет отправлено как
      GET / file? Path = кавычки% 2Fh3g2.txt  
    Если вам нужен параметр запроса, который не закодирован в процентах, добавьте allowReserved: true в определение параметра:
      параметры:
    - в: запрос
    имя: путь
    требуется: true
    схема:
    тип: строка
    allowReserved: true # <-----  
    В этом случае значение параметра будет отправлено так:
      GET /file?path=quotes/h3g2.txt  
    Для вызова API может потребоваться отправка настраиваемых заголовков с HTTP-запросом.OpenAPI позволяет определять пользовательские заголовки запросов как в параметрах: header . Например, предположим, что для вызова GET / ping требуется заголовок X-Request-ID :
      GET / пинг HTTP / 1.1
    Хост: example.com
    X-Request-ID: 77e1c83b-7bb0-437b-bc50-a7a58e5660ac  
    Используя OpenAPI 3.0, вы должны определить эту операцию следующим образом:
      пути:
    /пинг:
    получать:
    сводка: Проверяет, жив ли сервер
    параметры:
    - в: заголовок
    имя: X-Request-ID
    схема:
    тип: строка
    формат: uuid
    требуется: true  

    Аналогичным образом вы можете определить собственные заголовки ответов.Параметром заголовка могут быть примитивы, массивы и объекты. Массивы и объекты сериализуются с использованием простого стиля . Для получения дополнительной информации см. Сериализация параметров.

    Примечание. Параметры заголовка с именем Accept , Content-Type и Authorization недопустимы. Для описания этих заголовков используйте соответствующие ключевые слова OpenAPI:

    Параметры cookie

    Операции также могут передавать параметры в заголовке Cookie , например Cookie: name = value .В одном заголовке отправляются несколько параметров cookie, разделенных точкой с запятой и пробелом.
      GET / api / пользователи
    Хост: example.com
    Cookie: debug = 0; csrftoken = BUSe35dohU3O1MZvDCUOJ  
    Используйте в: cookie для определения параметров cookie:
      параметры:
    - в: cookie
    имя: отладка
    схема:
    тип: целое число
    enum: [0, 1]
    по умолчанию: 0
    - в: cookie
    имя: csrftoken
    схема:
    тип: строка  

    Параметры cookie могут быть примитивными значениями, массивами и объектами.Массивы и объекты сериализуются с использованием стиля form . Для получения дополнительной информации см. Сериализация параметров.

    Примечание: Чтобы определить аутентификацию файлов cookie, используйте вместо этого ключи API.

    Обязательные и дополнительные параметры

    По умолчанию OpenAPI рассматривает все параметры запроса как необязательные. Вы можете добавить required: true , чтобы пометить параметр как требуемый. Обратите внимание, что в параметрах пути должно быть указано required: true , потому что они требуются всегда.
      параметры:
            - в: путь
              имя: userId
              схема:
                тип: целое число
              требуется: true # <----------
              описание: числовой идентификатор пользователя, которого нужно получить.
      
    Схема

    против содержимого

    Для описания содержимого параметра можно использовать ключевое слово schema или content . Они исключают друг друга и используются в разных сценариях. В большинстве случаев вы должны использовать схему .Он позволяет описывать примитивные значения, а также простые массивы и объекты, сериализованные в строку. Метод сериализации для параметров массива и объекта определяется ключевыми словами style и explode , используемыми в этом параметре.
      параметры:
      - в: запрос
        имя: цвет
        схема:
          тип: массив
          Предметы:
            тип: строка
    
        # Сериализовать как цвет = синий, черный, коричневый (по умолчанию)
        стиль: форма
        взорваться: ложь  
    Контент используется в сложных сценариях сериализации, которые не охватываются стилем и разнесением .Например, если вам нужно отправить строку JSON в строке запроса следующим образом:
      filter = {"type": "футболка", "color": "blue"}  
    В этом случае вам нужно обернуть параметр schema в content / , как показано ниже. Схема определяет структуру данных параметра, а тип носителя (в этом примере - application / json ) служит ссылкой на внешнюю спецификацию, которая описывает формат сериализации.
      параметры:
      - в: запрос
        имя: фильтр
    
        # Обернуть 'schema' в 'content. '
        содержание:
          application / json: # <---- тип носителя указывает, как сериализовать / десериализовать содержимое параметра
    
            схема:
              тип: объект
              характеристики:
                тип:
                  тип: строка
                цвет:
                  тип: строка  

    Примечание для пользователей Swagger UI и Swagger Editor: Параметры с содержанием поддерживаются в Swagger UI 3.23.7+ и Swagger Editor 3.6.34+.

    Значения параметров по умолчанию

    Используйте ключевое слово default в схеме параметров, чтобы указать значение по умолчанию для необязательного параметра. Значение по умолчанию - это то, что сервер использует, если клиент не предоставляет значение параметра в запросе. Тип значения должен совпадать с типом данных параметра. Типичный пример - параметры пейджинга, такие как смещение и предел :
      GET / пользователей
    GET / пользователи? Offset = 30 & limit = 10
      
    Предполагая, что смещение по умолчанию равно 0, а предел по умолчанию 20 и находится в диапазоне от 0 до 100, вы должны определить эти параметры как:
      параметры:
            - в: запрос
              имя: смещение
              схема:
                тип: целое число
                минимум: 0
                по умолчанию: 0
              требуется: ложь
              описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.- в: запрос
              имя: предел
              схема:
                тип: целое число
                минимум: 1
                максимум: 100
                по умолчанию: 20
              требуется: ложь
              описание: количество возвращаемых товаров.  
    Распространенные ошибки
    Есть две распространенные ошибки при использовании ключевого слова по умолчанию :
    • Использование по умолчанию с обязательными параметрами или свойствами , например, с параметрами пути.Это не имеет смысла - если значение требуется, клиент всегда должен его отправлять, а значение по умолчанию никогда не используется.
    • Использование по умолчанию для указания значения выборки. Это не предназначено для использования по умолчанию и может привести к неожиданному поведению в некоторых инструментах Swagger. Вместо этого используйте для этого ключевое слово example или examples . См. Добавление примеров.

    Параметры перечисления

    Вы можете ограничить параметр фиксированным набором значений, добавив перечисление к схеме параметра .Значения перечисления должны быть того же типа, что и тип данных параметра.
      параметры:
            - в: запрос
              имя: статус
              схема:
                тип: строка
                перечисление:
                  - доступный
                  - в ожидании
                  - продано  
    Дополнительная информация: Определение Enum.

    Постоянные параметры

    Вы можете определить постоянный параметр как обязательный параметр только с одним возможным значением:
      параметры:
            - в: запрос
              имя: rel_date
              требуется: true
              схема:
                тип: строка
                перечисление:
                  - сейчас  

    Свойство перечисления определяет возможные значения.В этом примере можно использовать только одно значение, и это будет единственное значение, доступное в пользовательском интерфейсе Swagger для выбора пользователем.

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

    Параметры с пустыми и обнуляемыми значениями

    Параметры строки запроса могут иметь только имя и не иметь значения, например:
      GET / foo? Метаданные  
    Используйте allowEmptyValue для описания таких параметров:
      параметры:
            - в: запрос
              имя: метаданные
              схема:
                тип: логический
              allowEmptyValue: true # <-----  
    OpenAPI 3.0 также поддерживает , допускающий значение NULL, в схемах, позволяя параметрам операции иметь значение NULL . Например, следующая схема соответствует int? в C # и java.lang.Integer в Java:
     Схема :
                тип: целое число
                формат: int32
                обнуляемый: true  
    Примечание. обнуляемый - это не то же самое, что необязательный параметр или параметр с пустыми значениями. обнуляемый означает, что значение параметра может быть пустым .Конкретные реализации могут выбрать отображение отсутствующего параметра или параметра с пустыми значениями в null , но, строго говоря, это не одно и то же.

    Примеры параметров

    Для параметра можно указать пример или несколько примеров . Значение примера должно соответствовать схеме параметра. Единственный пример:
      параметры:
            - в: запрос
              имя: предел
              схема:
                тип: целое число
                минимум: 1
              Например: 20  
    Примеры с несколькими именами:
      параметры:
            - в: запрос
              имя: ids
              описание: один или несколько идентификаторов
              требуется: true
              схема:
                тип: массив
                Предметы:
                  тип: целое число
              стиль: форма
              взорваться: ложь
              Примеры:
                oneId:
                  сводка: Пример единственного идентификатора
                  значение: [5] #? ids = 5
                multipleIds:
                  сводка: Пример нескольких идентификаторов
                  значение: [1, 5, 7] #? ids = 1,5,7  
    Подробнее см. Добавление примеров.

    Устаревшие параметры

    Используйте deprecated: true , чтобы пометить параметр как устаревший.
      - в: запрос
              имя: формат
              требуется: true
              схема:
                тип: строка
                перечисление: [json, xml, yaml]
              устарело: правда
              описание: устарело, используйте вместо него соответствующий заголовок `Accept`.  

    Общие параметры

    Общие параметры для всех методов пути
    Параметры, общие для всех операций пути, могут быть определены на уровне пути, а не на уровне операции.Параметры уровня пути наследуются всеми операциями этого пути. Типичным вариантом использования являются операции GET / PUT / PATCH / DELETE, которые управляют ресурсом, доступ к которому осуществляется через параметр пути.
      пути:
      /ID пользователя}:
        параметры:
          - в: путь
            имя: id
            схема:
              тип: целое число
            требуется: true
            описание: ID пользователя
        получать:
          сводка: получает пользователя по идентификатору
          ...
        пластырь:
          Сводка: обновляет существующего пользователя с указанным идентификатором
          ...
        удалять:
          сводка: Удаляет пользователя с указанным ID
          ...  
    Любые дополнительные параметры, определенные на уровне операции, используются вместе с параметрами уровня пути:
      пути:
      / users / {id}:
        параметры:
          - в: путь
            имя: id
            схема:
              тип: целое число
            требуется: true
            описание: ID пользователя.
    
        # GET / users / {id}? Metadata = true
        получать:
          сводка: получает пользователя по идентификатору
          # Обратите внимание, что мы определяем только параметр запроса, потому что {id} определяется на уровне пути.параметры:
            - в: запрос
              имя: метаданные
              схема:
                тип: логический
              требуется: ложь
              описание: если true, конечная точка возвращает только метаданные пользователя.
          ответы:
            '200':
              описание: ОК  
    Определенные параметры уровня пути могут быть переопределены на уровне операции, но не могут быть удалены.
      пути:
      / users / {id}:
        параметры:
          - в: путь
            имя: id
            схема:
              тип: целое число
            требуется: true
            описание: ID пользователя.# DELETE / users / {id} - использует один идентификатор.
        # Повторно использует определение параметра {id} на уровне пути.
        удалять:
          сводка: удаляет пользователя с указанным идентификатором.
          ответы:
            '204':
              описание: Пользователь удален.
    
        # GET / users / id1, id2, id3 - использует один или несколько идентификаторов пользователей.
        # Переопределяет параметр {id} на уровне пути.
        получать:
          Сводка: получает одного или нескольких пользователей по идентификатору.
          параметры:
            - в: путь
              имя: id
              требуется: true
              описание: список идентификаторов пользователей, разделенных запятыми.схема:
                тип: массив
                Предметы:
                  тип: целое число
                minItems: 1
              взорваться: ложь
              стиль: простой
          ответы:
            '200':
              описание: ОК  
    Общие параметры для различных путей
    Различные пути API могут иметь общие параметры, например параметры разбивки на страницы. Вы можете определить общие параметры в разделе «Параметры» в глобальном разделе компонентов и ссылаться на них в другом месте через $ ref .
      комплектующие:
      параметры:
        offsetParam: # <- Произвольное имя определения, которое будет использоваться для ссылки на него.
                      # Не обязательно совпадает с именем параметра.
          в: запрос
          имя: смещение
          требуется: ложь
          схема:
            тип: целое число
            минимум: 0
          описание: количество элементов, которые нужно пропустить перед началом сбора набора результатов.
        limitParam:
          в: запрос
          имя: предел
          требуется: ложь
          схема:
            тип: целое число
            минимум: 1
            максимум: 50
            по умолчанию: 20
          описание: количество возвращаемых товаров.пути:
      / пользователи:
        получать:
          Сводка: получает список пользователей.
          параметры:
            - $ ref: '# / components / parameters / offsetParam'
            - $ ref: '# / components / parameters / limitParam'
          ответы:
            '200':
              описание: ОК
      / команды:
        получать:
          Summary: получает список команд.
          параметры:
            - $ ref: '# / components / parameters / offsetParam'
            - $ ref: '# / components / parameters / limitParam'
          ответы:
            '200':
              описание: ОК  
    Обратите внимание, что параметры, определенные в компонентах , не являются параметрами, применяемыми ко всем операциям - это просто глобальные определения, которые можно легко использовать повторно.

    Зависимости параметров

    OpenAPI 3.0 не поддерживает зависимости параметров и взаимоисключающие параметры. Открытый запрос функции находится по адресу https://github.com/OAI/OpenAPI-Specification/issues/256. Что вы можете сделать, так это задокументировать ограничения в описании параметра и определить логику в ответе 400 Bad Request. Например, рассмотрим конечную точку / report , которая принимает либо относительный диапазон дат ( rdate, ), либо точный диапазон ( start_date + end_date ):
      GET / report? Rdate = Сегодня
    GET / report? Start_date = 2016-11-15 & end_date = 2016-11-20  
    Вы можете описать эту конечную точку следующим образом:
      пути:
      /отчет:
        получать:
          параметры:
            - имя: rdate
              в: запрос
              схема:
                тип: строка
              описание:>
                 Относительный диапазон дат для отчета, например «Сегодня» или «Последняя неделя».Для точного диапазона используйте вместо них start_date и end_date.
            - имя: start_date
              в: запрос
              схема:
                тип: строка
                формат: дата
              описание:>
                Дата начала отчета. Должен использоваться вместе с `end_date`.
                Этот параметр несовместим с rdate.
            - имя: end_date
              в: запрос
              схема:
                тип: строка
                формат: дата
              описание:>
                Дата окончания отчета.Должен использоваться вместе с start_date.
                Этот параметр несовместим с rdate.
          ответы:
            '400':
              description: Требуются либо `rdate`, либо` start_date` + `end_date`.  

    Список литературы

    Объект параметров

    Не нашли то, что искали? Спросите у сообщества
    Нашли ошибку? Сообщите нам

    .

    Добавить комментарий

    Ваш адрес email не будет опубликован. Обязательные поля помечены *