Recommendations - List Recommended Rules For Hosting Environment

Servicio:

App Service

Versión de la API:

2024-11-01

Descripción para obtener todas las recomendaciones para un entorno de hospedaje.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations?api-version=2024-11-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations?featured={featured}&api-version=2024-11-01&$filter={$filter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
hostingEnvironmentName	path	True	string	Nombre de la aplicación.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API
$filter	query		string	Devuelve solo los canales especificados en el filtro. El filtro se especifica mediante la sintaxis de OData. Ejemplo: $filter=channel eq 'Api' o channel eq 'Notification'
featured	query		boolean	Especifique true para devolver solo las recomendaciones más críticas. El valor predeterminado es false, que devuelve todas las recomendaciones.

Respuestas

Nombre	Tipo	Description
200 OK	RecommendationCollection	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Definiciones

Nombre	Description
Channels	Lista de canales que esta recomendación puede aplicar.
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
NotificationLevel	Nivel que indica cómo puede afectar esta recomendación.
Recommendation	Representa un resultado de recomendación generado por el motor de recomendaciones.
RecommendationCollection	Colección de recomendaciones.
ResourceScopeType	Nombre de un tipo de recurso que esta recomendación aplica, por ejemplo, Suscripción, ServerFarm, Sitio.

Channels

Enumeración

Lista de canales que esta recomendación puede aplicar.

Valor	Description
All
Api
Email
Notification
Webhook

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

NotificationLevel

Enumeración

Nivel que indica cómo puede afectar esta recomendación.

Valor	Description
Critical
Information
NonUrgentSuggestion
Warning

Recommendation

Object

Representa un resultado de recomendación generado por el motor de recomendaciones.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.actionName	string	Nombre de la acción recomendada por este objeto.
properties.bladeName	string	Vínculo profundo a una hoja en el portal.
properties.categoryTags	string[]	Lista de etiquetas de categoría a las que pertenece esta recomendación.
properties.channels	Channels	Lista de canales que esta recomendación puede aplicar.
properties.creationTime	string (date-time)	Marca de tiempo cuando se creó esta instancia.
properties.displayName	string	Nombre descriptivo de la interfaz de usuario de la regla (puede que no sea único).
properties.enabled	integer (int32)	True si esta recomendación sigue siendo válida (es decir, "accionable"). False si no es válido.
properties.endTime	string (date-time)	Hora de finalización en UTC de un intervalo al que hace referencia la recomendación.
properties.extensionName	string	Nombre de extensión del portal si existe.
properties.forwardLink	string	Reenvíe el vínculo a un documento externo asociado a la regla.
properties.isDynamic	boolean	True si esto está asociado a una regla agregada dinámicamente
properties.level	NotificationLevel	Nivel que indica cómo puede afectar esta recomendación.
properties.message	string	Texto de la recomendación.
properties.nextNotificationTime	string (date-time)	Cuándo notificar esta recomendación a continuación en UTC. Null significa que ya no se notificará esto.
properties.notificationExpirationTime	string (date-time)	Fecha y hora en UTC cuando expira esta notificación.
properties.notifiedTime	string (date-time)	Última marca de tiempo en UTC esta instancia se notificó realmente. Null significa que esta recomendación aún no se ha notificado.
properties.recommendationId	string (uuid)	Valor GUID al que está asociado cada objeto de recomendación.
properties.resourceId	string	Cadena de identificador de recurso de ARM completa a la que está asociado este objeto de recomendación.
properties.resourceScope	ResourceScopeType	Nombre de un tipo de recurso que esta recomendación aplica, por ejemplo, Suscripción, ServerFarm, Sitio.
properties.ruleName	string	Nombre único de la regla.
properties.score	number (double)	Valor de métrica medido por la regla.
properties.startTime	string (date-time)	Hora inicial en UTC de un intervalo al que hace referencia la recomendación.
properties.states	string[]	Lista de estados de esta recomendación. Si es null, se debe considerar "Activo".
type	string	Tipo de recurso.

RecommendationCollection

Object

Colección de recomendaciones.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de recursos.
value	Recommendation[]	Colección de recursos.

ResourceScopeType

Enumeración

Nombre de un tipo de recurso que esta recomendación aplica, por ejemplo, Suscripción, ServerFarm, Sitio.

Valor	Description
ServerFarm
Subscription
WebSite