Database Recommended Actions - Update

Reference

Služba:: SQL Database

Verze rozhraní API:: 2021-11-01

Aktualizuje doporučenou akci databáze.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}?api-version=2021-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
advisorName	path	True	string	Název databázového poradce.
databaseName	path	True	string	Název databáze.
recommendedActionName	path	True	string	Název doporučené akce databáze.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.state	True	RecommendedActionStateInfo	Získá informace o aktuálním stavu, ve které je doporučená akce.

Odpovědi

Name	Typ	Description
200 OK	RecommendedAction	Byla úspěšně aktualizována zadaná doporučená akce databáze.
Other Status Codes		Chybové odpovědi: *** 400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode. 400 InvalidRecommendedActionUpsertRequest – text požadavku na doporučenou aktualizaci neexistuje nebo neobsahuje žádné vlastnosti nebo objekt stavu. 400 InvalidRecommendedActionState – zadaný stav doporučené akce je neplatný. 404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond nebyl nalezen. 404 AdvisorNotFound – Požadovaný poradce nebyl nalezen. 404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena. 404 AdvisorNotFound – Požadovaný poradce nebyl nalezen. 404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena. 405 NotSupported – Tato funkce není podporována. 409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku. 503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná.

Name

Typ

Description

200 OK

RecommendedAction

Byla úspěšně aktualizována zadaná doporučená akce databáze.

Other Status Codes

Chybové odpovědi: ***

400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná.
400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode.
400 InvalidRecommendedActionUpsertRequest – text požadavku na doporučenou aktualizaci neexistuje nebo neobsahuje žádné vlastnosti nebo objekt stavu.
400 InvalidRecommendedActionState – zadaný stav doporučené akce je neplatný.
404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena.
404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen.
404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond nebyl nalezen.
404 AdvisorNotFound – Požadovaný poradce nebyl nalezen.
404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena.
404 AdvisorNotFound – Požadovaný poradce nebyl nalezen.
404 RecommendedActionNotFound – Požadovaná doporučená akce nebyla nalezena.
405 NotSupported – Tato funkce není podporována.
409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku.
503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná.

Příklady

Update database recommended action

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB?api-version=2021-11-01

{
  "properties": {
    "state": {
      "currentValue": "Pending"
    }
  }
}


import com.azure.resourcemanager.sql.fluent.models.RecommendedActionInner;
import com.azure.resourcemanager.sql.models.RecommendedActionCurrentState;
import com.azure.resourcemanager.sql.models.RecommendedActionStateInfo;

