Configurations - List By Subscription

Referenz

Dienst:: Advisor

API-Version:: 2025-01-01

Rufen Sie Azure Advisor-Konfigurationen ab und rufen Sie auch Konfigurationen von enthaltenen Ressourcengruppen ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ConfigurationListResult	OKAY. Die Konfigurationen wurden erfolgreich abgerufen.
Other Status Codes	ArmErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Beispiele

GetConfigurations

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Advisor/configurations?api-version=2025-01-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/default",
      "type": "Microsoft.Advisor/configurations",
      "name": "default",
      "properties": {
        "lowCpuThreshold": "5",
        "duration": "7",
        "exclude": false,
        "digests": [
          {
            "name": "digestConfigName",
            "actionGroupResourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/microsoft.insights/actionGroups/actionGroupName",
            "frequency": 30,
            "categories": [
              "HighAvailability",
              "Security",
              "Performance",
              "Cost",
              "OperationalExcellence"
            ],
            "language": "en",
            "state": "Active"
          }
        ]
      }
    }
  ],
  "nextLink": "string"
}

Definitionen

Name	Beschreibung
ArmErrorResponse
ARMErrorResponseBody	ARM-Fehlerantworttext.
Category	Kategorien, für die Digest gesendet werden soll. Wenn keine Kategorien angegeben werden, wird der Digest für alle Kategorien gesendet.
ConfigData	Die Konfigurationsdatenstruktur des Advisor.
ConfigurationListResult	Die Liste der Advisor-Konfigurationen.
CpuThreshold	Mindestprozentschwellenwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 5 (Standard), 10, 15 oder 20.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DigestConfig	Advisor Digest-Konfigurationsentität
DigestConfigState	Status der Digestkonfiguration.
Duration	Mindestdauer für die Auswertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

ArmErrorResponse

Objekt

Name	Typ	Beschreibung
error	ARMErrorResponseBody	ARM-Fehlerantworttext.

ARMErrorResponseBody

Objekt

ARM-Fehlerantworttext.

Name	Typ	Beschreibung
code	string	Ruft die Zeichenfolge ab, die zum programmgesteuerten Identifizieren des Fehlers verwendet werden kann, oder legt diese fest.
message	string	Dient zum Abrufen oder Festlegen der Zeichenfolge, die den Fehler im Detail beschreibt und Debuginformationen bereitstellt.

Wert	Beschreibung
Cost
HighAvailability
OperationalExcellence
Performance
Security

ConfigData

Objekt

Die Konfigurationsdatenstruktur des Advisor.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.digests	DigestConfig[]	Konfiguration des Advisor-Digests. Nur für Abonnements gültig
properties.duration	Duration	Mindestdauer für die Auswertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.
properties.exclude	boolean	Schließen Sie die Ressource aus Den Advisor-Auswertungen aus. Gültige Werte: False (Standard) oder True.
properties.lowCpuThreshold	CpuThreshold	Mindestprozentschwellenwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 5 (Standard), 10, 15 oder 20.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ConfigurationListResult

Objekt

Die Liste der Advisor-Konfigurationen.

Name	Typ	Beschreibung
nextLink	string	Der Link, der zum Abrufen der nächsten Seite von Konfigurationen verwendet wird.
value	ConfigData[]	Die Liste der Konfigurationen.

CpuThreshold

Enumeration

Mindestprozentschwellenwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 5 (Standard), 10, 15 oder 20.

Wert	Beschreibung
10
15
20
5

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DigestConfig

Objekt

Advisor Digest-Konfigurationsentität

Name	Typ	Beschreibung
actionGroupResourceId	string	Aktionsgruppenressourcen-ID, die von Digest verwendet wird.
categories	Category[]	Kategorien, für die Digest gesendet werden soll. Wenn keine Kategorien angegeben werden, wird der Digest für alle Kategorien gesendet.
frequency	integer (int32)	Häufigkeit, mit der der Digest in Tagen ausgelöst wird. Der Wert muss zwischen 7 und 30 Tagen (einschließlich) liegen.
language	string	Sprache für Digestinhaltstext. Der Wert muss ISO 639-1-Code für eine der unterstützten Azure-Portalsprachen sein. Andernfalls wird sie in eine konvertiert. Der Standardwert ist Englisch (en).
name	string	Name der Digestkonfiguration. Bei Wert wird die Groß-/Kleinschreibung nicht beachtet und muss innerhalb eines Abonnements eindeutig sein.
state	DigestConfigState	Status der Digestkonfiguration.

DigestConfigState

Enumeration

Status der Digestkonfiguration.

Wert	Beschreibung
Active
Disabled

Duration

Enumeration

Mindestdauer für die Auswertung der niedrigen CPU-Auslastung von Advisor. Nur für Abonnements gültig. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.

Wert	Beschreibung
14
21
30
60
7
90

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Configurations - List By Subscription

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GetConfigurations

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ArmErrorResponse

ARMErrorResponseBody

Category

ConfigData

ConfigurationListResult

CpuThreshold

createdByType

DigestConfig

DigestConfigState

Duration

systemData