Database Recommended Actions - Update

Referentie

Service:: SQL Database

API-versie:: 2021-11-01

Updates een database aanbevolen actie.

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

URI-parameters

Name	In	Vereist	Type	Description
advisorName	path	True	string	De naam van de Database Advisor.
databaseName	path	True	string	De naam van de database.
recommendedActionName	path	True	string	De naam van de aanbevolen actie voor de database.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
properties.state	True	RecommendedActionStateInfo	Hiermee haalt u de informatie op van de huidige status waarin de aanbevolen actie zich bevindt.

Antwoorden

Name	Type	Description
200 OK	RecommendedAction	De opgegeven aanbevolen actie voor de database is bijgewerkt.
Other Status Codes		Foutreacties: *** 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie. 400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken. 400 InvalidRecommendedActionUpsertRequest - De bijwerken aanbevolen actieaanvraagtekst bestaat niet of heeft geen eigenschappen of statusobject. 400 InvalidRecommendedActionState - De opgegeven status voor de aanbevolen actie is ongeldig 404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden 404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden. 404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden. 404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden. 404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden. 405 Niet ondersteund : deze functionaliteit wordt niet ondersteund. 409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag. 503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar.

Name

Type

Description

200 OK

RecommendedAction

De opgegeven aanbevolen actie voor de database is bijgewerkt.

Other Status Codes

Foutreacties: ***

400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie.
400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken.
400 InvalidRecommendedActionUpsertRequest - De bijwerken aanbevolen actieaanvraagtekst bestaat niet of heeft geen eigenschappen of statusobject.
400 InvalidRecommendedActionState - De opgegeven status voor de aanbevolen actie is ongeldig
404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden
404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden
404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden
404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden.
404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden.
404 AdvisorNotFound - De aangevraagde adviseur is niet gevonden.
404 RecommendedActionNotFound - De aangevraagde aanbevolen actie is niet gevonden.
405 Niet ondersteund : deze functionaliteit wordt niet ondersteund.
409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag.
503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar.

Voorbeelden

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

Voorbeeldrespons

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

Definities

Name	Description
ImplementationMethod	Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.
IsRetryable	Hiermee wordt aangegeven of de fout kan worden genegeerd en of de aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee
RecommendedAction	Aanbevolen actie voor database, server of elastische pool.
RecommendedActionCurrentState	De huidige status van de aanbevolen actie bevindt zich in. Enkele veelgebruikte statussen zijn: Actief -> aanbevolen actie is actief en er is nog geen actie ondernomen. In behandeling:> aanbevolen actie is goedgekeurd voor en wacht op uitvoering. Uitvoeren:> de aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> de aanbevolen actie is toegepast en wordt gecontroleerd op het nut ervan door het systeem. Geslaagd:> de aanbevolen actie is toegepast en er is een verbetering gevonden tijdens de verificatie. Herstellen in behandeling:> verificatie heeft weinig of geen verbetering gevonden, dus de aanbevolen actie wordt in de wachtrij geplaatst voor herstellen of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggedraaid op de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie op de gebruikersdatabase zijn teruggedraaid. Genegeerd:> de gebruiker heeft de aanbevolen actie expliciet genegeerd/genegeerd.
RecommendedActionErrorInfo	Bevat foutinformatie voor een Azure SQL database, server of elastische pool aanbevolen actie.
RecommendedActionImpactRecord	Bevat informatie over de geschatte of waargenomen impact op verschillende metrische gegevens voor een aanbevolen actie Azure SQL database, server of elastische pool.
RecommendedActionImplementationInfo	Bevat informatie voor handmatige implementatie voor een aanbevolen actie Azure SQL database, server of elastische pool.
RecommendedActionInitiatedBy	Hiermee haalt u op wie de uitvoering van deze aanbevolen actie is gestart. Mogelijke waarde zijn: Gebruiker> : wanneer de gebruiker het systeem expliciet heeft gewaarschuwd om de aanbevolen actie toe te passen. Systeem:> wanneer de status van deze advisor voor automatisch uitvoeren is ingesteld op 'Ingeschakeld', in welk geval het systeem deze heeft toegepast.
RecommendedActionMetricInfo	Bevat tijdreeksen van verschillende beïnvloede metrische gegevens voor een aanbevolen Azure SQL database, server of elastische pool.
RecommendedActionStateInfo	Bevat informatie over de huidige status voor een aanbevolen actie Azure SQL database, server of elastische pool.

