Database Recommended Actions - Update

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Novedades una acción recomendada de base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
advisorName	path	True	string	Nombre del Asesor de bases de datos.
databaseName	path	True	string	El nombre de la base de datos.
recommendedActionName	path	True	string	Nombre de la acción recomendada de base de datos.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.state	True	RecommendedActionStateInfo	Obtiene la información del estado actual en el que se encuentra la acción recomendada.

Respuestas

Nombre	Tipo	Description
200 OK	RecommendedAction	Se actualizó correctamente la acción recomendada de la base de datos especificada.
Other Status Codes		Respuestas de error: *** 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 400 InvalidRecommendedActionUpsertRequest: el cuerpo de la solicitud de acción recomendada de actualización no existe o no tiene propiedades ni objeto de estado. 400 InvalidRecommendedActionState: el estado especificado para la acción recomendada no es válido. 404 DatabaseDoesNotExist: no se encontró la base de datos solicitada. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 SubscriptionDoesNotHaveElasticPool: no se encontró el grupo elástico solicitado. 404 AdvisorNotFound: no se encontró el asesor solicitado. 404 RecommendedActionNotFound: no se encontró la acción recomendada solicitada. 404 AdvisorNotFound: no se encontró el asesor solicitado. 404 RecommendedActionNotFound: no se encontró la acción recomendada solicitada. 405 NotSupported: esta funcionalidad no se admite. 409 Conflicto: no se pudo procesar la solicitud debido a un conflicto en la solicitud. 503 ServiceTemporarilyUnavailable: característica no disponible temporalmente.

Nombre

Tipo

Description

200 OK

RecommendedAction

Se actualizó correctamente la acción recomendada de la base de datos especificada.

Other Status Codes

Respuestas de error: ***

400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos.
400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido.
400 InvalidRecommendedActionUpsertRequest: el cuerpo de la solicitud de acción recomendada de actualización no existe o no tiene propiedades ni objeto de estado.
400 InvalidRecommendedActionState: el estado especificado para la acción recomendada no es válido.
404 DatabaseDoesNotExist: no se encontró la base de datos solicitada.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 SubscriptionDoesNotHaveElasticPool: no se encontró el grupo elástico solicitado.
404 AdvisorNotFound: no se encontró el asesor solicitado.
404 RecommendedActionNotFound: no se encontró la acción recomendada solicitada.
404 AdvisorNotFound: no se encontró el asesor solicitado.
404 RecommendedActionNotFound: no se encontró la acción recomendada solicitada.
405 NotSupported: esta funcionalidad no se admite.
409 Conflicto: no se pudo procesar la solicitud debido a un conflicto en la solicitud.
503 ServiceTemporarilyUnavailable: característica no disponible temporalmente.

Ejemplos

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ImplementationMethod	Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.
IsRetryable	Obtiene si se podría omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No
RecommendedAction	Acción recomendada de base de datos, servidor o grupo elástico.
RecommendedActionCurrentState	Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo> : la acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> se aprueba la acción recomendada para y está esperando la ejecución. Ejecución:> se aplica una acción recomendada en la base de datos de usuario. Comprobación:> se aplicó la acción recomendada y se comprueba su utilidad por parte del sistema. Correcto:> se aplicó la acción recomendada y se encontró una mejora durante la comprobación. Reversión pendiente:> la comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> se revierten los cambios realizados mientras se aplica la acción recomendada en la base de datos de usuario. Reverted:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitir:> el usuario omite o descarta explícitamente la acción recomendada.
RecommendedActionErrorInfo	Contiene información de error para una acción recomendada de Azure SQL base de datos, servidor o grupo elástico.
RecommendedActionImpactRecord	Contiene información de impacto estimado o observado en varias métricas para una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.
RecommendedActionImplementationInfo	Contiene información sobre la implementación manual de una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.
RecommendedActionInitiatedBy	Obtiene quién inició la ejecución de esta acción recomendada. El valor posible es: Usuario> : cuando el sistema notificado explícitamente por el usuario aplica la acción recomendada. Sistema:> cuando el estado de ejecución automática de este asesor se estableció en "Habilitado", en cuyo caso el sistema lo aplicó.
RecommendedActionMetricInfo	Contiene una serie temporal de varias métricas afectadas para una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.
RecommendedActionStateInfo	Contiene información sobre el estado actual de una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.

