Backup Policies - Create Or Update

Referência

Serviço:: Data Protection

Versão da API:: 2025-01-01

Cria ou atualiza uma política de backup que pertence a um cofre de backup

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

Parâmetros de URI

Nome	Em	Obrigató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 diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser uma UUID.
vaultName	path	True	string	O nome do cofre de backup.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties	BaseBackupPolicy: BackupPolicy	BaseBackupPolicy Propriedades BaseBackupPolicyResource

Respostas

Nome	Tipo	Description
200 OK	BaseBackupPolicyResource	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	represente sua conta de usuário.

Exemplos

CreateOrUpdate BackupPolicy

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy?api-version=2025-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"
  }
}

Resposta de exemplo

Código de status:: 200

{
  "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

Nome	Description
AbsoluteDeleteOption	AbsoluteDeleteOption
AbsoluteMarker	ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração 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 armazenamento de dados; Operacional/Cofre/Arquivo Morto
Day	Dia
DayOfWeek	Deve ser domingo/segunda-feira/T..../sábado
Error	A resposta de erro de gerenciamento de recursos.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ImmediateCopyOption	ImmediateCopyOption
Month	Deve ser janeiro/fevereiro/....../dezembro
RetentionTag	RetentionTag
ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria
ScheduleBasedTriggerContext	ScheduleBasedTriggerContext
SourceLifeCycle	SourceLifeCycle
systemData	Metadados relativos à criação e última modificação do recurso.
TaggingCriteria	TaggingCriteria
TargetCopySetting	TargetCopySetting
WeekNumber	Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

AbsoluteDeleteOption

Object

AbsoluteDeleteOption

Nome	Tipo	Description
duration	string	Duração da exclusão após determinado período de tempo
objectType	string: AbsoluteDeleteOption	Tipo do objeto específico – usado para desserializar

AbsoluteMarker

Enumeration

ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração AbsoluteMarker

Valor	Description
AllBackup
FirstOfDay
FirstOfMonth
FirstOfWeek
FirstOfYear

AdhocBasedTaggingCriteria

Object

AdhocBasedTaggingCriteria

Nome	Tipo	Description
tagInfo	RetentionTag	RetentionTag Informações da marca de retenção

AdhocBasedTriggerContext

Object

AdhocBasedTriggerContext

Nome	Tipo	Description
objectType	string: AdhocBasedTriggerContext	Tipo do objeto específico – usado para desserializar
taggingCriteria	AdhocBasedTaggingCriteria	AdhocBasedTaggingCriteria Marcando critérios que contêm marca de retenção para backup de adesivo.

AzureBackupParams

Object

AzureBackupParams

Nome	Tipo	Description
backupType	string	BackupType ; Completo/incremental etc.
objectType	string: AzureBackupParams	Tipo do objeto específico – usado para desserializar

AzureBackupRule

Object

AzureBackupRule

Nome	Tipo	Description
backupParameters	BackupParameters: AzureBackupParams	BackupParameters Base de BackupParameters
dataStore	DataStoreInfoBase	DataStoreInfoBase Base do DataStoreInfo
name	string
objectType	string: AzureBackupRule
trigger	TriggerContext: AdhocBasedTriggerContext ScheduleBasedTriggerContext	TriggerContext Contexto de gatilho

AzureRetentionRule

Object

AzureRetentionRule

Nome	Tipo	Description
isDefault	boolean
lifecycles	SourceLifeCycle[]	SourceLifeCycle Ciclo de Vida de Origem
name	string
objectType	string: AzureRetentionRule

BackupPolicy

Object

BackupPolicy

Nome	Tipo	Description
datasourceTypes	string[]	Tipo de fonte de dados para o gerenciamento de backup
objectType	string: BackupPolicy
policyRules	BasePolicyRule[]: AzureBackupRule[] AzureRetentionRule[]	Dicionário de regras de política que contém regras para cada tipo de backup, ou seja, Completo/Incremental/Logs etc.

BackupSchedule

Object

BackupSchedule

Nome	Tipo	Description
repeatingTimeIntervals	string[]	Formato de intervalo de tempo repetido ISO 8601
timeZone	string	Fuso horário para um agendamento. Exemplo: Horário Padrão do Pacífico

BaseBackupPolicyResource

Object

BaseBackupPolicyResource

Nome	Tipo	Description
id	string	A 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 Namespace/ResourceType/ResourceType/...

CloudError

Object

CloudError

Nome	Tipo	Description
error	Error	A resposta de erro de gerenciamento de recursos.

CopyOnExpiryOption

Object

CopyOnExpiryOption

Nome	Tipo	Description
objectType	string: CopyOnExpiryOption	Tipo do objeto específico – usado para desserializar

createdByType

Enumeration

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

CustomCopyOption

Object

CustomCopyOption

Nome	Tipo	Description
duration	string	Dados copiados após determinado período de tempo
objectType	string: CustomCopyOption	Tipo do objeto específico – usado para desserializar

DataStoreInfoBase

Object

DataStoreInfoBase

Nome	Tipo	Description
dataStoreType	DataStoreTypes	tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto
objectType	string	Tipo de objeto Datasource, usado para inicializar o tipo herdado correto

DataStoreTypes

Enumeration

tipo de armazenamento de dados; Operacional/Cofre/Arquivo Morto

Valor	Description
ArchiveStore
OperationalStore
VaultStore

Day

Object

Dia

Nome	Tipo	Description
date	integer	Data do mês
isLast	boolean	Se a data é a última data do mês

DayOfWeek

Enumeration

Deve ser domingo/segunda-feira/T..../sábado

Valor	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Error

Object

A resposta de erro de gerenciamento de recursos.

Nome	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

Object

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ImmediateCopyOption

Object

ImmediateCopyOption

Nome	Tipo	Description
objectType	string: ImmediateCopyOption	Tipo do objeto específico – usado para desserializar

Month

Enumeration

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

Valor	Description
April
August
December
February
January
July
June
March
May
November
October
September

RetentionTag

Object

RetentionTag

Nome	Tipo	Description
eTag	string	Versão da Marca de Retenção.
id	string	Versão da Marca de Retenção.
tagName	string	Nome da marca de retenção para relacioná-lo à regra de retenção.

ScheduleBasedBackupCriteria

Object

ScheduleBasedBackupCriteria

Nome	Tipo	Description
absoluteCriteria	AbsoluteMarker[]	ele contém valores absolutos como "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" e deve fazer parte da enumeração AbsoluteMarker
daysOfMonth	Day[]	Este é o dia do mês de 1 a 28 outros sábios último mês
daysOfTheWeek	DayOfWeek[]	Deve ser domingo/segunda-feira/T..../sábado
monthsOfYear	Month[]	Deve ser janeiro/fevereiro/....../dezembro
objectType	string: ScheduleBasedBackupCriteria	Tipo do objeto específico – usado para desserializar
scheduleTimes	string[]	Lista de horários de backup
weeksOfTheMonth	WeekNumber[]	Deve ser Primeiro/Segundo/Terceiro/Quarto/Último

ScheduleBasedTriggerContext

Object

ScheduleBasedTriggerContext

Nome	Tipo	Description
objectType	string: ScheduleBasedTriggerContext	Tipo do objeto específico – usado para desserializar
schedule	BackupSchedule	BackupSchedule Agendar esse backup
taggingCriteria	TaggingCriteria[]	Lista de marcas que podem ser aplicáveis para determinado agendamento.

SourceLifeCycle

Object

SourceLifeCycle

Nome	Tipo	Description
deleteAfter	DeleteOption: AbsoluteDeleteOption	DeleteOption Opção Excluir
sourceDataStore	DataStoreInfoBase	DataStoreInfoBase Base do DataStoreInfo
targetDataStoreCopySettings	TargetCopySetting[]	TargetCopySetting Configurações de cópia de destino

systemData

Object

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

Nome	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

Object

TaggingCriteria

Nome	Tipo	Description
criteria	BackupCriteria[]: ScheduleBasedBackupCriteria[]	Critérios que decidem se a marca pode ser aplicada a um backup disparado.
isDefault	boolean	Especifica se a marca é padrão.
tagInfo	RetentionTag	RetentionTag Informações da marca de retenção
taggingPriority	integer	Prioridade da marca de retenção.

TargetCopySetting

Object

TargetCopySetting

Nome	Tipo	Description
copyAfter	CopyOption: CopyOnExpiryOption CustomCopyOption ImmediateCopyOption	CopyOption Pode ser CustomCopyOption ou ImmediateCopyOption.
dataStore	DataStoreInfoBase	DataStoreInfoBase Informações do armazenamento de dados de destino

WeekNumber

Enumeration

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

Valor	Description
First
Fourth
Last
Second
Third

Partilhar via

Backup Policies - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

CreateOrUpdate BackupPolicy

Solicitação de exemplo

Resposta de exemplo

Definições

AbsoluteDeleteOption

AbsoluteMarker

AdhocBasedTaggingCriteria

AdhocBasedTriggerContext

AzureBackupParams

AzureBackupRule

AzureRetentionRule

BackupPolicy

BackupSchedule

BaseBackupPolicyResource

CloudError

CopyOnExpiryOption

createdByType

CustomCopyOption

DataStoreInfoBase

DataStoreTypes

Day

DayOfWeek

Error

ErrorAdditionalInfo

ImmediateCopyOption

Month

RetentionTag

ScheduleBasedBackupCriteria

ScheduleBasedTriggerContext

SourceLifeCycle

systemData

TaggingCriteria

TargetCopySetting

WeekNumber

Recursos adicionais