ImplementationMethod

Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.

Name	Type	Description
AzurePowerShell	string
TSql	string

IsRetryable

Hiermee wordt aangegeven of de fout kan worden genegeerd en of de aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee

Name	Type	Description
No	string
Yes	string

RecommendedAction

Aanbevolen actie voor database, server of elastische pool.

Name	Type	Description
id	string	Resource-id.
kind	string	Resourcetype.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.details	object	Hiermee krijgt u aanvullende details die specifiek zijn voor deze aanbevolen actie.
properties.errorDetails	RecommendedActionErrorInfo	Hiermee worden de foutdetails opgevraagd of en waarom deze aanbevolen actie de foutstatus krijgt.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Hiermee haalt u de geschatte impactgegevens op voor deze aanbevolen actie, bijvoorbeeld Geschatte CPU-winst, geschatte wijziging van schijfruimte
properties.executeActionDuration	string	Hiermee wordt de tijd opgehaald die nodig is voor het toepassen van deze aanbevolen actie op de gebruikersresource. bijvoorbeeld de tijd die nodig is voor het maken van de index
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Hiermee wordt opgehaald of goedkeuring voor het toepassen van deze aanbevolen actie is gegeven door de gebruiker/het systeem.
properties.executeActionInitiatedTime	string	Hiermee wordt het tijdstip opgehaald waarop deze aanbevolen actie is goedgekeurd voor uitvoering.
properties.executeActionStartTime	string	Hiermee wordt de tijd opgevraagd waarop het systeem deze aanbevolen actie begon toe te passen op de gebruikersresource. bijvoorbeeld begintijd van het maken van indexen
properties.implementationDetails	RecommendedActionImplementationInfo	Hiermee haalt u de implementatiedetails van deze aanbevolen actie op, zodat de gebruiker deze handmatig kan toepassen.
properties.isArchivedAction	boolean	Hiermee wordt opgehaald of deze aanbevolen actie enige tijd geleden is voorgesteld, maar de gebruiker ervoor heeft gekozen dit te negeren en het systeem opnieuw een nieuwe aanbevolen actie heeft toegevoegd.
properties.isExecutableAction	boolean	Hiermee wordt opgevraagd of deze aanbevolen actie kan worden uitgevoerd door de gebruiker
properties.isRevertableAction	boolean	Hiermee wordt opgehaald of wijzigingen die door deze aanbevolen actie worden toegepast, door de gebruiker kunnen worden teruggedraaid
properties.lastRefresh	string	Hiermee wordt de tijd opgehaald waarop deze aanbevolen actie voor het laatst is vernieuwd.
properties.linkedObjects	string[]	Hiermee haalt u de gekoppelde objecten op, indien aanwezig.
properties.observedImpact	RecommendedActionImpactRecord[]	Haalt de waargenomen/werkelijke impactgegevens op voor deze aanbevolen actie, bijvoorbeeld werkelijke CPU-winst, werkelijke schijfruimtewijziging
properties.recommendationReason	string	Hiermee haalt u de reden op voor het aanbevelen van deze actie. bijvoorbeeld DuplicateIndex
properties.revertActionDuration	string	Hiermee haalt u de tijd op die nodig is voor het terugdraaien van wijzigingen van deze aanbevolen actie op gebruikersresource. bijvoorbeeld de tijd die nodig is voor het verwijderen van de gemaakte index.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Hiermee wordt opgehaald of goedkeuring voor het terugdraaien van deze aanbevolen actie is gegeven door de gebruiker/het systeem.
properties.revertActionInitiatedTime	string	Hiermee wordt het tijdstip opgehaald waarop deze aanbevolen actie is goedgekeurd om terug te keren.
properties.revertActionStartTime	string	Hiermee wordt de tijd opgevraagd waarop het systeem is begonnen met het terugdraaien van wijzigingen van deze aanbevolen actie voor gebruikersresources. bijvoorbeeld het tijdstip waarop indexvervalbewerking wordt uitgevoerd.
properties.score	integer	Hiermee haalt u de impact van deze aanbevolen actie op. Mogelijke waarden zijn 1 - Lage impact, 2 - Gemiddelde impact en 3 - Hoge impact
properties.state	RecommendedActionStateInfo	Hiermee haalt u de informatie op van de huidige status waarin de aanbevolen actie zich bevindt.
properties.timeSeries	RecommendedActionMetricInfo[]	Hiermee haalt u de tijdreeksgegevens op van metrische gegevens voor deze aanbevolen actie, bijvoorbeeld een tijdreeks voor CPU-verbruik
properties.validSince	string	Hiermee haalt u de tijd op sinds wanneer deze aanbevolen actie geldig is.
type	string	Resourcetype.