ImplementationMethod

Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.

Nombre	Tipo	Description
AzurePowerShell	string
TSql	string

IsRetryable

Obtiene si se podría omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No

Nombre	Tipo	Description
No	string
Yes	string

RecommendedAction

Acción recomendada de base de datos, servidor o grupo elástico.

Nombre	Tipo	Description
id	string	Identificador del recurso.
kind	string	Tipo de recurso.
location	string	Ubicación del recurso
name	string	Nombre del recurso.
properties.details	object	Obtiene detalles adicionales específicos de esta acción recomendada.
properties.errorDetails	RecommendedActionErrorInfo	Obtiene los detalles del error si y por qué esta acción recomendada se coloca en estado de error.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Obtiene la información de impacto estimada para esta acción recomendada, por ejemplo, Ganancia estimada de CPU, Cambio estimado del espacio en disco.
properties.executeActionDuration	string	Obtiene el tiempo necesario para aplicar esta acción recomendada en el recurso de usuario. Por ejemplo, tiempo necesario para la creación de índices
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Obtiene si el usuario o el sistema proporcionan la aprobación para aplicar esta acción recomendada.
properties.executeActionInitiatedTime	string	Obtiene la hora en que se aprobó esta acción recomendada para su ejecución.
properties.executeActionStartTime	string	Obtiene la hora en que el sistema empezó a aplicar esta acción recomendada en el recurso de usuario. Por ejemplo, hora de inicio de creación de índices
properties.implementationDetails	RecommendedActionImplementationInfo	Obtiene los detalles de implementación de esta acción recomendada para que el usuario la aplique manualmente.
properties.isArchivedAction	boolean	Obtiene si esta acción recomendada se sugirió hace algún tiempo, pero el usuario eligió omitir esta acción y el sistema agregó una nueva acción recomendada de nuevo.
properties.isExecutableAction	boolean	Obtiene si el usuario puede realizar esta acción recomendada.
properties.isRevertableAction	boolean	Obtiene si el usuario puede revertir los cambios aplicados por esta acción recomendada.
properties.lastRefresh	string	Obtiene la hora en que esta acción recomendada se actualizó por última vez.
properties.linkedObjects	string[]	Obtiene los objetos vinculados, si los hay.
properties.observedImpact	RecommendedActionImpactRecord[]	Obtiene la información de impacto real o observada para esta acción recomendada, por ejemplo, ganancia de CPU real, cambio de espacio en disco real.
properties.recommendationReason	string	Obtiene el motivo de recomendar esta acción. Por ejemplo, DuplicateIndex
properties.revertActionDuration	string	Obtiene el tiempo necesario para revertir los cambios de esta acción recomendada en el recurso de usuario. Por ejemplo, tiempo necesario para quitar el índice creado.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Obtiene si el usuario o el sistema proporcionan la aprobación para revertir esta acción recomendada.
properties.revertActionInitiatedTime	string	Obtiene la hora en que se aprobó esta acción recomendada para revertir.
properties.revertActionStartTime	string	Obtiene la hora en que el sistema comenzó a revertir los cambios de esta acción recomendada en el recurso de usuario. Por ejemplo, la hora en que se ejecuta la colocación del índice.
properties.score	integer	Obtiene el impacto de esta acción recomendada. Los valores posibles son 1 - Bajo impacto, 2 - Impacto medio y 3 - Alto impacto
properties.state	RecommendedActionStateInfo	Obtiene la información del estado actual en el que se encuentra la acción recomendada.
properties.timeSeries	RecommendedActionMetricInfo[]	Obtiene la información de serie temporal de las métricas de esta acción recomendada, por ejemplo, serie temporal de consumo de CPU.
properties.validSince	string	Obtiene la hora desde que esta acción recomendada es válida.
type	string	Tipo de recurso.

