Configurations - Create In Resource Group

Služba:

Advisor

Verze rozhraní API:

2023-01-01

Vytvoření nebo přepsání konfigurace Azure Advisoru

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
configurationName	path	True	ConfigurationName	Název konfigurace Advisoru. Hodnota musí být výchozí.
resourceGroup	path	True	string	Název skupiny prostředků Azure.
subscriptionId	path	True	string	ID předplatného Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Name	Typ	Description
properties.digests	DigestConfig[]	Konfigurace přehledu advisoru Platí jenom pro předplatná.
properties.duration	Duration	Minimální doba vyhodnocování nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 7 (výchozí), 14, 21, 30, 60 nebo 90.
properties.exclude	boolean	Vylučte prostředek z hodnocení Advisoru. Platné hodnoty: False (výchozí) nebo True.
properties.lowCpuThreshold	CpuThreshold	Minimální procentuální prahová hodnota pro vyhodnocení nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 5 (výchozí), 10, 15 nebo 20.

Odpovědi

Name	Typ	Description
200 OK	ConfigData	Konfigurace se úspěšně vytvořila nebo přepsala.
Other Status Codes	ArmErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

PutConfigurations

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ArmErrorResponse
ARMErrorResponseBody	Text odpovědi na chyby ARM.
Category	Kategorie, pro které se má odeslat přehled. Pokud kategorie nejsou zadané, bude pro všechny kategorie odeslána hodnota hash.
ConfigData	Struktura konfiguračních dat Advisoru
ConfigurationName	Název konfigurace Advisoru. Hodnota musí být výchozí.
CpuThreshold	Minimální procentuální prahová hodnota pro vyhodnocení nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 5 (výchozí), 10, 15 nebo 20.
createdByType	Typ identity, která prostředek vytvořila.
DigestConfig	Entita konfigurace Advisor Digest
DigestConfigState	Stav konfigurace hodnoty hash.
Duration	Minimální doba vyhodnocování nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 7 (výchozí), 14, 21, 30, 60 nebo 90.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

ArmErrorResponse

Name	Typ	Description
error	ARMErrorResponseBody	Text odpovědi na chyby ARM.

ARMErrorResponseBody

Text odpovědi na chyby ARM.

Name	Typ	Description
code	string	Získá nebo nastaví řetězec, který lze použít k programové identifikaci chyby.
message	string	Získá nebo nastaví řetězec, který podrobně popisuje chybu a poskytuje informace o ladění.

Category

Kategorie, pro které se má odeslat přehled. Pokud kategorie nejsou zadané, bude pro všechny kategorie odeslána hodnota hash.

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

ConfigData

Struktura konfiguračních dat Advisoru

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
name	string	Název prostředku
properties.digests	DigestConfig[]	Konfigurace přehledu advisoru Platí jenom pro předplatná.
properties.duration	Duration	Minimální doba vyhodnocování nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 7 (výchozí), 14, 21, 30, 60 nebo 90.
properties.exclude	boolean	Vylučte prostředek z hodnocení Advisoru. Platné hodnoty: False (výchozí) nebo True.
properties.lowCpuThreshold	CpuThreshold	Minimální procentuální prahová hodnota pro vyhodnocení nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 5 (výchozí), 10, 15 nebo 20.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ConfigurationName

Název konfigurace Advisoru. Hodnota musí být výchozí.

Name	Typ	Description
default	string

CpuThreshold

Minimální procentuální prahová hodnota pro vyhodnocení nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 5 (výchozí), 10, 15 nebo 20.

Name	Typ	Description
10	string
15	string
20	string
5	string

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Entita konfigurace Advisor Digest

Name	Typ	Description
actionGroupResourceId	string	ID prostředku skupiny akcí používaného hodnotou hash
categories	Category[]	Kategorie, pro které se má odeslat přehled. Pokud kategorie nejsou zadané, bude pro všechny kategorie odeslána hodnota hash.
frequency	integer	Frekvence aktivace hodnot hash ve dnech Hodnota musí být mezi 7 a 30 dny včetně.
language	string	Jazyk pro tělo obsahu hodnot hash. Hodnota musí být kód ISO 639-1 pro jeden z podporovaných jazyků Azure Portal. V opačném případě se převede na jeden. Výchozí hodnota je Angličtina (en).
name	string	Název konfigurace digest. Hodnota nerozlišuje malá a velká písmena a musí být v rámci předplatného jedinečná.
state	DigestConfigState	Stav konfigurace hodnoty hash.

DigestConfigState

Stav konfigurace hodnoty hash.

Name	Typ	Description
Active	string
Disabled	string

Duration

Minimální doba vyhodnocování nízkého využití procesoru advisorem Platí jenom pro předplatná. Platné hodnoty: 7 (výchozí), 14, 21, 30, 60 nebo 90.

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

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.