Recommendations - List Recommended Rules For Hosting Environment

Dienst:

App Service

API-Version:

2024-11-01

Beschreibung für alle Empfehlungen für eine Hostingumgebung.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
hostingEnvironmentName	path	True	string	Name der App.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version
$filter	query		string	Gibt nur kanäle zurück, die im Filter angegeben sind. Der Filter wird mithilfe der OData-Syntax angegeben. Beispiel: $filter=channel eq 'API' oder Kanal eq 'Notification'
featured	query		boolean	Geben Sie true an, um nur die wichtigsten Empfehlungen zurückzugeben. Der Standardwert ist false, der alle Empfehlungen zurückgibt.

Antworten

Name	Typ	Beschreibung
200 OK	RecommendationCollection	OKAY
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Definitionen

Name	Beschreibung
Channels	Liste der Kanäle, die diese Empfehlung anwenden kann.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
NotificationLevel	Stufe, die angibt, wie kritisch diese Empfehlung wirken kann.
Recommendation	Stellt ein Empfehlungsergebnis dar, das vom Empfehlungsmodul generiert wird.
RecommendationCollection	Sammlung von Empfehlungen.
ResourceScopeType	Der Name eines Ressourcentyps gilt für diese Empfehlung, z. B. Abonnement, ServerFarm, Website.

Channels

Enumeration

Liste der Kanäle, die diese Empfehlung anwenden kann.

Wert	Beschreibung
All
Api
Email
Notification
Webhook

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

NotificationLevel

Enumeration

Stufe, die angibt, wie kritisch diese Empfehlung wirken kann.

Wert	Beschreibung
Critical
Information
NonUrgentSuggestion
Warning

Recommendation

Objekt

Stellt ein Empfehlungsergebnis dar, das vom Empfehlungsmodul generiert wird.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.actionName	string	Name der Aktion, die von diesem Objekt empfohlen wird.
properties.bladeName	string	Deep-Link zu einem Blatt im Portal.
properties.categoryTags	string[]	Die Liste der Kategorietags, zu denen diese Empfehlung gehört.
properties.channels	Channels	Liste der Kanäle, die diese Empfehlung anwenden kann.
properties.creationTime	string (date-time)	Zeitstempel, als diese Instanz erstellt wurde.
properties.displayName	string	Ui-Anzeigename der Regel (möglicherweise nicht eindeutig).
properties.enabled	integer (int32)	True, wenn diese Empfehlung noch gültig ist (d. h. "Handlungsfähig"). False, wenn er ungültig ist.
properties.endTime	string (date-time)	Die Endzeit in UTC eines Bereichs, auf den sich die Empfehlung bezieht.
properties.extensionName	string	Erweiterungsname des Portals, falls vorhanden.
properties.forwardLink	string	Weiterleiten einer Verknüpfung zu einem externen Dokument, das der Regel zugeordnet ist.
properties.isDynamic	boolean	True, wenn dies einer dynamisch hinzugefügten Regel zugeordnet ist
properties.level	NotificationLevel	Stufe, die angibt, wie kritisch diese Empfehlung wirken kann.
properties.message	string	Empfehlungstext.
properties.nextNotificationTime	string (date-time)	Wann diese Empfehlung als Nächstes in UTC benachrichtigt werden soll. Null bedeutet, dass dies nie mehr benachrichtigt wird.
properties.notificationExpirationTime	string (date-time)	Datum und Uhrzeit in UTC, wann diese Benachrichtigung abläuft.
properties.notifiedTime	string (date-time)	Der letzte Zeitstempel in UTC wurde tatsächlich benachrichtigt. Null bedeutet, dass diese Empfehlung noch nicht benachrichtigt wurde.
properties.recommendationId	string (uuid)	Ein GUID-Wert, dem jedes Empfehlungsobjekt zugeordnet ist.
properties.resourceId	string	Vollständige ARM-Ressourcen-ID-Zeichenfolge, der dieses Empfehlungsobjekt zugeordnet ist.
properties.resourceScope	ResourceScopeType	Der Name eines Ressourcentyps gilt für diese Empfehlung, z. B. Abonnement, ServerFarm, Website.
properties.ruleName	string	Eindeutiger Name der Regel.
properties.score	number (double)	Ein von der Regel gemessener Metrikwert.
properties.startTime	string (date-time)	Die Anfangszeit in UTC eines Bereichs, auf den sich die Empfehlung bezieht.
properties.states	string[]	Die Liste der Zustände dieser Empfehlung. Wenn es null ist, sollte sie als "Aktiv" betrachtet werden.
type	string	Ressourcentyp.

RecommendationCollection

Objekt

Sammlung von Empfehlungen.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite von Ressourcen.
value	Recommendation[]	Sammlung von Ressourcen.

ResourceScopeType

Enumeration

Der Name eines Ressourcentyps gilt für diese Empfehlung, z. B. Abonnement, ServerFarm, Website.

Wert	Beschreibung
ServerFarm
Subscription
WebSite