RecommendedActionCurrentState

Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo> : la acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> se aprueba la acción recomendada para y está esperando la ejecución. Ejecución:> se aplica una acción recomendada en la base de datos de usuario. Comprobación:> se aplicó la acción recomendada y se comprueba su utilidad por parte del sistema. Correcto:> se aplicó la acción recomendada y se encontró una mejora durante la comprobación. Reversión pendiente:> la comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> se revierten los cambios realizados mientras se aplica la acción recomendada en la base de datos de usuario. Reverted:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitir:> el usuario omite o descarta explícitamente la acción recomendada.

Nombre	Tipo	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

Contiene información de error para una acción recomendada de Azure SQL base de datos, servidor o grupo elástico.

Nombre	Tipo	Description
errorCode	string	Obtiene el motivo por el que la acción recomendada se puso en estado de error. Por ejemplo, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Obtiene si se podría omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No

RecommendedActionImpactRecord

Contiene información de impacto estimado o observado en varias métricas para una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.

Nombre	Tipo	Description
absoluteValue	number	Obtiene el valor absoluto de esta dimensión si procede. Por ejemplo, número de consultas afectadas
changeValueAbsolute	number	Obtiene el cambio absoluto en el valor de esta dimensión. Por ejemplo, cambio de espacio absoluto en disco en Megabytes
changeValueRelative	number	Obtiene el cambio relativo en el valor de esta dimensión. Por ejemplo, cambio de espacio en disco relativo en porcentaje
dimensionName	string	Obtiene el nombre de la dimensión de impacto. Por ejemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Obtiene el nombre de la dimensión de impacto. Por ejemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Contiene información sobre la implementación manual de una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.

Nombre	Tipo	Description
method	ImplementationMethod	Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.
script	string	Obtiene el script de implementación manual. Por ejemplo, script de T-SQL que se puede ejecutar en la base de datos.

RecommendedActionInitiatedBy

Obtiene quién inició la ejecución de esta acción recomendada. El valor posible es: Usuario> : cuando el sistema notificado explícitamente por el usuario aplica la acción recomendada. Sistema:> cuando el estado de ejecución automática de este asesor se estableció en "Habilitado", en cuyo caso el sistema lo aplicó.

Nombre	Tipo	Description
System	string
User	string

RecommendedActionMetricInfo

Contiene una serie temporal de varias métricas afectadas para una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.

Nombre	Tipo	Description
metricName	string	Obtiene el nombre de la métrica. Por ejemplo, CPU, número de consultas.
startTime	string	Obtiene la hora de inicio del intervalo de tiempo proporcionado por este MetricInfo.
timeGrain	string	Obtiene la duración del intervalo de tiempo para el valor proporcionado por este MetricInfo. Por ejemplo, PT1H (1 hora)
unit	string	Obtiene la unidad en la que se mide la métrica. Por ejemplo, DTU, Frecuencia
value	number	Obtiene el valor de la métrica en el intervalo de tiempo proporcionado por este MetricInfo.

RecommendedActionStateInfo

Contiene información sobre el estado actual de una base de datos de Azure SQL, servidor o acción recomendada del grupo elástico.

Nombre	Tipo	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Obtiene quién inició la ejecución de esta acción recomendada. El valor posible es: Usuario> : cuando el sistema notificado explícitamente por el usuario aplica la acción recomendada. Sistema:> cuando el estado de ejecución automática de este asesor se estableció en "Habilitado", en cuyo caso el sistema lo aplicó.
currentValue	RecommendedActionCurrentState	Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo> : la acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> se aprueba la acción recomendada para y está esperando la ejecución. Ejecución:> se aplica una acción recomendada en la base de datos de usuario. Comprobación:> se aplicó la acción recomendada y se comprueba su utilidad por parte del sistema. Correcto:> se aplicó la acción recomendada y se encontró una mejora durante la comprobación. Reversión pendiente:> la comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> se revierten los cambios realizados mientras se aplica la acción recomendada en la base de datos de usuario. Reverted:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitir:> el usuario omite o descarta explícitamente la acción recomendada.
lastModified	string	Obtiene la hora en que se modificó por última vez el estado.

Compartir a través de

Database Recommended Actions - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Update database recommended action

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

Recursos adicionales