{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "LedgerDigestUploads" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads": { "get": { "operationId": "LedgerDigestUploads_ListByDatabase", "tags": [ "LedgerDigestUploads" ], "description": "Gets all ledger digest upload settings on a database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LedgerDigestUploadsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets list of ledger digest upload settings on a database.": { "$ref": "./examples/LedgerDigestUploadsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}": { "get": { "operationId": "LedgerDigestUploads_Get", "tags": [ "LedgerDigestUploads" ], "description": "Gets the current ledger digest upload configuration for a database.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "ledgerDigestUploads", "in": "path", "description": "", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "LedgerDigestUploadsName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LedgerDigestUploads" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the current ledger digest upload configuration for a database.": { "$ref": "./examples/LedgerDigestUploadsGet.json" } } }, "put": { "operationId": "LedgerDigestUploads_CreateOrUpdate", "tags": [ "LedgerDigestUploads" ], "description": "Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "ledgerDigestUploads", "in": "path", "description": "", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "LedgerDigestUploadsName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } }, { "name": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/LedgerDigestUploads" } } ], "responses": { "200": { "description": "Resource 'LedgerDigestUploads' update operation succeeded", "schema": { "$ref": "#/definitions/LedgerDigestUploads" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enables ledger digest upload configuration for a database": { "$ref": "./examples/LedgerDigestUploadsEnable.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LedgerDigestUploads" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}/disable": { "post": { "operationId": "LedgerDigestUploads_Disable", "tags": [ "LedgerDigestUploads" ], "description": "Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" }, { "name": "ledgerDigestUploads", "in": "path", "description": "", "required": true, "type": "string", "enum": [ "current" ], "x-ms-enum": { "name": "LedgerDigestUploadsName", "modelAsString": true, "values": [ { "name": "current", "value": "current", "description": "current" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LedgerDigestUploads" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Disables uploading ledger digests for a database": { "$ref": "./examples/LedgerDigestUploadsDisable.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LedgerDigestUploads" }, "x-ms-long-running-operation": true } } }, "definitions": { "LedgerDigestUploads": { "type": "object", "description": "Azure SQL Database ledger digest upload settings.", "properties": { "properties": { "$ref": "#/definitions/LedgerDigestUploadsProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LedgerDigestUploadsListResult": { "type": "object", "description": "The response of a LedgerDigestUploads list operation.", "properties": { "value": { "type": "array", "description": "The LedgerDigestUploads items on this page", "items": { "$ref": "#/definitions/LedgerDigestUploads" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LedgerDigestUploadsProperties": { "type": "object", "description": "The properties of a database ledger digest upload settings.", "properties": { "digestStorageEndpoint": { "type": "string", "description": "The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger." }, "state": { "$ref": "./common.json#/definitions/LedgerDigestUploadsState", "description": "Specifies the state of ledger digest upload.", "readOnly": true } } } }, "parameters": {} }