Comparteix via

az security api-collection apim

  • Vista previa

El grupo de comandos "az security api-collection" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Descubra, administre y vea información de seguridad para colecciones de API de Azure API Management.

Comandos

Nombre Description Tipo Estado
az security api-collection apim list

Obtiene una lista de colecciones de API que se han incorporado a Microsoft Defender para LAS API.

 Core Preview
az security api-collection apim offboard

A bordo de una API de Azure API Management de Microsoft Defender para API. El sistema dejará de supervisar las operaciones dentro de la API de Azure API Management para comportamientos intrusivos.

 Core Preview
az security api-collection apim onboard

Incorpore una API de Azure API Management a Microsoft Defender para API. El sistema iniciará la supervisión de las operaciones dentro de la API de Administración de Azure para detectar comportamientos intrusivos y proporcionará alertas de ataques detectados.

 Core Preview
az security api-collection apim show

Obtiene una API de Azure API Management si se ha incorporado a Microsoft Defender para LAS API. Si se incorpora una API de Azure API Management a Microsoft Defender para API, el sistema supervisará las operaciones dentro de la API de Azure API Management para detectar comportamientos intrusivos y proporcionará alertas de ataques detectados.

 Core Preview
az security api-collection apim wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

 Core Preview

az security api-collection apim list

Editar
Vista previa

El grupo de comandos "az security api-collection apim" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtiene una lista de colecciones de API que se han incorporado a Microsoft Defender para LAS API.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name

Nombre del servicio API Management.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az security api-collection apim offboard

Editar
Vista previa

El grupo de comandos "az security api-collection apim" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

A bordo de una API de Azure API Management de Microsoft Defender para API. El sistema dejará de supervisar las operaciones dentro de la API de Azure API Management para comportamientos intrusivos.

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

Ejemplos

Incorpore una API de Azure API Management a Microsoft Defender para API.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-id --name -n

Identificador de revisión de API. Debe ser único en la instancia del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--service-name

Nombre del servicio API Management.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az security api-collection apim onboard

Editar
Vista previa

El grupo de comandos "az security api-collection apim" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Incorpore una API de Azure API Management a Microsoft Defender para API. El sistema iniciará la supervisión de las operaciones dentro de la API de Administración de Azure para detectar comportamientos intrusivos y proporcionará alertas de ataques detectados.

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]

Ejemplos

Incorpore una API de Azure API Management a Microsoft Defender para API.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-id --name -n

Identificador de revisión de API. Debe ser único en la instancia del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--service-name

Nombre del servicio API Management.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az security api-collection apim show

Editar
Vista previa

El grupo de comandos "az security api-collection apim" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtiene una API de Azure API Management si se ha incorporado a Microsoft Defender para LAS API. Si se incorpora una API de Azure API Management a Microsoft Defender para API, el sistema supervisará las operaciones dentro de la API de Azure API Management para detectar comportamientos intrusivos y proporcionará alertas de ataques detectados.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-id --name -n

Identificador de revisión de API. Debe ser único en la instancia del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--service-name

Nombre del servicio API Management.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az security api-collection apim wait

Editar
Vista previa

El grupo de comandos "az security api-collection apim" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--api-id --name -n

Identificador de revisión de API. Debe ser único en la instancia del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 30
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--service-name

Nombre del servicio API Management.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--timeout

Espera máxima en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False