/**
 * Samples for DatabaseRecommendedActions Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseRecommendedActionUpdate.json
     */
    /**
     * Sample code: Update database recommended action.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateDatabaseRecommendedAction(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseRecommendedActions().updateWithResponse(
            "workloadinsight-demos", "misosisvr", "IndexAdvisor_test_3", "CreateIndex",
            "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
            new RecommendedActionInner()
                .withState(new RecommendedActionStateInfo().withCurrentValue(RecommendedActionCurrentState.PENDING)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "name": "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "type": "Microsoft.Sql/servers/databases/advisors/recommendedActions",
  "location": "East Asia",
  "kind": "",
  "properties": {
    "recommendationReason": "",
    "validSince": "2017-03-01T14:38:04Z",
    "lastRefresh": "2017-03-01T14:38:04Z",
    "state": {
      "currentValue": "Pending",
      "actionInitiatedBy": "User",
      "lastModified": "2017-06-20T15:11:15Z"
    },
    "isExecutableAction": true,
    "isRevertableAction": true,
    "isArchivedAction": false,
    "executeActionInitiatedBy": "User",
    "executeActionInitiatedTime": "2017-06-20T15:11:15Z",
    "score": 1,
    "implementationDetails": {
      "method": "TSql",
      "script": "CREATE NONCLUSTERED INDEX [nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B] ON [CRM].[DataPoints] ([Name],[Money],[Power]) INCLUDE ([Hour], [System], [LastChanged]) WITH (ONLINE = ON)"
    },
    "errorDetails": {},
    "estimatedImpact": [
      {
        "dimensionName": "ActionDuration",
        "unit": "Seconds",
        "absoluteValue": 1440
      },
      {
        "dimensionName": "SpaceChange",
        "unit": "Megabytes",
        "absoluteValue": 209.3125
      }
    ],
    "observedImpact": [],
    "timeSeries": [],
    "details": {
      "indexName": "nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B",
      "indexType": "NONCLUSTERED",
      "schema": "[CRM]",
      "table": "[DataPoints]",
      "indexColumns": "[Name],[Money],[Power]",
      "includedColumns": "[Hour], [System], [LastChanged]"
    }
  }
}

Definice

Name	Description
ImplementationMethod	Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.
IsRetryable	Získá, zda může být chyba ignorována a doporučená akce by se mohla opakovat. Možné hodnoty: Ano/Ne
RecommendedAction	Doporučená akce databáze, serveru nebo elastického fondu
RecommendedActionCurrentState	Aktuální stav, ve které je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválena a čeká na provedení. Provádění –> doporučená akce se používá v uživatelské databázi. Ověření –> doporučená akce byla použita a ověřuje její užitečnost systémem. Úspěch –> doporučená akce byla použita a během ověřování byla nalezena vylepšení. Čeká se na vrácení zpět –> ověření zjistilo málo nebo žádné vylepšení, takže doporučená akce se zařadí do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrátí. Vráceno –> úspěšně vrátil změny provedené doporučenou akcí u uživatelské databáze. Ignorováno –> uživatel explicitně ignoroval/zahodil doporučenou akci.
RecommendedActionErrorInfo	Obsahuje informace o chybě pro doporučenou akci azure SQL Database, serveru nebo elastického fondu.
RecommendedActionImpactRecord	Obsahuje informace o odhadovaném nebo pozorovaného dopadu na různé metriky doporučené akce azure SQL Database, serveru nebo elastického fondu.
RecommendedActionImplementationInfo	Obsahuje informace o ruční implementaci doporučené akce azure SQL Database, serveru nebo elastického fondu.
RecommendedActionInitiatedBy	Získá, kdo zahájil provádění této doporučené akce. Možná hodnota jsou: Uživatel –> Když má uživatel explicitně upozornit systém, aby použil doporučenou akci. Systém –> Když byl stav automatického spuštění tohoto poradce nastaven na Povoleno, v takovém případě ho systém použil.
RecommendedActionMetricInfo	Obsahuje časové řady různých ovlivněných metrik pro doporučenou akci Azure SQL Database, Serveru nebo elastického fondu.
RecommendedActionStateInfo	Obsahuje informace o aktuálním stavu doporučené akce azure SQL Database, serveru nebo elastického fondu.

ImplementationMethod

Výčet

Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.

Hodnota	Description
AzurePowerShell
TSql

IsRetryable

Výčet

Získá, zda může být chyba ignorována a doporučená akce by se mohla opakovat. Možné hodnoty: Ano/Ne

Hodnota	Description
No
Yes

RecommendedAction

Objekt

Doporučená akce databáze, serveru nebo elastického fondu

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
location	string	Umístění prostředku
name	string	Název prostředku
properties.details	object	Získá další podrobnosti specifické pro tuto doporučenou akci.
properties.errorDetails	RecommendedActionErrorInfo	Získá podrobnosti o chybě, pokud a proč je tato doporučená akce uvedena do chybového stavu.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Získá odhadované informace o dopadu pro tuto doporučenou akci, například odhadovaný zisk procesoru, odhadovaná změna místa na disku.
properties.executeActionDuration	string (duration)	Získá čas potřebný k použití této doporučené akce pro uživatelský prostředek. např. čas potřebný k vytvoření indexu
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Získá, pokud schválení pro použití této doporučené akce poskytl uživatel nebo systém.
properties.executeActionInitiatedTime	string (date-time)	Získá čas, kdy byla tato doporučená akce schválena ke spuštění.
properties.executeActionStartTime	string (date-time)	Získá čas, kdy systém začal používat tuto doporučenou akci pro uživatelský prostředek. např. čas zahájení vytváření indexu
properties.implementationDetails	RecommendedActionImplementationInfo	Získá podrobnosti implementace této doporučené akce, aby ji uživatel použil ručně.
properties.isArchivedAction	boolean	Získá, pokud byla tato doporučená akce navržena před nějakou dobou, ale uživatel se rozhodl tuto ignorovat a systém přidal novou doporučenou akci znovu.
properties.isExecutableAction	boolean	Získá, pokud je tato doporučená akce použitelná uživatelem.
properties.isRevertableAction	boolean	Získá, pokud změny použité touto doporučenou akcí může uživatel vrátit zpět.
properties.lastRefresh	string (date-time)	Získá čas, kdy byla tato doporučená akce naposledy aktualizována.
properties.linkedObjects	string[]	Získá propojené objekty, pokud nějaké.
properties.observedImpact	RecommendedActionImpactRecord[]	Získá pozorované nebo skutečné informace o dopadu pro tuto doporučenou akci, například skutečné získání procesoru, změnu skutečného místa na disku.
properties.recommendationReason	string	Získá důvod pro doporučování této akce. např. DuplicateIndex
properties.revertActionDuration	string (duration)	Získá čas potřebný k vrácení změn této doporučené akce u prostředku uživatele. Např. čas potřebný k vyřazení vytvořeného indexu.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Získá, pokud schválení pro vrácení této doporučené akce poskytl uživatel nebo systém.
properties.revertActionInitiatedTime	string (date-time)	Získá čas, kdy byla tato doporučená akce schválena k vrácení.
properties.revertActionStartTime	string (date-time)	Získá čas, kdy systém začal vracet změny této doporučené akce na uživatelském prostředku. Například čas, kdy se spustí pokles indexu.
properties.score	integer (int32)	Získá dopad této doporučené akce. Možné hodnoty jsou 1 – Nízký dopad, 2 – Střední dopad a 3 – Vysoký dopad
properties.state	RecommendedActionStateInfo	Získá informace o aktuálním stavu, ve které je doporučená akce.
properties.timeSeries	RecommendedActionMetricInfo[]	Získá informace o časových řadách metrik pro tuto doporučenou akci, například časová řada využití procesoru.
properties.validSince	string (date-time)	Získá čas od doby, kdy je tato doporučená akce platná.
type	string	Typ zdroje.

RecommendedActionCurrentState

Výčet

Aktuální stav, ve které je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválena a čeká na provedení. Provádění –> doporučená akce se používá v uživatelské databázi. Ověření –> doporučená akce byla použita a ověřuje její užitečnost systémem. Úspěch –> doporučená akce byla použita a během ověřování byla nalezena vylepšení. Čeká se na vrácení zpět –> ověření zjistilo málo nebo žádné vylepšení, takže doporučená akce se zařadí do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrátí. Vráceno –> úspěšně vrátil změny provedené doporučenou akcí u uživatelské databáze. Ignorováno –> uživatel explicitně ignoroval/zahodil doporučenou akci.

Hodnota	Description
Active
Error
Executing
Expired
Ignored
Monitoring
Pending
PendingRevert
Resolved
RevertCancelled
Reverted
Reverting
Success
Verifying

RecommendedActionErrorInfo

Objekt

Obsahuje informace o chybě pro doporučenou akci azure SQL Database, serveru nebo elastického fondu.

Name	Typ	Description
errorCode	string	Získá důvod, proč byla doporučená akce uvedena do chybového stavu. Například DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Získá, zda může být chyba ignorována a doporučená akce by se mohla opakovat. Možné hodnoty: Ano/Ne

RecommendedActionImpactRecord

Objekt

Obsahuje informace o odhadovaném nebo pozorovaného dopadu na různé metriky doporučené akce azure SQL Database, serveru nebo elastického fondu.

Name	Typ	Description
absoluteValue	number (double)	Získá absolutní hodnotu této dimenze, pokud je k dispozici. Například počet ovlivněných dotazů
changeValueAbsolute	number (double)	Získá absolutní změnu hodnoty této dimenze. Například absolutní změna místa na disku v megabajtech
changeValueRelative	number (double)	Získá relativní změnu hodnoty této dimenze. Například změna relativního místa na disku v procentech
dimensionName	string	Získá název dimenze dopadu. Např. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Získá název dimenze dopadu. Např. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Objekt

Obsahuje informace o ruční implementaci doporučené akce azure SQL Database, serveru nebo elastického fondu.

Name	Typ	Description
method	ImplementationMethod	Získá metodu, ve které lze tuto doporučenou akci ručně implementovat. např. TSql, AzurePowerShell.
script	string	Získá ruční implementační skript. Například skript T-SQL, který lze spustit v databázi.

RecommendedActionInitiatedBy

Výčet

Získá, kdo zahájil provádění této doporučené akce. Možná hodnota jsou: Uživatel –> Když má uživatel explicitně upozornit systém, aby použil doporučenou akci. Systém –> Když byl stav automatického spuštění tohoto poradce nastaven na Povoleno, v takovém případě ho systém použil.

Hodnota	Description
System
User

RecommendedActionMetricInfo

Objekt

Obsahuje časové řady různých ovlivněných metrik pro doporučenou akci Azure SQL Database, Serveru nebo elastického fondu.

Name	Typ	Description
metricName	string	Získá název metriky. například procesor, počet dotazů.
startTime	string (date-time)	Získá počáteční čas časového intervalu zadaného tímto MetricInfo.
timeGrain	string	Získá dobu trvání časového intervalu pro hodnotu danou touto MetricInfo. např. PT1H (1 hodina)
unit	string	Získá jednotku, ve které se metrika měří. např. DTU, frekvence
value	number (double)	Získá hodnotu metriky v časovém intervalu zadaném tímto MetricInfo.

RecommendedActionStateInfo

Objekt

Obsahuje informace o aktuálním stavu doporučené akce azure SQL Database, serveru nebo elastického fondu.

Name	Typ	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Získá, kdo zahájil provádění této doporučené akce. Možná hodnota jsou: Uživatel –> Když má uživatel explicitně upozornit systém, aby použil doporučenou akci. Systém –> Když byl stav automatického spuštění tohoto poradce nastaven na Povoleno, v takovém případě ho systém použil.
currentValue	RecommendedActionCurrentState	Aktuální stav, ve které je doporučená akce. Mezi běžně používané stavy patří: Aktivní –> doporučená akce je aktivní a zatím nebyla provedena žádná akce. Čeká na vyřízení –> doporučená akce je schválena a čeká na provedení. Provádění –> doporučená akce se používá v uživatelské databázi. Ověření –> doporučená akce byla použita a ověřuje její užitečnost systémem. Úspěch –> doporučená akce byla použita a během ověřování byla nalezena vylepšení. Čeká se na vrácení zpět –> ověření zjistilo málo nebo žádné vylepšení, takže doporučená akce se zařadí do fronty pro vrácení zpět nebo se uživatel vrátil ručně. Vrácení zpět –> změny provedené při použití doporučené akce se v uživatelské databázi vrátí. Vráceno –> úspěšně vrátil změny provedené doporučenou akcí u uživatelské databáze. Ignorováno –> uživatel explicitně ignoroval/zahodil doporučenou akci.
lastModified	string (date-time)	Získá čas poslední změny stavu.

Sdílet prostřednictvím

Database Recommended Actions - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Update database recommended action

Ukázkový požadavek

Ukázková odpověď

Definice

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Další materiály