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

az security api-collection apim

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

Команда az security api-collection находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Обнаружение, управление и просмотр аналитических сведений о безопасности коллекций API из службы "Управление API Azure".

Команды

Имя Описание Тип Состояние
az security api-collection apim list

Возвращает список коллекций API, которые были подключены к Microsoft Defender для API.

 Core Preview
az security api-collection apim offboard

Отключение API управления API Azure из Microsoft Defender для API. Система перестанет отслеживать операции в API управления API Azure для навязчивого поведения.

 Core Preview
az security api-collection apim onboard

Подключение API управления API Azure к API Microsoft Defender для API. Система начнет мониторинг операций в API управления Azure для навязчивого поведения и предоставит оповещения об обнаруженных атаках.

 Core Preview
az security api-collection apim show

Получает API управления API Azure, если он был подключен к Microsoft Defender для API. Если API управления API Azure подключен к API Microsoft Defender для API, система будет отслеживать операции в API управления API Azure для навязчивого поведения и предоставлять оповещения об обнаруженных атаках.

 Core Preview
az security api-collection apim wait

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

 Core Preview

az security api-collection apim list

Изменить
Предварительный просмотр

Командная группа az security api-collection apim находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Возвращает список коллекций API, которые были подключены к Microsoft Defender для API.

az security api-collection apim list [--max-items]
                                     [--next-token]
                                     [--resource-group]
                                     [--service-name]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

Свойство Значение
Parameter group: Pagination Arguments
--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

Свойство Значение
Parameter group: Pagination Arguments
--resource-group -g

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

--service-name

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az security api-collection apim offboard

Изменить
Предварительный просмотр

Командная группа az security api-collection apim находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Отключение API управления API Azure из Microsoft Defender для API. Система перестанет отслеживать операции в API управления API Azure для навязчивого поведения.

az security api-collection apim offboard [--api-id --name]
                                         [--ids]
                                         [--resource-group]
                                         [--service-name]
                                         [--subscription]
                                         [--yes]

Примеры

Подключение API управления API Azure к API Microsoft Defender для API.

az security api-collection apim offboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id --name -n

Идентификатор редакции API. Должен быть уникальным в экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

Свойство Значение
Parameter group: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--service-name

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--yes -y

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Default value: False

az security api-collection apim onboard

Изменить
Предварительный просмотр

Командная группа az security api-collection apim находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Подключение API управления API Azure к API Microsoft Defender для API. Система начнет мониторинг операций в API управления Azure для навязчивого поведения и предоставит оповещения об обнаруженных атаках.

az security api-collection apim onboard [--api-id --name]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--service-name]
                                        [--subscription]

Примеры

Подключение API управления API Azure к API Microsoft Defender для API.

az security api-collection apim onboard --resource-group MyResourceGroup --service-name MyApiManagementServiceName --api-id echo-api

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id --name -n

Идентификатор редакции API. Должен быть уникальным в экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

Свойство Значение
Parameter group: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

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

Свойство Значение
Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--service-name

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Default value: False

az security api-collection apim show

Изменить
Предварительный просмотр

Командная группа az security api-collection apim находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Получает API управления API Azure, если он был подключен к Microsoft Defender для API. Если API управления API Azure подключен к API Microsoft Defender для API, система будет отслеживать операции в API управления API Azure для навязчивого поведения и предоставлять оповещения об обнаруженных атаках.

az security api-collection apim show [--api-id --name]
                                     [--ids]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id --name -n

Идентификатор редакции API. Должен быть уникальным в экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

Свойство Значение
Parameter group: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--service-name

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Default value: False

az security api-collection apim wait

Изменить
Предварительный просмотр

Командная группа az security api-collection apim находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

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

az security api-collection apim wait [--api-id --name]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--resource-group]
                                     [--service-name]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id --name -n

Идентификатор редакции API. Должен быть уникальным в экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

Свойство Значение
Parameter group: Resource Id Arguments
--created

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--interval

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

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

Свойство Значение
Parameter group: Resource Id Arguments
--service-name

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

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

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

Свойство Значение
Parameter group: Resource Id Arguments
--timeout

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--verbose

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

Свойство Значение
Default value: False