RecommendedActionCurrentState

De huidige status van de aanbevolen actie bevindt zich in. Enkele veelgebruikte statussen zijn: Actief -> aanbevolen actie is actief en er is nog geen actie ondernomen. In behandeling:> aanbevolen actie is goedgekeurd voor en wacht op uitvoering. Uitvoeren:> de aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> de aanbevolen actie is toegepast en wordt gecontroleerd op het nut ervan door het systeem. Geslaagd:> de aanbevolen actie is toegepast en er is een verbetering gevonden tijdens de verificatie. Herstellen in behandeling:> verificatie heeft weinig of geen verbetering gevonden, dus de aanbevolen actie wordt in de wachtrij geplaatst voor herstellen of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggedraaid op de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie op de gebruikersdatabase zijn teruggedraaid. Genegeerd:> de gebruiker heeft de aanbevolen actie expliciet genegeerd/genegeerd.

Name	Type	Description
Active	string
Error	string
Executing	string
Expired	string
Ignored	string
Monitoring	string
Pending	string
PendingRevert	string
Resolved	string
RevertCancelled	string
Reverted	string
Reverting	string
Success	string
Verifying	string

RecommendedActionErrorInfo

Bevat foutinformatie voor een Azure SQL database, server of elastische pool aanbevolen actie.

Name	Type	Description
errorCode	string	Hiermee wordt de reden opgehaald waarom de aanbevolen actie de foutstatus heeft bereikt. bijvoorbeeld DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Hiermee wordt aangegeven of de fout kan worden genegeerd en of de aanbevolen actie opnieuw kan worden geprobeerd. Mogelijke waarden zijn: Ja/Nee

RecommendedActionImpactRecord

Bevat informatie over de geschatte of waargenomen impact op verschillende metrische gegevens voor een aanbevolen actie Azure SQL database, server of elastische pool.

Name	Type	Description
absoluteValue	number	Haalt de absolute waarde van deze dimensie op, indien van toepassing. Bijvoorbeeld het aantal betrokken query's
changeValueAbsolute	number	Hiermee haalt u de absolute wijziging in de waarde van deze dimensie op. bijvoorbeeld absolute schijfruimtewijziging in megabytes
changeValueRelative	number	Hiermee haalt u de relatieve wijziging in de waarde van deze dimensie op. Bijvoorbeeld wijziging van relatieve schijfruimte in percentage
dimensionName	string	Hiermee haalt u de naam van de impactdimensie op. bijvoorbeeld CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Hiermee haalt u de naam van de impactdimensie op. bijvoorbeeld CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Bevat informatie voor handmatige implementatie voor een aanbevolen actie Azure SQL database, server of elastische pool.

