Поделиться через

az apim nv

  • Ссылка

Управление именованными значениями управления API Azure.

Команды

Имя Описание Тип Состояние
az apim nv create

Создайте именованное значение управления API.

 Ядро ГА
az apim nv delete

Удаление именованного значения управления API.

 Ядро ГА
az apim nv list

Вывод списка именованных значений управления API.

 Ядро ГА
az apim nv show

Отображение сведений об именованном значении управления API.

 Ядро ГА
az apim nv show-secret

Возвращает секрет именованного значения управления API.

 Ядро ГА
az apim nv update

Обновите именованное значение управления API.

 Ядро ГА
az apim nv wait

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

 Ядро ГА

az apim nv create

Изменить

Создайте именованное значение управления API.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

Примеры

Создайте именованное значение.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

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

--display-name

Отображаемое имя именованного значения.

--named-value-id

Уникальное имя создаваемого именованного значения.

Должен быть уникальным в текущем экземпляре службы управления API.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--if-match

ETag сущности.

--no-wait

Не ожидать завершения длительной операции.

Default value: False
--secret

Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false.

Допустимые значения: false, true
Default value: False
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--value

Значение именованного значения.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv delete

Изменить

Удаление именованного значения управления API.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

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

--named-value-id

Идентификатор именованного значения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--yes -y

Не запрашивать подтверждение.

Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv list

Изменить

Вывод списка именованных значений управления API.

az apim nv list --resource-group
                --service-name

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

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv show

Изменить

Отображение сведений об именованном значении управления API.

az apim nv show --named-value-id
                --resource-group
                --service-name

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

--named-value-id

Идентификатор именованного значения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv show-secret

Изменить

Возвращает секрет именованного значения управления API.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

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

--named-value-id

Идентификатор именованного значения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv update

Изменить

Обновите именованное значение управления API.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

Примеры

Создайте базовый API.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

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

--named-value-id

Уникальное имя создаваемого API.

Должен быть уникальным в текущем экземпляре службы управления API.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--if-match

ETag сущности.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--secret

Определяет, является ли значение секретом и должно быть зашифровано или нет. Значение по умолчанию — false.

Допустимые значения: false, true
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--value

Значение именованного значения.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim nv wait

Изменить

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

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Примеры

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

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

--named-value-id

Идентификатор именованного значения.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--interval

Интервал опроса в секундах.

Default value: 30
--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.