Backup Policies - Create Or Update

Cria ou Atualizações uma política de cópia de segurança pertencente a um cofre de cópias de segurança

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}?api-version=2023-01-01

Parâmetros do URI

Name Em Necessário Tipo Description
backupPolicyName
path True

string

Nome da política

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

subscriptionId
path True

string

uuid

O ID da subscrição de destino. O valor tem de ser um UUID.

vaultName
path True

string

O nome do cofre de cópias de segurança.

api-version
query True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Tipo Description
properties BaseBackupPolicy:

BackupPolicy

BaseBackupPolicy
Propriedades baseBackupPolicyResource

Respostas

Name Tipo Description
200 OK

BaseBackupPolicyResource

OK

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar a sua conta de utilizador.

Exemplos

CreateOrUpdate BackupPolicy

Sample Request

PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy?api-version=2023-01-01

{
  "properties": {
    "policyRules": [
      {
        "backupParameters": {
          "backupType": "Full",
          "objectType": "AzureBackupParams"
        },
        "trigger": {
          "schedule": {
            "repeatingTimeIntervals": [
              "R/2019-11-20T08:00:00-08:00/P1W"
            ]
          },
          "taggingCriteria": [
            {
              "tagInfo": {
                "tagName": "Default"
              },
              "taggingPriority": 99,
              "isDefault": true
            },
            {
              "tagInfo": {
                "tagName": "Weekly"
              },
              "taggingPriority": 20,
              "isDefault": false,
              "criteria": [
                {
                  "scheduleTimes": [
                    "2019-03-01T13:00:00Z"
                  ],
                  "daysOfTheWeek": [
                    "Sunday"
                  ],
                  "objectType": "ScheduleBasedBackupCriteria"
                }
              ]
            }
          ],
          "objectType": "ScheduleBasedTriggerContext"
        },
        "dataStore": {
          "dataStoreType": "VaultStore",
          "objectType": "DataStoreInfoBase"
        },
        "name": "BackupWeekly",
        "objectType": "AzureBackupRule"
      },
      {
        "lifecycles": [
          {
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            },
            "deleteAfter": {
              "objectType": "AbsoluteDeleteOption",
              "duration": "P1W"
            }
          }
        ],
        "isDefault": true,
        "name": "Default",
        "objectType": "AzureRetentionRule"
      },
      {
        "lifecycles": [
          {
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            },
            "deleteAfter": {
              "objectType": "AbsoluteDeleteOption",
              "duration": "P12W"
            }
          }
        ],
        "isDefault": false,
        "name": "Weekly",
        "objectType": "AzureRetentionRule"
      }
    ],
    "datasourceTypes": [
      "OssDB"
    ],
    "objectType": "BackupPolicy"
  }
}

Sample Response

{
  "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
  "name": "OSSDBPolicy",
  "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
  "properties": {
    "policyRules": [
      {
        "backupParameters": {
          "backupType": "Full",
          "objectType": "AzureBackupParams"
        },
        "trigger": {
          "schedule": {
            "repeatingTimeIntervals": [
              "R/2019-11-20T08:00:00-08:00/P1W"
            ]
          },
          "taggingCriteria": [
            {
              "tagInfo": {
                "tagName": "Default",
                "id": "Default_"
              },
              "taggingPriority": 99,
              "isDefault": true
            },
            {
              "tagInfo": {
                "tagName": "Weekly",
                "id": "Weekly_"
              },
              "taggingPriority": 20,
              "isDefault": false,
              "criteria": [
                {
                  "scheduleTimes": [
                    "2019-03-01T13:00:00Z"
                  ],
                  "daysOfTheWeek": [
                    "Sunday"
                  ],
                  "objectType": "ScheduleBasedBackupCriteria"
                }
              ]
            }
          ],
          "objectType": "ScheduleBasedTriggerContext"
        },
        "dataStore": {
          "dataStoreType": "VaultStore",
          "objectType": "DataStoreInfoBase"
        },
        "name": "BackupWeekly",
        "objectType": "AzureBackupRule"
      },
      {
        "lifecycles": [
          {
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            },
            "deleteAfter": {
              "objectType": "AbsoluteDeleteOption",
              "duration": "P1W"
            }
          }
        ],
        "isDefault": true,
        "name": "Default",
        "objectType": "AzureRetentionRule"
      },
      {
        "lifecycles": [
          {
            "sourceDataStore": {
              "dataStoreType": "VaultStore",
              "objectType": "DataStoreInfoBase"
            },
            "deleteAfter": {
              "objectType": "AbsoluteDeleteOption",
              "duration": "P12W"
            }
          }
        ],
        "isDefault": false,
        "name": "Weekly",
        "objectType": "AzureRetentionRule"
      }
    ],
    "datasourceTypes": [
      "OssDB"
    ],
    "objectType": "BackupPolicy"
  }
}