Name	Type	Description
method	ImplementationMethod	Hiermee haalt u de methode op waarin deze aanbevolen actie handmatig kan worden geïmplementeerd. bijvoorbeeld TSql, AzurePowerShell.
script	string	Hiermee haalt u het handmatige implementatiescript op. bijvoorbeeld T-SQL-script dat kan worden uitgevoerd op de database.

RecommendedActionInitiatedBy

Hiermee haalt u op wie de uitvoering van deze aanbevolen actie is gestart. Mogelijke waarde zijn: Gebruiker> : wanneer de gebruiker het systeem expliciet heeft gewaarschuwd om de aanbevolen actie toe te passen. Systeem:> wanneer de status van deze advisor voor automatisch uitvoeren is ingesteld op 'Ingeschakeld', in welk geval het systeem deze heeft toegepast.

Name	Type	Description
System	string
User	string

RecommendedActionMetricInfo

Bevat tijdreeksen van verschillende beïnvloede metrische gegevens voor een aanbevolen Azure SQL database, server of elastische pool.

Name	Type	Description
metricName	string	Hiermee haalt u de naam van het metrische gegeven op. bijvoorbeeld CPU, Aantal query's.
startTime	string	Hiermee haalt u de begintijd van het tijdsinterval op die door deze MetricInfo is opgegeven.
timeGrain	string	Hiermee wordt de duur van het tijdsinterval opgehaald voor de waarde die door deze MetricInfo is opgegeven. bijvoorbeeld PT1H (1 uur)
unit	string	Hiermee haalt u de eenheid op waarin metrische gegevens worden gemeten. bijvoorbeeld DTU, Frequentie
value	number	Hiermee haalt u de waarde van de metrische waarde op in het tijdsinterval dat door deze MetricInfo is opgegeven.

RecommendedActionStateInfo

Bevat informatie over de huidige status voor een aanbevolen actie Azure SQL database, server of elastische pool.

Name	Type	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Hiermee haalt u op wie de uitvoering van deze aanbevolen actie is gestart. Mogelijke waarde zijn: Gebruiker> : wanneer de gebruiker het systeem expliciet heeft gewaarschuwd om de aanbevolen actie toe te passen. Systeem:> wanneer de status van deze advisor voor automatisch uitvoeren is ingesteld op 'Ingeschakeld', in welk geval het systeem deze heeft toegepast.
currentValue	RecommendedActionCurrentState	De huidige status van de aanbevolen actie bevindt zich in. Enkele veelgebruikte statussen zijn: Actief -> aanbevolen actie is actief en er is nog geen actie ondernomen. In behandeling:> aanbevolen actie is goedgekeurd voor en wacht op uitvoering. Uitvoeren:> de aanbevolen actie wordt toegepast op de gebruikersdatabase. Controleren:> de aanbevolen actie is toegepast en wordt gecontroleerd op het nut ervan door het systeem. Geslaagd:> de aanbevolen actie is toegepast en er is een verbetering gevonden tijdens de verificatie. Herstellen in behandeling:> verificatie heeft weinig of geen verbetering gevonden, dus de aanbevolen actie wordt in de wachtrij geplaatst voor herstellen of de gebruiker heeft handmatig teruggezet. Terugdraaien:> wijzigingen die zijn aangebracht tijdens het toepassen van de aanbevolen actie, worden teruggedraaid op de gebruikersdatabase. Teruggedraaid:> de wijzigingen die zijn aangebracht door de aanbevolen actie op de gebruikersdatabase zijn teruggedraaid. Genegeerd:> de gebruiker heeft de aanbevolen actie expliciet genegeerd/genegeerd.
lastModified	string	Hiermee wordt het tijdstip opgehaald waarop de status voor het laatst is gewijzigd

Delen via

Database Recommended Actions - Update

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

Update database recommended action

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Aanvullende resources