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


az apim nv

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

Команды

Имя Описание Тип Состояние
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

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

значение по умолчанию: False
--secret

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

допустимые значения: false, true
значение по умолчанию: False
--tags

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

--value

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: 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

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

значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: 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
значение по умолчанию: 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
значение по умолчанию: 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
значение по умолчанию: 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>.

значение по умолчанию: []
--force-string

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

значение по умолчанию: False
--if-match

ETag сущности.

--remove

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

значение по умолчанию: []
--secret

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

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

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

значение по умолчанию: []
--tags

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

--value

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: 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 по адресу "Успешно".

значение по умолчанию: False
--custom

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

--deleted

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

значение по умолчанию: False
--exists

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

значение по умолчанию: False
--interval

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

значение по умолчанию: 30
--timeout

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

значение по умолчанию: 3600
--updated

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

значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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