Long Term Retention Policies - Create Or Update

Imposta i criteri di conservazione a lungo termine di un database.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/default?api-version=2021-08-01-preview

Parametri dell'URI

Name In Required Type Description
databaseName
path True
  • string

Nome del database.

policyName
path True

Nome del criterio. Deve essere sempre Default.

resourceGroupName
path True
  • string

Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.

serverName
path True
  • string

Nome del server.

subscriptionId
path True
  • string

ID sottoscrizione che identifica una sottoscrizione di Azure.

api-version
query True
  • string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Name Type Description
properties.monthlyRetention
  • string

Criteri di conservazione mensile per un backup con conservazione a lungo termine in formato ISO 8601.

properties.weekOfYear
  • integer

Settimana dell'anno in cui eseguire il backup annuale in formato ISO 8601.

properties.weeklyRetention
  • string

Criteri di conservazione settimanali per un backup con conservazione a lungo termine in formato ISO 8601.

properties.yearlyRetention
  • string

Criteri di conservazione annuale per un backup con conservazione a lungo termine in formato ISO 8601.

Risposte

Name Type Description
200 OK

Impostare correttamente il criterio.

202 Accepted

Accettato

Other Status Codes

Risposte di errore:

  • 400 InvalidResourceRequestBody: le proprietà della risorsa o della risorsa nel corpo della richiesta sono vuote o non valide.

  • 400 InvalidParameterValue - È stato assegnato un valore non valido a un parametro.

  • 400 LongTermRetentionMissingWeekOfYear - WeekOfYear deve essere impostato tra 1 e 52 per impostare la conservazione annuale.

  • 400 LongTermRetentionPolicyNotSupported: la conservazione a lungo termine non è supportata in questo database.

  • 400 LongTermRetentionPolicyInvalid : i criteri di conservazione a lungo termine non sono validi.

  • 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

  • 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.

  • 404 ResourceNotFound: la risorsa richiesta non è stata trovata.

Esempio

Create or update the long term retention policy for the database.

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2021-08-01-preview

{
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5
  }
}

Definizioni

LongTermRetentionPolicy

Criteri di conservazione a lungo termine.

LongTermRetentionPolicyName

Nome del criterio. Deve essere sempre Default.

LongTermRetentionPolicy

Criteri di conservazione a lungo termine.

Name Type Description
id
  • string

ID risorsa.

name
  • string

Nome risorsa.

properties.monthlyRetention
  • string

Criteri di conservazione mensile per un backup con conservazione a lungo termine in formato ISO 8601.

properties.weekOfYear
  • integer

Settimana dell'anno in cui eseguire il backup annuale in formato ISO 8601.

properties.weeklyRetention
  • string

Criteri di conservazione settimanali per un backup con conservazione a lungo termine in formato ISO 8601.

properties.yearlyRetention
  • string

Criteri di conservazione annuale per un backup con conservazione a lungo termine in formato ISO 8601.

type
  • string

Tipo di risorsa.

LongTermRetentionPolicyName

Nome del criterio. Deve essere sempre Default.

Name Type Description
default
  • string