Managed Instance Long Term Retention Policies - Get

Service:

SQL Database

Version d'API:

2025-01-01

Obtient la stratégie de rétention à long terme d’une base de données managée.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies/default?api-version=2025-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
managedInstanceName	path	True	string	Nom de l’instance managée.
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	Nom de la stratégie. Doit toujours être Par défaut.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ManagedInstanceLongTermRetentionPolicy	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get the long term retention policy for the managed database.

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2025-01-01

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
BackupStorageAccessTier	BackupStorageAccessTier pour la sauvegarde LTR
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ManagedInstanceLongTermRetentionPolicy	Stratégie de rétention à long terme.
ManagedInstanceLongTermRetentionPolicyName
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

BackupStorageAccessTier

Énumération

BackupStorageAccessTier pour la sauvegarde LTR

Valeur	Description
Hot	Chaud
Archive	L'archive

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ManagedInstanceLongTermRetentionPolicy

Objet

Stratégie de rétention à long terme.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.backupStorageAccessTier	BackupStorageAccessTier	BackupStorageAccessTier pour les sauvegardes LTR
properties.monthlyRetention	string	Stratégie de rétention mensuelle pour une sauvegarde LTR au format ISO 8601.
properties.weekOfYear	integer (int32)	Semaine de l’année pour effectuer la sauvegarde annuelle dans un format ISO 8601.
properties.weeklyRetention	string	Stratégie de rétention hebdomadaire pour une sauvegarde LTR au format ISO 8601.
properties.yearlyRetention	string	Stratégie de rétention annuelle pour une sauvegarde LTR au format ISO 8601.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ManagedInstanceLongTermRetentionPolicyName

Énumération

Valeur	Description
default	default

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.