Configurations - Create In Subscription

Tjänst:

Advisor

API-version:

2023-01-01

Skapa/skriv över Azure Advisor-konfiguration och ta även bort alla konfigurationer av inneslutna resursgrupper.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
configurationName	path	True	ConfigurationName	Advisor-konfigurationsnamn. Värdet måste vara "standard"
subscriptionId	path	True	string	Azure-prenumerations-ID:t.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran.

Begärandetext

Name	Typ	Description
properties.digests	DigestConfig[]	Advisors sammandragskonfiguration. Endast giltigt för prenumerationer
properties.duration	Duration	Minsta varaktighet för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 7 (standard), 14, 21, 30, 60 eller 90.
properties.exclude	boolean	Undanta resursen från Advisor-utvärderingar. Giltiga värden: Falskt (standard) eller Sant.
properties.lowCpuThreshold	CpuThreshold	Lägsta tröskelvärde i procent för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 5 (standard), 10, 15 eller 20.

Svar

Name	Typ	Description
200 OK	ConfigData	Konfigurationen har skapats/skrivs över.
Other Status Codes	ArmErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

PutConfigurations

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/subscriptionId/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"
      }
    ]
  }
}

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ArmErrorResponse
ARMErrorResponseBody	ARM-felsvarstext.
Category	Kategorier att skicka sammandrag för. Om kategorier inte anges skickas sammandrag för alla kategorier.
ConfigData	Advisor-konfigurationsdatastrukturen.
ConfigurationName	Advisor-konfigurationsnamn. Värdet måste vara "standard"
CpuThreshold	Lägsta tröskelvärde i procent för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 5 (standard), 10, 15 eller 20.
createdByType	Den typ av identitet som skapade resursen.
DigestConfig	Advisor Digest-konfigurationsentitet
DigestConfigState	Tillstånd för sammandragskonfiguration.
Duration	Minsta varaktighet för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 7 (standard), 14, 21, 30, 60 eller 90.
systemData	Metadata som rör skapande och senaste ändring av resursen.

ArmErrorResponse

Name	Typ	Description
error	ARMErrorResponseBody	ARM-felsvarstext.

ARMErrorResponseBody

ARM-felsvarstext.

Name	Typ	Description
code	string	Hämtar eller anger den sträng som kan användas för att programmatiskt identifiera felet.
message	string	Hämtar eller anger strängen som beskriver felet i detalj och tillhandahåller felsökningsinformation.

Category

Kategorier att skicka sammandrag för. Om kategorier inte anges skickas sammandrag för alla kategorier.

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

ConfigData

Advisor-konfigurationsdatastrukturen.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.digests	DigestConfig[]	Advisors sammandragskonfiguration. Endast giltigt för prenumerationer
properties.duration	Duration	Minsta varaktighet för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 7 (standard), 14, 21, 30, 60 eller 90.
properties.exclude	boolean	Undanta resursen från Advisor-utvärderingar. Giltiga värden: Falskt (standard) eller Sant.
properties.lowCpuThreshold	CpuThreshold	Lägsta tröskelvärde i procent för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 5 (standard), 10, 15 eller 20.
systemData	systemData	Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ConfigurationName

Advisor-konfigurationsnamn. Värdet måste vara "standard"

Name	Typ	Description
default	string

CpuThreshold

Lägsta tröskelvärde i procent för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 5 (standard), 10, 15 eller 20.

Name	Typ	Description
10	string
15	string
20	string
5	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DigestConfig

Advisor Digest-konfigurationsentitet

Name	Typ	Description
actionGroupResourceId	string	Resurs-ID för åtgärdsgrupp som används av digest.
categories	Category[]	Kategorier att skicka sammandrag för. Om kategorier inte anges skickas sammandrag för alla kategorier.
frequency	integer	Frekvens som sammandrag utlöses i dagar. Värdet måste vara mellan 7 och 30 dagar.
language	string	Språk för sammanfattande innehållstext. Värdet måste vara ISO 639-1-kod för något av Azure Portal språk som stöds. Annars konverteras den till en. Standardvärdet är engelska (en).
name	string	Namn på sammandragskonfiguration. Värdet är skiftlägesokänsligt och måste vara unikt i en prenumeration.
state	DigestConfigState	Tillstånd för sammandragskonfiguration.

DigestConfigState

Tillstånd för sammandragskonfiguration.

Name	Typ	Description
Active	string
Disabled	string

Duration

Minsta varaktighet för utvärdering av låg CPU-användning i Advisor. Gäller endast för prenumerationer. Giltiga värden: 7 (standard), 14, 21, 30, 60 eller 90.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.