Definições

Name Description
AbsoluteDeleteOption

AbsoluteDeleteOption

AbsoluteMarker

contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enum absoluteMarker

AdhocBasedTaggingCriteria

AdhocBasedTaggingCriteria

AdhocBasedTriggerContext

AdhocBasedTriggerContext

AzureBackupParams

AzureBackupParams

AzureBackupRule

AzureBackupRule

AzureRetentionRule

AzureRetentionRule

BackupPolicy

BackupPolicy

BackupSchedule

BackupSchedule

BaseBackupPolicyResource

BaseBackupPolicyResource

CloudError

CloudError

CopyOnExpiryOption

CopyOnExpiryOption

createdByType

O tipo de identidade que criou o recurso.

CustomCopyOption

CustomCopyOption

DataStoreInfoBase

DataStoreInfoBase

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

Day

Dia

DayOfWeek

Deve ser domingo/segunda/t..../sábado

Error

A resposta ao erro de gestão de recursos.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ImmediateCopyOption

ImmediateCopyOption

Month

Deve ser janeiro/fevereiro/....../dezembro

RetentionTag

RetentionTag

ScheduleBasedBackupCriteria

ScheduleBasedBackupCriteria

ScheduleBasedTriggerContext

ScheduleBasedTriggerContext

SourceLifeCycle

Ciclo de Vida Fonte

systemData

Metadados relativos à criação e última modificação do recurso.

TaggingCriteria

TaggingCriteria

TargetCopySetting

TargetCopySetting

WeekNumber

Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

AbsoluteDeleteOption

AbsoluteDeleteOption

Name Tipo Description
duration

string

Duração da eliminação após determinado período de tempo

objectType string:

AbsoluteDeleteOption

Tipo do objeto específico - utilizado para anular a serialização

AbsoluteMarker

contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enum absoluteMarker

Name Tipo Description
AllBackup

string

FirstOfDay

string

FirstOfMonth

string

FirstOfWeek

string

FirstOfYear

string

AdhocBasedTaggingCriteria

AdhocBasedTaggingCriteria

Name Tipo Description
tagInfo

RetentionTag

RetentionTag
Informações da etiqueta de retenção

AdhocBasedTriggerContext

AdhocBasedTriggerContext

Name Tipo Description
objectType string:

AdhocBasedTriggerContext

Tipo do objeto específico - utilizado para anular a serialização

taggingCriteria

AdhocBasedTaggingCriteria

AdhocBasedTaggingCriteria
Critérios de Identificação que contêm etiqueta de retenção para cópia de segurança adhoc.

AzureBackupParams

AzureBackupParams

Name Tipo Description
backupType

string

BackupType ; Completo/Incremental, etc.

objectType string:

AzureBackupParams

Tipo do objeto específico - utilizado para anular a serialização

AzureBackupRule

AzureBackupRule

Name Tipo Description
backupParameters BackupParameters:

AzureBackupParams

BackupParameters
Base de BackupParameters

dataStore

DataStoreInfoBase

DataStoreInfoBase
Base dataStoreInfo

name

string

objectType string:

AzureBackupRule

trigger TriggerContext:

TriggerContext
Contexto do acionador

AzureRetentionRule

AzureRetentionRule

Name Tipo Description
isDefault

boolean

lifecycles

SourceLifeCycle[]

Ciclo de Vida Fonte
Ciclo de Vida de Origem

name

string

objectType string:

AzureRetentionRule

BackupPolicy

BackupPolicy

Name Tipo Description
datasourceTypes

string[]

Tipo de origem de dados para a gestão de cópias de segurança

objectType string:

BackupPolicy

policyRules BasePolicyRule[]:

Dicionário de regras de política que contém regras para cada tipo de cópia de segurança, ou seja, Completo/Incremental/Registos, etc.

BackupSchedule

BackupSchedule

Name Tipo Description
repeatingTimeIntervals

string[]

Formato de intervalo de tempo de repetição ISO 8601

timeZone

string

Fuso horário para uma agenda. Exemplo: Hora Padrão do Pacífico

BaseBackupPolicyResource

BaseBackupPolicyResource

Name Tipo Description
id

string

O ID do Recurso representa o caminho completo para o recurso.

name

string

Nome do recurso associado ao recurso.

