Configurations - Create In Resource Group

Odwołanie

Service:: Advisor

API Version:: 2023-01-01

Utwórz/zastąp konfigurację usługi Azure Advisor.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
configurationName	path	True	ConfigurationName	Nazwa konfiguracji klasyfikatora. Wartość musi być "domyślna"
resourceGroup	path	True	string	Nazwa grupy zasobów platformy Azure.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Treść żądania

Nazwa	Typ	Opis
properties.digests	DigestConfig[]	Konfiguracja skrótu klasyfikatora. Prawidłowe tylko dla subskrypcji
properties.duration	Duration	Minimalny czas trwania oceny niskiego wykorzystania procesora CPU w usłudze Advisor. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 7 (wartość domyślna), 14, 21, 30, 60 lub 90.
properties.exclude	boolean	Wyklucz zasób z ocen usługi Advisor. Prawidłowe wartości: Fałsz (wartość domyślna) lub Prawda.
properties.lowCpuThreshold	CpuThreshold	Minimalny próg procentowy dla oceny niskiego wykorzystania procesora CPU klasyfikatora. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 5 (wartość domyślna), 10, 15 lub 20.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConfigData	Pomyślnie utworzono/zastąpiono konfigurację.
Other Status Codes	ArmErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

PutConfigurations

Sample Request

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"
      }
    ]
  }
}

Sample Response

Status code:: 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"
      }
    ]
  }
}

Definicje

Nazwa	Opis
ArmErrorResponse
ARMErrorResponseBody	Treść odpowiedzi na błędy usługi ARM.
Category	Kategorie do wysyłania skrótów. Jeśli nie podano kategorii, skrót zostanie wysłany dla wszystkich kategorii.
ConfigData	Struktura danych konfiguracji usługi Advisor.
ConfigurationName	Nazwa konfiguracji klasyfikatora. Wartość musi być "domyślna"
CpuThreshold	Minimalny próg procentowy dla oceny niskiego wykorzystania procesora CPU klasyfikatora. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 5 (wartość domyślna), 10, 15 lub 20.
createdByType	Typ tożsamości, która utworzyła zasób.
DigestConfig	Jednostka konfiguracji Szyfruj klasyfikatora
DigestConfigState	Stan konfiguracji skrótu.
Duration	Minimalny czas trwania oceny niskiego wykorzystania procesora CPU w usłudze Advisor. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 7 (wartość domyślna), 14, 21, 30, 60 lub 90.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ArmErrorResponse

Nazwa	Typ	Opis
error	ARMErrorResponseBody	Treść odpowiedzi na błędy usługi ARM.

ARMErrorResponseBody

Treść odpowiedzi na błędy usługi ARM.

Nazwa	Typ	Opis
code	string	Pobiera lub ustawia ciąg, który może służyć do programowego identyfikowania błędu.
message	string	Pobiera lub ustawia ciąg opisujący szczegółowo błąd i dostarcza informacje o debugowaniu.

Nazwa	Typ	Opis
Cost	string
HighAvailability	string
OperationalExcellence	string
Performance	string
Security	string

ConfigData

Struktura danych konfiguracji usługi Advisor.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.digests	DigestConfig[]	Konfiguracja skrótu klasyfikatora. Prawidłowe tylko dla subskrypcji
properties.duration	Duration	Minimalny czas trwania oceny niskiego wykorzystania procesora CPU w usłudze Advisor. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 7 (wartość domyślna), 14, 21, 30, 60 lub 90.
properties.exclude	boolean	Wyklucz zasób z ocen usługi Advisor. Prawidłowe wartości: Fałsz (wartość domyślna) lub Prawda.
properties.lowCpuThreshold	CpuThreshold	Minimalny próg procentowy dla oceny niskiego wykorzystania procesora CPU klasyfikatora. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 5 (wartość domyślna), 10, 15 lub 20.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ConfigurationName

Nazwa konfiguracji klasyfikatora. Wartość musi być "domyślna"

Nazwa	Typ	Opis
default	string

CpuThreshold

Minimalny próg procentowy dla oceny niskiego wykorzystania procesora CPU klasyfikatora. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 5 (wartość domyślna), 10, 15 lub 20.

Nazwa	Typ	Opis
10	string
15	string
20	string
5	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Jednostka konfiguracji Szyfruj klasyfikatora

Nazwa	Typ	Opis
actionGroupResourceId	string	Identyfikator zasobu grupy akcji używany przez skrót.
categories	Category[]	Kategorie do wysyłania skrótów. Jeśli nie podano kategorii, skrót zostanie wysłany dla wszystkich kategorii.
frequency	integer	Częstotliwość wyzwalania skrótu w dniach. Wartość musi zawierać się w przedziale od 7 do 30 dni.
language	string	Język treści zawartości skrótu. Wartość musi być kodem ISO 639-1 dla jednego z Azure Portal obsługiwanych języków. W przeciwnym razie zostanie przekonwertowany na jeden. Wartość domyślna to angielski (en).
name	string	Nazwa konfiguracji skrótu. Wartość jest bez uwzględniania wielkości liter i musi być unikatowa w ramach subskrypcji.
state	DigestConfigState	Stan konfiguracji skrótu.

DigestConfigState

Stan konfiguracji skrótu.

Nazwa	Typ	Opis
Active	string
Disabled	string

Duration

Minimalny czas trwania oceny niskiego wykorzystania procesora CPU w usłudze Advisor. Prawidłowe tylko dla subskrypcji. Prawidłowe wartości: 7 (wartość domyślna), 14, 21, 30, 60 lub 90.

Nazwa	Typ	Opis
14	string
21	string
30	string
60	string
7	string
90	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.