Pin database

Pins or unpins a database.

If pinned, the status of the database cannot be changed to Inactive until the specified lease (pinExpiration) expires. If no pinExpiration is specified in the request, the database will remain pinned until explicitly unpinned.

🍏

Deprecated

This endpoint has been deprecated. Support for this endpoint will end in September 2026.

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

ConsumerContributorData Bridge Admin
NOYESNO

To learn more about role-based permissions in Data Bridge, see Access Controls.

Path Params
string
required

Name of managed SQL Server instance.

string
required

Name of database.

Body Params
boolean
required

Boolean to pin or unpin database. If true database is pinned.
While pinned, the database cannot be archived.

date-time | null

Expiration date for database lease. If unspecified, the lease will
not expire and the database must be unpinned.

Responses
200

OK. All went well.

400

Bad Request. Some of the provided parameters were not valid.

404

Not found. The entity you are trying to interact with does not
exist.

Language
URL
LoadingLoading…