Configurations - Create In Resource Group

Referenz

Dienst:: Advisor

API-Version:: 2023-01-01

Erstellen/Überschreiben der Azure Advisor-Konfiguration

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations/default?api-version=2023-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
configurationName	path	True	ConfigurationName	Name der Advisor-Konfiguration. Der Wert muss "standard" sein.
resourceGroup	path	True	string	Name der Azure-Ressourcengruppe
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
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. Gilt nur für Abonnements. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.
properties.exclude	boolean	Schließen Sie die Ressource aus Advisor-Auswertungen aus. Gültige Werte: False (Standard) oder True.
properties.lowCpuThreshold	CpuThreshold	Mindestprozentwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Gilt nur für Abonnements. Gültige Werte: 5 (Standard), 10, 15 oder 20.

Antworten

Name	Typ	Beschreibung
200 OK	ConfigData	Die Konfiguration wurde erfolgreich erstellt/überschrieben.
Other Status Codes	ArmErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

PutConfigurations

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/default?api-version=2023-01-01

{
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "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"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Advisor/configurations/v2/default",
  "type": "Microsoft.Advisor/configurations",
  "name": "default",
  "properties": {
    "lowCpuThreshold": "5",
    "duration": "7",
    "exclude": true,
    "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"
      }
    ]
  }
}

Definitionen

Name	Beschreibung
ArmErrorResponse
ARMErrorResponseBody	ARM-Fehlerantworttext.
Category	Kategorien, für die der Digest gesendet werden soll. Wenn Keine Kategorien bereitgestellt werden, wird der Digest für alle Kategorien gesendet.
ConfigData	Die Struktur der Advisor-Konfigurationsdaten.
ConfigurationName	Name der Advisor-Konfiguration. Der Wert muss "standard" sein.
CpuThreshold	Mindestprozentwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Gilt nur für Abonnements. 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. Gilt nur für Abonnements. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ArmErrorResponse

Name	Typ	Beschreibung
error	ARMErrorResponseBody	ARM-Fehlerantworttext.

ARMErrorResponseBody

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	Ruft die Zeichenfolge ab, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt, oder legt diese fest.

Name	Typ	Beschreibung
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

ConfigData

Die Struktur der Advisor-Konfigurationsdaten.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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. Gilt nur für Abonnements. Gültige Werte: 7 (Standard), 14, 21, 30, 60 oder 90.
properties.exclude	boolean	Schließen Sie die Ressource aus Advisor-Auswertungen aus. Gültige Werte: False (Standard) oder True.
properties.lowCpuThreshold	CpuThreshold	Mindestprozentwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Gilt nur für Abonnements. Gültige Werte: 5 (Standard), 10, 15 oder 20.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ConfigurationName

Name der Advisor-Konfiguration. Der Wert muss "standard" sein.

Name	Typ	Beschreibung
default	string

CpuThreshold

Mindestprozentwert für die Bewertung der niedrigen CPU-Auslastung von Advisor. Gilt nur für Abonnements. Gültige Werte: 5 (Standard), 10, 15 oder 20.

Name	Typ	Beschreibung
10	string
15	string
20	string
5	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Advisor Digest-Konfigurationsentität

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

DigestConfigState

Status der Digestkonfiguration.

Name	Typ	Beschreibung
Active	string
Disabled	string

Duration

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

Name	Typ	Beschreibung
14	string
21	string
30	string
60	string
7	string
90	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	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	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