properties BaseBackupPolicy:

BackupPolicy

BaseBackupPolicy
Propriedades baseBackupPolicyResource

systemData

systemData

Metadados relativos à criação e última modificação do recurso.

type

string

O tipo de recurso representa o caminho completo do formulário Espaço de Nomes/ResourceType/ResourceType/...

CloudError

CloudError

Name Tipo Description
error

Error

A resposta ao erro de gestão de recursos.

CopyOnExpiryOption

CopyOnExpiryOption

Name Tipo Description
objectType string:

CopyOnExpiryOption

Tipo do objeto específico - utilizado para anular a serialização

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomCopyOption

CustomCopyOption

Name Tipo Description
duration

string

Dados copiados após um período de tempo especificado

objectType string:

CustomCopyOption

Tipo do objeto específico - utilizado para anular a serialização

DataStoreInfoBase

DataStoreInfoBase

Name Tipo Description
dataStoreType

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

objectType

string

Tipo de objeto Datasource, utilizado para inicializar o tipo herdado certo

DataStoreTypes

tipo de arquivo de dados; Operacional/Cofre/Arquivo

Name Tipo Description
ArchiveStore

string

OperationalStore

string

VaultStore

string

Day

Dia

Name Tipo Description
date

integer

Data do mês

isLast

boolean

Se Data é a última data do mês

DayOfWeek

Deve ser domingo/segunda/t..../sábado

Name Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Error

A resposta ao erro de gestão de recursos.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

Error[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ImmediateCopyOption

ImmediateCopyOption

Name Tipo Description
objectType string:

ImmediateCopyOption

Tipo do objeto específico - utilizado para anular a serialização

Month

Deve ser janeiro/fevereiro/....../dezembro

Name Tipo Description
April

string

August

string

December

string

February

string

January

string

July

string

June

string

March

string

May

string

November

string

October

string

September

string

RetentionTag

RetentionTag

Name Tipo Description
eTag

string

Versão da Etiqueta de Retenção.

id

string

Versão da Etiqueta de Retenção.

tagName

string

Nome da Etiqueta de Retenção para o relacionar com a regra de retenção.

ScheduleBasedBackupCriteria

ScheduleBasedBackupCriteria

Name Tipo Description
absoluteCriteria

AbsoluteMarker[]

contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enum absoluteMarker

daysOfMonth

Day[]

Este é o dia do mês de 1 a 28 outro sábio último mês

daysOfTheWeek

DayOfWeek[]

Deve ser domingo/segunda/t..../sábado

monthsOfYear

Month[]

Deve ser janeiro/fevereiro/....../dezembro

objectType string:

ScheduleBasedBackupCriteria

Tipo do objeto específico - utilizado para anular a serialização

scheduleTimes

string[]

Lista de horários da cópia de segurança

weeksOfTheMonth

WeekNumber[]

Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

ScheduleBasedTriggerContext

ScheduleBasedTriggerContext

Name Tipo Description
objectType string:

ScheduleBasedTriggerContext

Tipo do objeto específico - utilizado para anular a serialização

schedule

BackupSchedule

BackupSchedule
Agendar para esta cópia de segurança

taggingCriteria

TaggingCriteria[]

Lista de etiquetas que podem ser aplicáveis para uma determinada agenda.

SourceLifeCycle

Ciclo de Vida Fonte

Name Tipo Description
deleteAfter DeleteOption:

AbsoluteDeleteOption

DeleteOption
Opção Eliminar

sourceDataStore

DataStoreInfoBase

DataStoreInfoBase
Base dataStoreInfo

targetDataStoreCopySettings

TargetCopySetting[]

TargetCopySetting
Definições de cópia de destino

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TaggingCriteria

TaggingCriteria

Name Tipo Description
criteria BackupCriteria[]:

ScheduleBasedBackupCriteria[]

Critérios que decidem se a etiqueta pode ser aplicada a uma cópia de segurança acionada.

isDefault

boolean

Especifica se a etiqueta é predefinida.

tagInfo

RetentionTag

RetentionTag
Informações da etiqueta de retenção

taggingPriority

integer

Prioridade da Etiqueta de Retenção.

TargetCopySetting

TargetCopySetting

Name Tipo Description
copyAfter CopyOption:

CopyOption
Pode ser CustomCopyOption ou ImmediateCopyOption.

dataStore

DataStoreInfoBase

DataStoreInfoBase
Informações do arquivo de dados de destino

WeekNumber

Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

Name Tipo Description
First

string

Fourth

string

Last

string

Second

string

Third

string