Recommendations - Patch

Služba:: Advisor

Verze rozhraní API:: 2025-05-01-preview

Aktualizujte sledované vlastnosti doporučení.

PATCH https://management.azure.com/{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}?api-version=2025-05-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
recommendationId	path	True	string	ID ID id doporučení.
resourceUri	path	True	string	Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku, na který se vztahuje sledované doporučení.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Name	Typ	Description
properties	Properties

Odpovědi

Name	Typ	Description
200 OK	ResourceRecommendationBase	OK. Stav doporučení byl úspěšně aktualizován.
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

UpdateTrackedRecommendation

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Advisor/recommendations/c5532a76-8605-4328-ad27-f37ae87c086c?api-version=2025-05-01-preview

{
  "properties": {
    "trackedProperties": {
      "state": "Postponed",
      "postponedTime": "2023-10-01T00:00:00Z"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Advisor/recommendations/c5532a76-8605-4328-ad27-f37ae87c086c",
  "name": "c5532a76-8605-4328-ad27-f37ae87c086c",
  "type": "Microsoft.Advisor/recommendations",
  "properties": {
    "category": "Security",
    "impact": "Medium",
    "impactedField": "Microsoft.Compute/virtualMachines",
    "impactedValue": "armavset",
    "lastUpdated": "2017-02-24T22:24:43.3216408Z",
    "risk": "Warning",
    "shortDescription": {
      "problem": "Monitoring agent should be installed on your machines",
      "solution": "Monitoring agent should be installed on your machines"
    },
    "remediation": {
      "additionalProperties": {
        "httpMethod": "POST",
        "uri": "uri",
        "details": "link to document"
      }
    },
    "resourceMetadata": {
      "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Compute/virtualMachines/xyz",
      "source": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Compute/virtualMachines/xyz/providers/Microsoft.Security/assessments/7d5f6ba5-307e-452e-b3c4-7d636f722055",
      "action": {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link3",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroupName/providers/Microsoft.Compute/virtualMachines/xyz"
        }
      },
      "singular": "Virtual machine",
      "plural": "Virtual machines"
    },
    "actions": [
      {
        "additionalProperties": {
          "actionType": "Document",
          "link": "https://link1",
          "caption": "Enable Soft Delete to protect blob data",
          "description": "Enable Soft Delete to protect blob data"
        },
        "metadata": {
          "id": "/subscriptions/00000000-1111-2222-3333-444444444444"
        }
      }
    ],
    "description": "After enabling Soft Delete, deleted data transitions to a soft deleted state instead of being permanently deleted. When data is overwritten, a soft deleted snapshot is generated to save the state of the overwritten data. You can configure the amount of time soft deleted data is recoverable before it permanently expires.",
    "label": "Enable Soft Delete",
    "learnMoreLink": "https://link2",
    "potentialBenefits": "Save and recover your data when blobs or blob snapshots are accidentally overwritten or deleted",
    "tracked": true,
    "trackedProperties": {
      "state": "Postponed",
      "postponedTime": "2023-10-01T00:00:00Z",
      "priority": "High"
    },
    "resourceWorkload": {
      "id": "0560dbdb-f207-4690-b4ba-1fc0c3a0f082",
      "name": "Critical VM Workload"
    },
    "review": {
      "id": "/subscriptions/a5481ee1-95df-47d0-85d4-dd3f0dfa19bc/providers/Microsoft.Advisor/assessments/MCWAR1",
      "name": "Monthly WAF Review 09/23"
    },
    "sourceSystem": "CxObserve",
    "notes": "This is a note"
  }
}

Definice

Name	Description
aggregated	Úroveň agregace skóre.
ArmErrorResponse
ARMErrorResponseBody	Text odpovědi na chybu ARM
category	Kategorie doporučení.
control	Podkategorie doporučení.
createdByType	Typ identity, která prostředek vytvořila.
impact	Obchodní dopad doporučení.
priority	Priorita doporučení.
Properties	Data skóre Advisoru.
reason	Důvod změny stavu doporučení.
ResourceMetadata	Metadata prostředků doporučení
ResourceRecommendationBase	Doporučení poradce.
ResourceWorkload	Úloha, do které tento prostředek patří.
Review	Kontrola, do které toto doporučení patří.
risk	Potenciální riziko, že doporučení neimisíte.
scoreEntity	Podrobnosti o skóre advisoru
ShortDescription	Shrnutí doporučení.
state	Stav doporučení
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
timeSeriesEntity	Historická data na různých úrovních agregace.
TrackedRecommendationProperties	Sledované vlastnosti doporučení
TrackedRecommendationPropertiesPayload

aggregated

Výčet

Úroveň agregace skóre.

Hodnota	Description
day
month
week

ArmErrorResponse

Objekt

Name	Typ	Description
error	ARMErrorResponseBody	Text odpovědi na chybu ARM

ARMErrorResponseBody

Objekt

Text odpovědi na chybu 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í.

Hodnota	Description
Cost
HighAvailability
OperationalExcellence
Performance
Security

control

Výčet

Podkategorie doporučení.

Hodnota	Description
BusinessContinuity
DisasterRecovery
HighAvailability
MonitoringAndAlerting
Other
Personalized
PrioritizedRecommendations
Scalability
ServiceUpgradeAndRetirement

createdByType

Výčet

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

Hodnota	Description
Application
Key
ManagedIdentity
User

impact

Výčet

Obchodní dopad doporučení.

Hodnota	Description
High
Low
Medium

priority

Výčet

Priorita doporučení.

Hodnota	Description
Critical
High
Informational
Low
Medium

Properties

Objekt

Data skóre Advisoru.

Name	Typ	Description
lastRefreshedScore	scoreEntity	Podrobnosti o nejnovějším dostupném skóre
timeSeries	timeSeriesEntity[]	Historická data skóre Advisoru.

reason

Výčet

Důvod změny stavu doporučení.

Hodnota	Description
AlternativeSolution
ExcessiveInvestment
Incompatible
RiskAccepted
TooComplex
Unclear

ResourceMetadata

Objekt

Metadata prostředků doporučení

Name	Typ	Description
action	object	Akce k zobrazení prostředku.
plural	string	Uživatelsky přívětivý název typu prostředku v množném čísle např: virtuální počítače
resourceId	string	ID prostředku Azure pro vyhodnocený prostředek
singular	string	Jedinečný popisný název typu prostředku. např: virtuální počítač
source	string	Zdroj, ze kterého se vygeneruje doporučení

ResourceRecommendationBase

Objekt

Doporučení poradce.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.actions	object[]	Seznam doporučených akcí pro implementaci doporučení
properties.category	category	Kategorie doporučení.
properties.control	control	Podkategorie doporučení.
properties.description	string	Podrobný popis doporučení.
properties.exposedMetadataProperties	object	Vlastnosti metadat doporučení zveřejněné zákazníkovi za účelem poskytnutí dalších informací.
properties.extendedProperties	object	Rozšířené vlastnosti
properties.impact	impact	Obchodní dopad doporučení.
properties.impactedField	string	Typ prostředku identifikovaný advisorem.
properties.impactedValue	string	Prostředek identifikovaný advisorem.
properties.label	string	Popisek doporučení
properties.lastUpdated	string (date-time)	Nejnovější čas, kdy Advisor zkontroloval platnost doporučení.
properties.learnMoreLink	string	Odkaz na další informace o logice doporučení a generování
properties.metadata	object	Metadata doporučení.
properties.notes	string	Další poznámky k doporučení
properties.potentialBenefits	string	Potenciální výhoda implementace doporučení.
properties.recommendationTypeId	string	Identifikátor GUID typu doporučení.
properties.remediation	object	Automatizovaný způsob použití doporučení.
properties.resourceMetadata	ResourceMetadata	Metadata prostředku, který byl posouzen
properties.resourceWorkload	ResourceWorkload	Úloha, do které tento prostředek patří.
properties.review	Review	Kontrola, do které toto doporučení patří.
properties.risk	risk	Potenciální riziko, že doporučení neimisíte.
properties.shortDescription	ShortDescription	Shrnutí doporučení.
properties.sourceSystem	string	Zdrojový systém, ze kterého toto doporučení pochází.
properties.suppressionIds	string[] (uuid)	Seznam snoozed a zamítnutých pravidel doporučení.
properties.tracked	boolean	Pokud je povolené sledování doporučení.
properties.trackedProperties	TrackedRecommendationProperties	Vlastnosti sledovaného doporučení
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ResourceWorkload

Objekt

Úloha, do které tento prostředek patří.

Name	Typ	Description
id	string	ID úlohy
name	string	Název úlohy

Review

Objekt

Kontrola, do které toto doporučení patří.

Name	Typ	Description
id	string	ID prostředku ARM kontroly
name	string	Název revize

risk

Výčet

Potenciální riziko, že doporučení neimisíte.

Hodnota	Description
Error
None
Warning

scoreEntity

Objekt

Podrobnosti o skóre advisoru

Name	Typ	Description
categoryCount	number	Počet ovlivněných kategorií.
consumptionUnits	number	Jednotky spotřeby pro skóre.
date	string	Bylo vypočítáno skóre data.
impactedResourceCount	number	Počet ovlivněných prostředků.
potentialScoreIncrease	number	Potenciální procentuální nárůst celkového skóre na úrovni předplatného po implementaci všech doporučení v tomto oboru.
score	number	Procento skóre.

ShortDescription

Objekt

Shrnutí doporučení.

Name	Typ	Description
problem	string	Problém nebo příležitost identifikovaná doporučením a navrhovaným řešením
solution	string	Problém nebo příležitost identifikovaná doporučením a navrhovaným řešením

state

Výčet

Stav doporučení

Hodnota	Description
Approved
Completed
Dismissed
InProgress
Pending
Postponed
Rejected

systemData

Objekt

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

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

timeSeriesEntity

Objekt

Historická data na různých úrovních agregace.

Name	Typ	Description
aggregationLevel	aggregated	Úroveň agregace skóre.
scoreHistory	scoreEntity[]	Data o minulých skóre

TrackedRecommendationProperties

Objekt

Sledované vlastnosti doporučení

Name	Typ	Description
postponedTime	string (date-time)	Doba odložení doporučení do doby, než se doporučení odloží.
priority	priority	Priorita doporučení.
reason	reason	Důvod změny stavu doporučení.
state	state	Stav doporučení

TrackedRecommendationPropertiesPayload

Objekt

Name	Typ	Description
properties	Properties

Sdílet prostřednictvím

Recommendations - Patch

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

UpdateTrackedRecommendation

Ukázkový požadavek

Ukázková odpověď

Definice

aggregated

ArmErrorResponse

ARMErrorResponseBody

category

control

createdByType

impact

priority

Properties

reason

ResourceMetadata

ResourceRecommendationBase

ResourceWorkload

Review

risk

scoreEntity

ShortDescription

state

systemData

timeSeriesEntity

TrackedRecommendationProperties

TrackedRecommendationPropertiesPayload