Microsoft.Sql (stable:2023-08-01)

2025/03/17 • 529 new methods

BackupShortTermRetentionPolicies_ListByDatabase (new)
Description :  Gets a database's short term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupShortTermRetentionPolicies_Get (new)
Description :  Gets a database's short term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupShortTermRetentionPolicies_CreateOrUpdate (new)
Description :  Updates a database's short term retention policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
BackupShortTermRetentionPolicies_Update (new)
Description :  Updates a database's short term retention policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
diffBackupIntervalInHours:
{
Description: The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerBlobAuditingPolicies_ListByServer (new)
Description :  Lists auditing settings of a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/auditingSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } , ] ,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerBlobAuditingPolicies_Get (new)
Description :  Gets a server's blob auditing policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/auditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerBlobAuditingPolicies_CreateOrUpdate (new)
Description :  Creates or updates a server's blob auditing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/auditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Properties of blob auditing policy ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseBlobAuditingPolicies_ListByDatabase (new)
Description :  Lists auditing settings of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } , ] ,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseBlobAuditingPolicies_Get (new)
Description :  Gets a database's blob auditing policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseBlobAuditingPolicies_CreateOrUpdate (new)
Description :  Creates or updates a database's blob auditing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The database blob auditing policy. ,
Required: True ,
}
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }
ExtendedDatabaseBlobAuditingPolicies_ListByDatabase (new)
Description :  Lists extended auditing settings of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } , ] ,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtendedDatabaseBlobAuditingPolicies_Get (new)
Description :  Gets an extended database's blob auditing policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtendedDatabaseBlobAuditingPolicies_CreateOrUpdate (new)
Description :  Creates or updates an extended database's blob auditing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extendedAuditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The extended database blob auditing policy. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }
ExtendedServerBlobAuditingPolicies_ListByServer (new)
Description :  Lists extended auditing settings of a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } , ] ,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtendedServerBlobAuditingPolicies_Get (new)
Description :  Gets an extended server's blob auditing policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtendedServerBlobAuditingPolicies_CreateOrUpdate (new)
Description :  Creates or updates an extended server's blob auditing policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings/{blobAuditingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
blobAuditingPolicyName:
{
Description: The name of the blob auditing policy. ,
Required: True ,
}
string ,
parameters:
{
Description: Properties of extended blob auditing policy ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , } ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isDevopsAuditEnabled:
{
Description: Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
predicateExpression:
{
Description: Specifies condition of where clause when creating an audit. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the audit logs in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
auditActionsAndGroups:
{
Description: Specifies the Actions-Groups and Actions to audit. The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. This above combination is also the set that is configured by default when enabling auditing from the Azure portal. The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records): APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP DBCC_GROUP DATABASE_OWNERSHIP_CHANGE_GROUP DATABASE_CHANGE_GROUP LEDGER_OPERATION_GROUP These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs. For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups). For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES The general form for defining an action to be audited is: {action} ON {object} BY {principal} Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively. For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions) ,
Required: False ,
}
[
string ,
]
,
isStorageSecondaryKeyInUse:
{
Description: Specifies whether storageAccountAccessKey value is the storage's secondary key. ,
Required: False ,
}
boolean ,
isAzureMonitorTargetEnabled:
{
Description: Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created. Note that for server level audit you should use the 'master' database as {databaseName}. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
queueDelayMs:
{
Description: Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647. ,
Format: int32 ,
Required: False ,
}
integer ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DataMaskingPolicies_Get (new)
Description :  Gets the database data masking policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
dataMaskingPolicyName:
{
Description: The name of the database for which the data masking policy applies. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the data masking policy. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Policy. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dataMaskingState:
{
Description: The state of the data masking policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
exemptPrincipals:
{
Description: The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries. ,
Required: False ,
}
string ,
applicationPrincipals:
{
Description: The list of the application principals. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingLevel:
{
Description: The masking level. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataMaskingPolicies_CreateOrUpdate (new)
Description :  Creates or updates a database data masking policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
dataMaskingPolicyName:
{
Description: The name of the database for which the data masking policy applies. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating a data masking policy. ,
Required: True ,
}
{
location:
{
Description: The location of the data masking policy. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Policy. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dataMaskingState:
{
Description: The state of the data masking policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
exemptPrincipals:
{
Description: The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries. ,
Required: False ,
}
string ,
applicationPrincipals:
{
Description: The list of the application principals. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingLevel:
{
Description: The masking level. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the data masking policy. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Policy. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dataMaskingState:
{
Description: The state of the data masking policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
exemptPrincipals:
{
Description: The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries. ,
Required: False ,
}
string ,
applicationPrincipals:
{
Description: The list of the application principals. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingLevel:
{
Description: The masking level. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the data masking policy. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Policy. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dataMaskingState:
{
Description: The state of the data masking policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
exemptPrincipals:
{
Description: The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries. ,
Required: False ,
}
string ,
applicationPrincipals:
{
Description: The list of the application principals. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingLevel:
{
Description: The masking level. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
}
,
}
DataMaskingRules_ListByDatabase (new)
Description :  Gets a list of database data masking rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
dataMaskingPolicyName:
{
Description: The name of the database for which the data masking rule applies. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
location:
{
Description: The location of the data masking rule. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Rule. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
id:
{
Description: The rule Id. ,
Required: False ,
}
string ,
ruleState:
{
Description: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
schemaName:
{
Description: The schema name on which the data masking rule is applied. ,
Required: True ,
}
string ,
tableName:
{
Description: The table name on which the data masking rule is applied. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name on which the data masking rule is applied. ,
Required: True ,
}
string ,
aliasName:
{
Description: The alias name. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingFunction:
{
Description: The masking function that is used for the data masking rule. ,
Enum:
{
Default: No description available. ,
CCN: No description available. ,
Email: No description available. ,
Number: No description available. ,
SSN: No description available. ,
Text: No description available. ,
}
,
Required: True ,
}
enum ,
numberFrom:
{
Description: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
numberTo:
{
Description: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
prefixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
suffixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
replacementString:
{
Description: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataMaskingRules_CreateOrUpdate (new)
Description :  Creates or updates a database data masking rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules/{dataMaskingRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
dataMaskingPolicyName:
{
Description: The name of the database for which the data masking policy applies. ,
Required: True ,
}
string ,
dataMaskingRuleName:
{
Description: The name of the data masking rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a data masking rule. ,
Required: True ,
}
{
location:
{
Description: The location of the data masking rule. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Rule. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
id:
{
Description: The rule Id. ,
Required: False ,
}
string ,
ruleState:
{
Description: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
schemaName:
{
Description: The schema name on which the data masking rule is applied. ,
Required: True ,
}
string ,
tableName:
{
Description: The table name on which the data masking rule is applied. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name on which the data masking rule is applied. ,
Required: True ,
}
string ,
aliasName:
{
Description: The alias name. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingFunction:
{
Description: The masking function that is used for the data masking rule. ,
Enum:
{
Default: No description available. ,
CCN: No description available. ,
Email: No description available. ,
Number: No description available. ,
SSN: No description available. ,
Text: No description available. ,
}
,
Required: True ,
}
enum ,
numberFrom:
{
Description: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
numberTo:
{
Description: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
prefixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
suffixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
replacementString:
{
Description: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the data masking rule. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Rule. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
id:
{
Description: The rule Id. ,
Required: False ,
}
string ,
ruleState:
{
Description: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
schemaName:
{
Description: The schema name on which the data masking rule is applied. ,
Required: True ,
}
string ,
tableName:
{
Description: The table name on which the data masking rule is applied. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name on which the data masking rule is applied. ,
Required: True ,
}
string ,
aliasName:
{
Description: The alias name. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingFunction:
{
Description: The masking function that is used for the data masking rule. ,
Enum:
{
Default: No description available. ,
CCN: No description available. ,
Email: No description available. ,
Number: No description available. ,
SSN: No description available. ,
Text: No description available. ,
}
,
Required: True ,
}
enum ,
numberFrom:
{
Description: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
numberTo:
{
Description: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
prefixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
suffixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
replacementString:
{
Description: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: The location of the data masking rule. ,
Required: False ,
}
string ,
kind:
{
Description: The kind of Data Masking Rule. Metadata, used for Azure portal. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
id:
{
Description: The rule Id. ,
Required: False ,
}
string ,
ruleState:
{
Description: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
schemaName:
{
Description: The schema name on which the data masking rule is applied. ,
Required: True ,
}
string ,
tableName:
{
Description: The table name on which the data masking rule is applied. ,
Required: True ,
}
string ,
columnName:
{
Description: The column name on which the data masking rule is applied. ,
Required: True ,
}
string ,
aliasName:
{
Description: The alias name. This is a legacy parameter and is no longer used. ,
Required: False ,
}
string ,
maskingFunction:
{
Description: The masking function that is used for the data masking rule. ,
Enum:
{
Default: No description available. ,
CCN: No description available. ,
Email: No description available. ,
Number: No description available. ,
SSN: No description available. ,
Text: No description available. ,
}
,
Required: True ,
}
enum ,
numberFrom:
{
Description: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
numberTo:
{
Description: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored. ,
Required: False ,
}
string ,
prefixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
suffixSize:
{
Description: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
replacementString:
{
Description: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored. ,
Required: False ,
}
string ,
}
,
}
DataWarehouseUserActivities_ListByDatabase (new)
Description :  List the user activities of a data warehouse which includes running and suspended queries
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataWarehouseUserActivities
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
activeQueriesCount:
{
Description: Count of running and suspended queries. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataWarehouseUserActivities_Get (new)
Description :  Gets the user activities of a data warehouse which includes running and suspended queries
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataWarehouseUserActivities/{dataWarehouseUserActivityName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
dataWarehouseUserActivityName:
{
Description: The activity name of the data warehouse. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
activeQueriesCount:
{
Description: Count of running and suspended queries. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAdvancedThreatProtectionSettings_ListByDatabase (new)
Description :  Gets a list of database's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advancedThreatProtectionSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAdvancedThreatProtectionSettings_Get (new)
Description :  Gets a database's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAdvancedThreatProtectionSettings_CreateOrUpdate (new)
Description :  Creates or updates a database's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The database Advanced Threat Protection state. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
DatabaseAdvisors_ListByDatabase (new)
Description :  Gets a list of database advisors.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAdvisors_Get (new)
Description :  Gets a database advisor.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Database Advisor. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAdvisors_Update (new)
Description :  Updates a database advisor.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Database Advisor. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested advisor resource state. ,
Required: True ,
}
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAutomaticTuning_Get (new)
Description :  Gets a database's automatic tuning.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseAutomaticTuning_Update (new)
Description :  Update automatic tuning properties for target database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested automatic tuning resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Inherit: No description available. ,
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseColumns_ListByDatabase (new)
Description :  List database columns
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/columns
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schema:
{
Required: False ,
}
array ,
table:
{
Required: False ,
}
array ,
column:
{
Required: False ,
}
array ,
orderBy:
{
Required: False ,
}
array ,
$skiptoken:
{
Description: An opaque token that identifies a starting point in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseColumns_ListByTable (new)
Description :  List database columns
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseColumns_Get (new)
Description :  Get database column
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseEncryptionProtectors_Revalidate (new)
Description :  Revalidates an existing encryption protector for a particular database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revalidate
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseEncryptionProtectors_Revert (new)
Description :  Reverts an existing encryption protector for a particular database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/encryptionProtector/{encryptionProtectorName}/revert
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseExtensions_ListByDatabase (new)
Description :  List database extension. This will return an empty list as it is not supported.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob URI. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the status of private endpoints associated with this request. ,
Required: False ,
}
[
{
privateLinkServiceId:
{
Description: Resource id for which the private endpoint is created. ,
Required: False ,
}
string ,
privateEndpointConnectionName:
{
Description: The connection name for the private endpoint. ,
Required: False ,
}
string ,
status:
{
Description: Status of this private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseExtensions_Get (new)
Description :  Gets a database extension. This will return resource not found as it is not supported.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
extensionName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseExtensions_CreateOrUpdate (new)
Description :  Perform a database extension operation, like database import, database export, or polybase import
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
extensionName:
{
Required: True ,
}
string ,
parameters:
{
Description: The database import request parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
operationMode:
{
Description: Operation mode of the operation: Import, Export, or PolybaseImport. ,
Enum:
{
PolybaseImport: No description available. ,
Import: No description available. ,
Export: No description available. ,
}
,
Required: True ,
}
enum ,
storageKeyType:
{
Description: Storage key type: StorageAccessKey or SharedAccessKey. ,
Enum:
{
SharedAccessKey: No description available. ,
StorageAccessKey: No description available. ,
}
,
Required: True ,
}
enum ,
storageKey:
{
Description: Storage key for the storage account. ,
Required: True ,
}
string ,
storageUri:
{
Description: Storage Uri for the storage account. ,
Required: True ,
}
string ,
administratorLogin:
{
Description: Administrator login name. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: Administrator login password. ,
Required: False ,
}
string ,
authenticationType:
{
Description: Authentication type: SQL authentication or AD password. ,
Required: False ,
}
string ,
databaseEdition:
{
Description: Database edition for the newly created database in the case of an import operation. ,
Required: False ,
}
string ,
serviceObjectiveName:
{
Description: Database service level objective for the newly created database in the case of an import operation. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: Database max size in bytes for the newly created database in the case of an import operation. ,
Required: False ,
}
string ,
networkIsolation:
{
Description: Optional resource information to enable network isolation for request. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. ,
Format: arm-id ,
Required: False ,
}
string ,
sqlServerResourceId:
{
Description: The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob URI. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the status of private endpoints associated with this request. ,
Required: False ,
}
[
{
privateLinkServiceId:
{
Description: Resource id for which the private endpoint is created. ,
Required: False ,
}
string ,
privateEndpointConnectionName:
{
Description: The connection name for the private endpoint. ,
Required: False ,
}
string ,
status:
{
Description: Status of this private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseOperations_ListByDatabase (new)
Description :  Gets a list of operations performed on the database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: The name of the database the operation is being performed on. ,
Required: False ,
}
string ,
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the operation completed. ,
Format: int32 ,
Required: False ,
}
integer ,
serverName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
estimatedCompletionTime:
{
Description: The estimated completion time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Whether the operation can be cancelled. ,
Required: False ,
}
boolean ,
operationPhaseDetails:
{
Description: The operation phase details. ,
Required: False ,
}
{
phase:
{
Description: The operation phase. ,
Enum:
{
LogTransitionInProgress: No description available. ,
Copying: No description available. ,
BuildingHyperscaleComponents: No description available. ,
Catchup: No description available. ,
WaitingForCutover: No description available. ,
CutoverInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
phaseInformation:
{
Description: The operation phase information. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseOperations_Cancel (new)
Description :  Cancels the asynchronous operation on the database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations/{operationId}/cancel
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation identifier. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseRecommendedActions_ListByDatabaseAdvisor (new)
Description :  Gets list of Database Recommended Actions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Database Advisor. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseRecommendedActions_Get (new)
Description :  Gets a database recommended action.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Database Advisor. ,
Required: True ,
}
string ,
recommendedActionName:
{
Description: The name of Database Recommended Action. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseRecommendedActions_Update (new)
Description :  Updates a database recommended action.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Database Advisor. ,
Required: True ,
}
string ,
recommendedActionName:
{
Description: The name of Database Recommended Action. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested recommended action resource state. ,
Required: True ,
}
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSchemas_ListByDatabase (new)
Description :  List database schemas
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSchemas_Get (new)
Description :  Get database schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A database schema resource. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSecurityAlertPolicies_ListByDatabase (new)
Description :  Gets a list of database's security alert policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the security alert policy is defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSecurityAlertPolicies_Get (new)
Description :  Gets a database's security alert policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the security alert policy is defined. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSecurityAlertPolicies_CreateOrUpdate (new)
Description :  Creates or updates a database's security alert policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the security alert policy is defined. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The database security alert policy. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
DatabaseSqlVulnerabilityAssessmentBaselines_ListBySqlVulnerabilityAssessment (new)
Description :  Gets a list of database's sql vulnerability assessment rule baselines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentBaselines_Get (new)
Description :  Gets a list of database's sql vulnerability assessment rule baselines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentBaselines_CreateOrUpdate (new)
Description :  Add a database's vulnerability assessment rule baseline list.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineListInputResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
latestScan:
{
Description: The latest scan flag ,
Required: True ,
}
boolean ,
results:
{
Description: The rule baseline result list ,
Required: True ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentExecuteScan_Execute (new)
Description :  Executes a Vulnerability Assessment database scan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/initiateScan
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseSqlVulnerabilityAssessmentRuleBaselines_ListByBaseline (new)
Description :  Gets a list of database's sql vulnerability assessment rule baselines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentRuleBaselines_Get (new)
Description :  Gets a database's sql vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentRuleBaselines_CreateOrUpdate (new)
Description :  Creates or updates a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineInputResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
latestScan:
{
Description: The latest scan flag ,
Required: True ,
}
boolean ,
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentRuleBaselines_Delete (new)
Description :  Removes the database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
DatabaseSqlVulnerabilityAssessmentScanResult_ListByScan (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/scanResults
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The scan id of the SQL Vulnerability Assessment scan to retrieve result from. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
status:
{
Description: SQL Vulnerability Assessment rule result status. ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: SQL Vulnerability Assessment error message. ,
Required: False ,
}
string ,
isTrimmed:
{
Description: SQL Vulnerability Assessment is the query results trimmed. ,
Required: False ,
}
boolean ,
queryResults:
{
Description: SQL Vulnerability Assessment query results that was run. ,
Required: False ,
}
[
string ,
]
,
remediation:
{
Description: SQL Vulnerability Assessment the remediation details. ,
Required: False ,
}
{
description:
{
Description: SQL Vulnerability Assessment remediation description. ,
Required: False ,
}
string ,
scripts:
{
Description: SQL Vulnerability Assessment remediation script. ,
Required: False ,
}
[
string ,
]
,
automated:
{
Description: SQL Vulnerability Assessment is remediation automated. ,
Required: False ,
}
boolean ,
portalLink:
{
Description: SQL Vulnerability Assessment optional link to remediate in Azure Portal. ,
Required: False ,
}
string ,
}
,
baselineAdjustedResult:
{
Description: SQL Vulnerability Assessment rule result adjusted with baseline. ,
Required: False ,
}
{
baseline:
{
Description: SQL Vulnerability Assessment baseline details ,
Required: False ,
}
{
expectedResults:
{
Description: SQL Vulnerability Assessment baseline expected results ,
Required: False ,
}
[
string ,
]
,
updatedTime:
{
Description: SQL Vulnerability Assessment baseline update time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
status:
{
Description: SQL Vulnerability Assessment baseline status ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
resultsNotInBaseline:
{
Description: SQL Vulnerability Assessment results that are not in baseline ,
Required: False ,
}
[
string ,
]
,
resultsOnlyInBaseline:
{
Description: SQL Vulnerability Assessment results that are in baseline. ,
Required: False ,
}
[
string ,
]
,
}
,
ruleMetadata:
{
Description: SQL Vulnerability Assessment rule metadata. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
severity:
{
Description: SQL Vulnerability Assessment rule severity. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
Obsolete: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: SQL Vulnerability Assessment rule category. ,
Required: False ,
}
string ,
ruleType:
{
Description: SQL Vulnerability Assessment rule type. ,
Enum:
{
Binary: No description available. ,
BaselineExpected: No description available. ,
PositiveList: No description available. ,
NegativeList: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: SQL Vulnerability Assessment rule title. ,
Required: False ,
}
string ,
description:
{
Description: SQL Vulnerability Assessment rule description. ,
Required: False ,
}
string ,
rationale:
{
Description: SQL Vulnerability Assessment rule rationale. ,
Required: False ,
}
string ,
queryCheck:
{
Description: SQL Vulnerability Assessment rule query details. ,
Required: False ,
}
{
query:
{
Description: SQL Vulnerability Assessment rule query. ,
Required: False ,
}
string ,
expectedResult:
{
Description: SQL Vulnerability Assessment query expected result. ,
Required: False ,
}
[
string ,
]
,
columnNames:
{
Description: SQL Vulnerability Assessment column names of query expected result. ,
Required: False ,
}
[
string ,
]
,
}
,
benchmarkReferences:
{
Description: SQL Vulnerability Assessment benchmark references. ,
Required: False ,
}
[
{
benchmark:
{
Description: SQL Vulnerability Assessment benchmark name ,
Required: False ,
}
string ,
reference:
{
Description: SQL Vulnerability Assessment benchmark reference. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentScanResult_Get (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/scanResults/{scanResultId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The scan id of the SQL Vulnerability Assessment scan to retrieve result from. ,
Required: True ,
}
string ,
scanResultId:
{
Description: The scan result id of the specific result to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
status:
{
Description: SQL Vulnerability Assessment rule result status. ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: SQL Vulnerability Assessment error message. ,
Required: False ,
}
string ,
isTrimmed:
{
Description: SQL Vulnerability Assessment is the query results trimmed. ,
Required: False ,
}
boolean ,
queryResults:
{
Description: SQL Vulnerability Assessment query results that was run. ,
Required: False ,
}
[
string ,
]
,
remediation:
{
Description: SQL Vulnerability Assessment the remediation details. ,
Required: False ,
}
{
description:
{
Description: SQL Vulnerability Assessment remediation description. ,
Required: False ,
}
string ,
scripts:
{
Description: SQL Vulnerability Assessment remediation script. ,
Required: False ,
}
[
string ,
]
,
automated:
{
Description: SQL Vulnerability Assessment is remediation automated. ,
Required: False ,
}
boolean ,
portalLink:
{
Description: SQL Vulnerability Assessment optional link to remediate in Azure Portal. ,
Required: False ,
}
string ,
}
,
baselineAdjustedResult:
{
Description: SQL Vulnerability Assessment rule result adjusted with baseline. ,
Required: False ,
}
{
baseline:
{
Description: SQL Vulnerability Assessment baseline details ,
Required: False ,
}
{
expectedResults:
{
Description: SQL Vulnerability Assessment baseline expected results ,
Required: False ,
}
[
string ,
]
,
updatedTime:
{
Description: SQL Vulnerability Assessment baseline update time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
status:
{
Description: SQL Vulnerability Assessment baseline status ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
resultsNotInBaseline:
{
Description: SQL Vulnerability Assessment results that are not in baseline ,
Required: False ,
}
[
string ,
]
,
resultsOnlyInBaseline:
{
Description: SQL Vulnerability Assessment results that are in baseline. ,
Required: False ,
}
[
string ,
]
,
}
,
ruleMetadata:
{
Description: SQL Vulnerability Assessment rule metadata. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
severity:
{
Description: SQL Vulnerability Assessment rule severity. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
Obsolete: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: SQL Vulnerability Assessment rule category. ,
Required: False ,
}
string ,
ruleType:
{
Description: SQL Vulnerability Assessment rule type. ,
Enum:
{
Binary: No description available. ,
BaselineExpected: No description available. ,
PositiveList: No description available. ,
NegativeList: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: SQL Vulnerability Assessment rule title. ,
Required: False ,
}
string ,
description:
{
Description: SQL Vulnerability Assessment rule description. ,
Required: False ,
}
string ,
rationale:
{
Description: SQL Vulnerability Assessment rule rationale. ,
Required: False ,
}
string ,
queryCheck:
{
Description: SQL Vulnerability Assessment rule query details. ,
Required: False ,
}
{
query:
{
Description: SQL Vulnerability Assessment rule query. ,
Required: False ,
}
string ,
expectedResult:
{
Description: SQL Vulnerability Assessment query expected result. ,
Required: False ,
}
[
string ,
]
,
columnNames:
{
Description: SQL Vulnerability Assessment column names of query expected result. ,
Required: False ,
}
[
string ,
]
,
}
,
benchmarkReferences:
{
Description: SQL Vulnerability Assessment benchmark references. ,
Required: False ,
}
[
{
benchmark:
{
Description: SQL Vulnerability Assessment benchmark name ,
Required: False ,
}
string ,
reference:
{
Description: SQL Vulnerability Assessment benchmark reference. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentScans_ListBySqlVulnerabilityAssessments (new)
Description :  Lists the vulnerability assessment scans of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentScanRecordResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
server:
{
Description: The server name. ,
Required: False ,
}
string ,
database:
{
Description: The database name. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
highSeverityFailedRulesCount:
{
Description: The number of failed rules with high severity. ,
Format: int32 ,
Required: False ,
}
integer ,
mediumSeverityFailedRulesCount:
{
Description: The number of failed rules with medium severity. ,
Format: int32 ,
Required: False ,
}
integer ,
lowSeverityFailedRulesCount:
{
Description: The number of failed rules with low severity. ,
Format: int32 ,
Required: False ,
}
integer ,
totalPassedRulesCount:
{
Description: The number of total passed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalFailedRulesCount:
{
Description: The number of total failed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRulesCount:
{
Description: The number of total rules assessed. ,
Format: int32 ,
Required: False ,
}
integer ,
isBaselineApplied:
{
Description: Baseline created for this database, and has one or more rules. ,
Required: False ,
}
boolean ,
lastScanTime:
{
Description: The last scan time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentScans_Get (new)
Description :  Get a database vulnerability assessment scan result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id of the scan to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentScanRecordResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
server:
{
Description: The server name. ,
Required: False ,
}
string ,
database:
{
Description: The database name. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
highSeverityFailedRulesCount:
{
Description: The number of failed rules with high severity. ,
Format: int32 ,
Required: False ,
}
integer ,
mediumSeverityFailedRulesCount:
{
Description: The number of failed rules with medium severity. ,
Format: int32 ,
Required: False ,
}
integer ,
lowSeverityFailedRulesCount:
{
Description: The number of failed rules with low severity. ,
Format: int32 ,
Required: False ,
}
integer ,
totalPassedRulesCount:
{
Description: The number of total passed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalFailedRulesCount:
{
Description: The number of total failed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRulesCount:
{
Description: The number of total rules assessed. ,
Format: int32 ,
Required: False ,
}
integer ,
isBaselineApplied:
{
Description: Baseline created for this database, and has one or more rules. ,
Required: False ,
}
boolean ,
lastScanTime:
{
Description: The last scan time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentsSettings_ListByDatabase (new)
Description :  Lists SQL Vulnerability Assessment policies associated with a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseSqlVulnerabilityAssessmentsSettings_Get (new)
Description :  Gets SQL Vulnerability Assessment policy for database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseTables_ListBySchema (new)
Description :  List database tables
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the table is memory optimized. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseTables_Get (new)
Description :  Get database table
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the table is memory optimized. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseUsages_ListByDatabase (new)
Description :  Gets database usages.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/usages
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
displayName:
{
Description: User-readable name of the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: Boundary value of the metric. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentRuleBaselines_Get (new)
Description :  Gets a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentRuleBaselines_CreateOrUpdate (new)
Description :  Creates or updates a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentRuleBaselines_Delete (new)
Description :  Removes the database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentScans_ListByDatabase (new)
Description :  Lists the vulnerability assessment scans of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
storageContainerPath:
{
Description: The scan results storage container path. ,
Required: False ,
}
string ,
numberOfFailedSecurityChecks:
{
Description: The number of failed security checks. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentScans_Get (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id of the scan to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
storageContainerPath:
{
Description: The scan results storage container path. ,
Required: False ,
}
string ,
numberOfFailedSecurityChecks:
{
Description: The number of failed security checks. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessmentScans_Export (new)
Description :  Convert an existing scan result to a human readable format. If already exists nothing happens
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/export
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the scanned database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
exportedReportLocation:
{
Description: Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
exportedReportLocation:
{
Description: Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx). ,
Required: False ,
}
string ,
}
,
}
DatabaseVulnerabilityAssessmentScans_InitiateScan (new)
Description :  Executes a Vulnerability Assessment database scan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id of the scan to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DatabaseVulnerabilityAssessments_ListByDatabase (new)
Description :  Lists the vulnerability assessment policies associated with a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment policies are defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessments_Get (new)
Description :  Gets the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DatabaseVulnerabilityAssessments_CreateOrUpdate (new)
Description :  Creates or updates the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
DatabaseVulnerabilityAssessments_Delete (new)
Description :  Removes the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ListByServer (new)
Description :  Gets a list of databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Get (new)
Description :  Gets a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_CreateOrUpdate (new)
Description :  Creates a new database or updates an existing database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested database resource state. ,
Required: True ,
}
{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}
Databases_Delete (new)
Description :  Deletes the database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
Databases_Update (new)
Description :  Updates an existing database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested database resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Database identity ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_Export (new)
Description :  Exports a database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/export
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The database export request parameters. ,
Required: True ,
}
{
storageKeyType:
{
Description: Storage key type. ,
Enum:
{
SharedAccessKey: No description available. ,
StorageAccessKey: No description available. ,
}
,
Required: True ,
}
enum ,
storageKey:
{
Description: Storage key. ,
Required: True ,
}
string ,
storageUri:
{
Description: Storage Uri. ,
Required: True ,
}
string ,
administratorLogin:
{
Description: Administrator login name. ,
Required: True ,
}
string ,
administratorLoginPassword:
{
Description: Administrator login password. ,
Required: True ,
}
string ,
authenticationType:
{
Description: Authentication type. ,
Required: False ,
}
string ,
networkIsolation:
{
Description: Optional resource information to enable network isolation for request. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. ,
Format: arm-id ,
Required: False ,
}
string ,
sqlServerResourceId:
{
Description: The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time. ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob Uri. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the status of private endpoints associated with this request. ,
Required: False ,
}
[
{
privateLinkServiceId:
{
Description: Resource id for which the private endpoint is created. ,
Required: False ,
}
string ,
privateEndpointConnectionName:
{
Description: The connection name for the private endpoint. ,
Required: False ,
}
string ,
status:
{
Description: Status of this private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_Failover (new)
Description :  Failovers a database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to failover. ,
Required: True ,
}
string ,
replicaType:
{
Description: The type of replica to be failed over. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_Import (new)
Description :  Imports a bacpac into a new database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/import
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The database import request parameters. ,
Required: True ,
}
{
storageKeyType:
{
Description: Storage key type. ,
Enum:
{
SharedAccessKey: No description available. ,
StorageAccessKey: No description available. ,
}
,
Required: True ,
}
enum ,
storageKey:
{
Description: Storage key. ,
Required: True ,
}
string ,
storageUri:
{
Description: Storage Uri. ,
Required: True ,
}
string ,
administratorLogin:
{
Description: Administrator login name. ,
Required: True ,
}
string ,
administratorLoginPassword:
{
Description: Administrator login password. ,
Required: True ,
}
string ,
authenticationType:
{
Description: Authentication type. ,
Required: False ,
}
string ,
networkIsolation:
{
Description: Optional resource information to enable network isolation for request. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. ,
Format: arm-id ,
Required: False ,
}
string ,
sqlServerResourceId:
{
Description: The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time. ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob Uri. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the status of private endpoints associated with this request. ,
Required: False ,
}
[
{
privateLinkServiceId:
{
Description: Resource id for which the private endpoint is created. ,
Required: False ,
}
string ,
privateEndpointConnectionName:
{
Description: The connection name for the private endpoint. ,
Required: False ,
}
string ,
status:
{
Description: Status of this private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_Rename (new)
Description :  Renames a database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/move
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to rename. ,
Required: True ,
}
string ,
parameters:
{
Description: The resource move definition for renaming this database. ,
Required: True ,
}
{
id:
{
Description: The target ID for the resource ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_Pause (new)
Description :  Pauses a database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/pause
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to be paused. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_Resume (new)
Description :  Resumes a database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/resume
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to be resumed. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_UpgradeDataWarehouse (new)
Description :  Upgrades a data warehouse.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/upgradeDataWarehouse
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to be upgraded. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Databases_ListByElasticPool (new)
Description :  Gets a list of databases in an elastic pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/databases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Databases_ListInaccessibleByServer (new)
Description :  Gets a list of inaccessible databases in a logical server
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/inaccessibleDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The database SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands: ```azurecli az sql db list-editions -l -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of database. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
managedBy:
{
Description: Resource that manages the database. ,
Required: False ,
}
string ,
identity:
{
Description: The Azure Active Directory identity of the database. ,
Required: False ,
}
{
type:
{
Description: The identity type ,
Enum:
{
None: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
createMode:
{
Description: Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. ,
Enum:
{
Default: No description available. ,
Copy: No description available. ,
Secondary: No description available. ,
PointInTimeRestore: No description available. ,
Restore: No description available. ,
Recovery: No description available. ,
RestoreExternalBackup: No description available. ,
RestoreExternalBackupSecondary: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
OnlineSecondary: No description available. ,
}
,
Required: False ,
}
enum ,
collation:
{
Description: The collation of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
sampleName:
{
Description: The name of the sample schema to apply when creating this database. ,
Enum:
{
AdventureWorksLT: No description available. ,
WideWorldImportersStd: No description available. ,
WideWorldImportersFull: No description available. ,
}
,
Required: False ,
}
enum ,
elasticPoolId:
{
Description: The resource identifier of the elastic pool containing this database. ,
Format: arm-id ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: The status of the database. ,
Enum:
{
Online: No description available. ,
Restoring: No description available. ,
RecoveryPending: No description available. ,
Recovering: No description available. ,
Suspect: No description available. ,
Offline: No description available. ,
Standby: No description available. ,
Shutdown: No description available. ,
EmergencyMode: No description available. ,
AutoClosed: No description available. ,
Copying: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
OfflineSecondary: No description available. ,
Pausing: No description available. ,
Paused: No description available. ,
Resuming: No description available. ,
Scaling: No description available. ,
OfflineChangingDwPerformanceTiers: No description available. ,
OnlineChangingDwPerformanceTiers: No description available. ,
Disabled: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: The ID of the database. ,
Format: uuid ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
currentServiceObjectiveName:
{
Description: The current service level objective name of the database. ,
Required: False ,
}
string ,
requestedServiceObjectiveName:
{
Description: The requested service level objective name of the database. ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: The default secondary region for this database. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Failover Group resource identifier that this database belongs to. ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDatabaseDeletionDate:
{
Description: Specifies the time that the database was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
recoveryServicesRecoveryPointId:
{
Description: The resource identifier of the recovery point associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The resource identifier of the long term retention backup associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The resource identifier of the restorable dropped database associated with create operation of this database. ,
Format: arm-id ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maxLogSizeBytes:
{
Description: The max log size for this database. ,
Format: int64 ,
Required: False ,
}
integer ,
earliestRestoreDate:
{
Description: This records the earliest start date and time that restore is available for this database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
readScale:
{
Description: The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool. ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryType:
{
Description: The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. ,
Enum:
{
Geo: No description available. ,
Named: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
currentSku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
autoPauseDelay:
{
Description: Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
minCapacity:
{
Description: Minimal capacity that database will always have allocated, if not paused ,
Format: double ,
Required: False ,
}
number ,
pausedDate:
{
Description: The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. ,
Format: date-time ,
Required: False ,
}
string ,
resumedDate:
{
Description: The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. ,
Format: date-time ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
isInfraEncryptionEnabled:
{
Description: Infra encryption is enabled for this database. ,
Required: False ,
}
boolean ,
federatedClientId:
{
Description: The Client id used for cross tenant per database CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
encryptionProtector:
{
Description: The azure key vault URI of the database if it's configured with per Database Customer Managed Keys. ,
Required: False ,
}
string ,
preferredEnclaveType:
{
Description: Type of enclave requested on the database i.e. Default or VBS enclaves. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
useFreeLimit:
{
Description: Whether or not the database uses free monthly limits. Allowed on one database in a subscription. ,
Required: False ,
}
boolean ,
freeLimitExhaustionBehavior:
{
Description: Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The resource identifier of the source associated with the create operation of this database. This property is only supported for DataWarehouse edition and allows to restore across subscriptions. When sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover. When createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified. When createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool. When createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool. When source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ,
Format: arm-id ,
Required: False ,
}
string ,
manualCutover:
{
Description: Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state. ,
Required: False ,
}
boolean ,
performCutover:
{
Description: To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database. ,
Required: False ,
}
boolean ,
availabilityZone:
{
Description: Specifies the availability zone the database is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
encryptionProtectorAutoRotation:
{
Description: The flag to enable or disable auto rotation of database encryption protector AKV key. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServers_List (new)
Description :  Gets a list of all deleted servers in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/deletedServers
{
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted server. ,
Required: False ,
}
string ,
deletionTime:
{
Description: The deletion time of the deleted server. ,
Format: date-time ,
Required: False ,
}
string ,
originalId:
{
Description: The original ID of the server before deletion. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServers_ListByLocation (new)
Description :  Gets a list of deleted servers for a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/deletedServers
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted server. ,
Required: False ,
}
string ,
deletionTime:
{
Description: The deletion time of the deleted server. ,
Format: date-time ,
Required: False ,
}
string ,
originalId:
{
Description: The original ID of the server before deletion. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServers_Get (new)
Description :  Gets a deleted server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/deletedServers/{deletedServerName}
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
deletedServerName:
{
Description: The name of the deleted server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted server. ,
Required: False ,
}
string ,
deletionTime:
{
Description: The deletion time of the deleted server. ,
Format: date-time ,
Required: False ,
}
string ,
originalId:
{
Description: The original ID of the server before deletion. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedServers_Recover (new)
Description :  Recovers a deleted server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/deletedServers/{deletedServerName}/recover
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
deletedServerName:
{
Description: The name of the deleted server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted server. ,
Required: False ,
}
string ,
deletionTime:
{
Description: The deletion time of the deleted server. ,
Format: date-time ,
Required: False ,
}
string ,
originalId:
{
Description: The original ID of the server before deletion. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DistributedAvailabilityGroups_ListByInstance (new)
Description :  Gets a list of a distributed availability groups in instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DistributedAvailabilityGroups_Get (new)
Description :  Gets a distributed availability group info.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DistributedAvailabilityGroups_CreateOrUpdate (new)
Description :  Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
parameters:
{
Description: The distributed availability group info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
DistributedAvailabilityGroups_Delete (new)
Description :  Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
DistributedAvailabilityGroups_Update (new)
Description :  Updates a distributed availability group replication mode.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
parameters:
{
Description: The distributed availability group info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DistributedAvailabilityGroups_Failover (new)
Description :  Performs requested failover type in this distributed availability group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
parameters:
{
Description: The distributed availability group failover request parameters. ,
Required: True ,
}
{
failoverType:
{
Description: The failover type, can be ForcedAllowDataLoss or Planned. ,
Enum:
{
ForcedAllowDataLoss: No description available. ,
Planned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
DistributedAvailabilityGroups_SetRole (new)
Description :  Sets the role for managed instance in a distributed availability group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}/setRole
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
distributedAvailabilityGroupName:
{
Description: The distributed availability group name. ,
Required: True ,
}
string ,
parameters:
{
Description: The distributed availability group set role request parameters. ,
Required: True ,
}
{
instanceRole:
{
Description: New role of managed instance in a distributed availability group, can be Primary or Secondary. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
roleChangeType:
{
Description: The type of the role change, can be Planned or Forced. ,
Enum:
{
Forced: No description available. ,
Planned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
distributedAvailabilityGroupName:
{
Description: Name of the distributed availability group ,
Required: False ,
}
string ,
distributedAvailabilityGroupId:
{
Description: ID of the distributed availability group ,
Format: uuid ,
Required: False ,
}
string ,
replicationMode:
{
Description: Replication mode of the link ,
Enum:
{
Async: No description available. ,
Sync: No description available. ,
}
,
Required: False ,
}
enum ,
partnerLinkRole:
{
Description: SQL server side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
partnerAvailabilityGroupName:
{
Description: SQL server side availability group name ,
Required: False ,
}
string ,
partnerEndpoint:
{
Description: SQL server side endpoint - IP or DNS resolvable name ,
Required: False ,
}
string ,
instanceLinkRole:
{
Description: Managed instance side link role ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
instanceAvailabilityGroupName:
{
Description: Managed instance side availability group name ,
Required: False ,
}
string ,
failoverMode:
{
Description: The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
seedingMode:
{
Description: Database seeding mode – can be Automatic (default), or Manual for supported scenarios. ,
Enum:
{
Automatic: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
databases:
{
Description: Databases in the distributed availability group ,
Required: False ,
}
[
{
databaseName:
{
Description: The name of the database in link ,
Required: False ,
}
string ,
instanceReplicaId:
{
Description: Managed instance replica id ,
Format: uuid ,
Required: False ,
}
string ,
partnerReplicaId:
{
Description: SQL server replica id ,
Format: uuid ,
Required: False ,
}
string ,
replicaState:
{
Description: Current link state ,
Required: False ,
}
string ,
seedingProgress:
{
Description: Seeding progress ,
Required: False ,
}
string ,
synchronizationHealth:
{
Description: Link health state ,
Enum:
{
NOT_HEALTHY: No description available. ,
PARTIALLY_HEALTHY: No description available. ,
HEALTHY: No description available. ,
}
,
Required: False ,
}
enum ,
connectedState:
{
Description: Link connected state ,
Enum:
{
DISCONNECTED: No description available. ,
CONNECTED: No description available. ,
}
,
Required: False ,
}
enum ,
lastReceivedLsn:
{
Description: Last received LSN ,
Required: False ,
}
string ,
lastReceivedTime:
{
Description: Last received LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastSentLsn:
{
Description: Last sent LSN ,
Required: False ,
}
string ,
lastSentTime:
{
Description: Last sent LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastCommitLsn:
{
Description: Last commit LSN ,
Required: False ,
}
string ,
lastCommitTime:
{
Description: Last commit LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastHardenedLsn:
{
Description: Last hardened LSN ,
Required: False ,
}
string ,
lastHardenedTime:
{
Description: Last hardened LSN time ,
Format: date-time ,
Required: False ,
}
string ,
lastBackupLsn:
{
Description: Last backup LSN ,
Required: False ,
}
string ,
lastBackupTime:
{
Description: Last backup LSN time ,
Format: date-time ,
Required: False ,
}
string ,
mostRecentLinkError:
{
Description: The most recent link connection error description ,
Required: False ,
}
string ,
partnerAuthCertValidity:
{
Description: SQL server certificate validity ,
Required: False ,
}
{
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
expiryDate:
{
Description: The certificate expiry date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
instanceSendReplicationLagSeconds:
{
Description: Replication lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
instanceRedoReplicationLagSeconds:
{
Description: Redo lag when Managed Instance link side is primary ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ElasticPoolOperations_ListByElasticPool (new)
Description :  Gets a list of operations performed on the elastic pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/operations
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
elasticPoolName:
{
Description: The name of the elastic pool the operation is being performed on. ,
Required: False ,
}
string ,
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the operation completed. ,
Format: int32 ,
Required: False ,
}
integer ,
serverName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Required: False ,
}
string ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
estimatedCompletionTime:
{
Description: The estimated completion time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Whether the operation can be cancelled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticPoolOperations_Cancel (new)
Description :  Cancels the asynchronous operation on the elastic pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/operations/{operationId}/cancel
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Required: True ,
}
string ,
operationId:
{
Description: The operation identifier. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticPools_ListByServer (new)
Description :  Gets all elastic pools in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticPools_Get (new)
Description :  Gets an elastic pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ElasticPools_CreateOrUpdate (new)
Description :  Creates or updates an elastic pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool. ,
Required: True ,
}
string ,
parameters:
{
Description: The elastic pool parameters. ,
Required: True ,
}
{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ElasticPools_Delete (new)
Description :  Deletes an elastic pool.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ElasticPools_Update (new)
Description :  Updates an elastic pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool. ,
Required: True ,
}
string ,
parameters:
{
Description: The elastic pool update parameters. ,
Required: True ,
}
{
sku:
{
Description: An ARM Resource SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The elastic pool SKU. The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command: ```azurecli az sql elastic-pool list-editions -l -o table ```` ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: Kind of elastic pool. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the elastic pool. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of the elastic pool (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The storage limit for the database elastic pool in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
minCapacity:
{
Description: Minimal capacity that serverless pool will not shrink below, if not paused ,
Format: double ,
Required: False ,
}
number ,
perDatabaseSettings:
{
Description: The per database settings for the elastic pool. ,
Required: False ,
}
{
minCapacity:
{
Description: The minimum capacity all databases are guaranteed. ,
Format: double ,
Required: False ,
}
number ,
maxCapacity:
{
Description: The maximum capacity any one database can consume. ,
Format: double ,
Required: False ,
}
number ,
autoPauseDelay:
{
Description: Auto Pause Delay for per database within pool ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
zoneRedundant:
{
Description: Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones. ,
Required: False ,
}
boolean ,
licenseType:
{
Description: The license type to apply for this elastic pool. ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceConfigurationId:
{
Description: Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur. ,
Required: False ,
}
string ,
highAvailabilityReplicaCount:
{
Description: The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools. ,
Format: int32 ,
Required: False ,
}
integer ,
autoPauseDelay:
{
Description: Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled ,
Format: int32 ,
Required: False ,
}
integer ,
preferredEnclaveType:
{
Description: Type of enclave requested on the elastic pool. ,
Enum:
{
Default: No description available. ,
VBS: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZone:
{
Description: Specifies the availability zone the pool's primary replica is pinned to. ,
Enum:
{
NoPreference: No description available. ,
1: No description available. ,
2: No description available. ,
3: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ElasticPools_Failover (new)
Description :  Failovers an elastic pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
elasticPoolName:
{
Description: The name of the elastic pool to failover. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
EncryptionProtectors_ListByServer (new)
Description :  Gets a list of server encryption protectors
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the encryption protector. ,
Required: False ,
}
string ,
serverKeyName:
{
Description: The name of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EncryptionProtectors_Get (new)
Description :  Gets a server encryption protector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/{encryptionProtectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the encryption protector. ,
Required: False ,
}
string ,
serverKeyName:
{
Description: The name of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EncryptionProtectors_CreateOrUpdate (new)
Description :  Updates an existing encryption protector.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/{encryptionProtectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested encryption protector resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the encryption protector. ,
Required: False ,
}
string ,
serverKeyName:
{
Description: The name of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the encryption protector. ,
Required: False ,
}
string ,
serverKeyName:
{
Description: The name of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
EncryptionProtectors_Revalidate (new)
Description :  Revalidates an existing encryption protector.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/{encryptionProtectorName}/revalidate
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
EndpointCertificates_ListByInstance (new)
Description :  List certificates used on endpoints on the target instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/endpointCertificates
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EndpointCertificates_Get (new)
Description :  Gets a certificate used on the endpoint with the given id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/endpointCertificates/{endpointType}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
endpointType:
{
Description: Type of the endpoint whose certificate the customer is looking for. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_ListByServer (new)
Description :  Lists the failover groups in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_Get (new)
Description :  Gets a failover group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FailoverGroups_CreateOrUpdate (new)
Description :  Creates or updates a failover group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
parameters:
{
Description: The failover group parameters. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
FailoverGroups_Delete (new)
Description :  Deletes a failover group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
FailoverGroups_Update (new)
Description :  Updates a failover group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
parameters:
{
Description: The failover group parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
FailoverGroups_Failover (new)
Description :  Fails over from the current primary server to this server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
FailoverGroups_ForceFailoverAllowDataLoss (new)
Description :  Fails over from the current primary server to this server. This operation might result in data loss.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}/forceFailoverAllowDataLoss
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server containing the failover group. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
FailoverGroups_TryPlannedBeforeForcedFailover (new)
Description :  Fails over from the current primary server to this server. This operation tries planned before forced failover but might still result in data loss.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}/tryPlannedBeforeForcedFailover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
targetServer:
{
Description: The target partner server where the read-only endpoint points to. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerServers:
{
Description: List of partner server information for the failover group. ,
Required: True ,
}
[
{
id:
{
Description: Resource identifier of the partner server. ,
Format: arm-id ,
Required: True ,
}
string ,
location:
{
Description: Geo location of the partner server. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner server. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
databases:
{
Description: List of databases in the failover group. ,
Required: False ,
}
[
string ,
]
,
secondaryType:
{
Description: Databases secondary type on partner server. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
FirewallRules_ListByServer (new)
Description :  Gets a list of firewall rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_Replace (new)
Description :  Replaces all firewall rules on the server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
values:
{
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{}
FirewallRules_Get (new)
Description :  Gets a firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FirewallRules_CreateOrUpdate (new)
Description :  Creates or updates a firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating a firewall rule. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIpAddress:
{
Description: The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
endIpAddress:
{
Description: The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses. ,
Required: False ,
}
string ,
}
,
}
FirewallRules_Delete (new)
Description :  Deletes a firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/firewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
GeoBackupPolicies_List (new)
Description :  Gets a list of Geo backup policies for the given database resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
location:
{
Description: Backup policy location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of geo backup policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the geo backup policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageType:
{
Description: The storage type of the geo backup policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GeoBackupPolicies_Get (new)
Description :  Gets a Geo backup policy for the given database resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/{geoBackupPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
geoBackupPolicyName:
{
Description: The name of the Geo backup policy. This should always be 'Default'. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Backup policy location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of geo backup policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the geo backup policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageType:
{
Description: The storage type of the geo backup policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GeoBackupPolicies_CreateOrUpdate (new)
Description :  Create or update a database default Geo backup policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/{geoBackupPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
geoBackupPolicyName:
{
Description: The name of the Geo backup policy. This should always be 'Default'. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating the geo backup policy. ,
Required: True ,
}
{
location:
{
Description: Backup policy location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of geo backup policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the geo backup policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageType:
{
Description: The storage type of the geo backup policy. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Backup policy location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of geo backup policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the geo backup policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageType:
{
Description: The storage type of the geo backup policy. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
location:
{
Description: Backup policy location. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of geo backup policy. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of the geo backup policy. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageType:
{
Description: The storage type of the geo backup policy. ,
Required: False ,
}
string ,
}
,
}
IPv6FirewallRules_ListByServer (new)
Description :  Gets a list of IPv6 firewall rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/ipv6FirewallRules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIPv6Address:
{
Description: The start IP address of the firewall rule. Must be IPv6 format. ,
Required: False ,
}
string ,
endIPv6Address:
{
Description: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpv6Address. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IPv6FirewallRules_Get (new)
Description :  Gets an IPv6 firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/ipv6FirewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIPv6Address:
{
Description: The start IP address of the firewall rule. Must be IPv6 format. ,
Required: False ,
}
string ,
endIPv6Address:
{
Description: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpv6Address. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IPv6FirewallRules_CreateOrUpdate (new)
Description :  Creates or updates an IPv6 firewall rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/ipv6FirewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating an IPv6 firewall rule. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIPv6Address:
{
Description: The start IP address of the firewall rule. Must be IPv6 format. ,
Required: False ,
}
string ,
endIPv6Address:
{
Description: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpv6Address. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIPv6Address:
{
Description: The start IP address of the firewall rule. Must be IPv6 format. ,
Required: False ,
}
string ,
endIPv6Address:
{
Description: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpv6Address. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
startIPv6Address:
{
Description: The start IP address of the firewall rule. Must be IPv6 format. ,
Required: False ,
}
string ,
endIPv6Address:
{
Description: The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpv6Address. ,
Required: False ,
}
string ,
}
,
}
IPv6FirewallRules_Delete (new)
Description :  Deletes an IPv6 firewall rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/ipv6FirewallRules/{firewallRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
firewallRuleName:
{
Description: The name of the firewall rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
InstanceFailoverGroups_ListByLocation (new)
Description :  Lists the failover groups in a location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InstanceFailoverGroups_Get (new)
Description :  Gets a failover group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InstanceFailoverGroups_CreateOrUpdate (new)
Description :  Creates or updates a failover group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
parameters:
{
Description: The failover group parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InstanceFailoverGroups_Delete (new)
Description :  Deletes a failover group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
InstanceFailoverGroups_Failover (new)
Description :  Fails over from the current primary managed instance to this managed instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
InstanceFailoverGroups_ForceFailoverAllowDataLoss (new)
Description :  Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/forceFailoverAllowDataLoss
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
failoverGroupName:
{
Description: The name of the failover group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
secondaryType:
{
Description: Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. ,
Enum:
{
Geo: No description available. ,
Standby: No description available. ,
}
,
Required: False ,
}
enum ,
readWriteEndpoint:
{
Description: Read-write endpoint of the failover group instance. ,
Required: True ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: True ,
}
enum ,
failoverWithDataLossGracePeriodMinutes:
{
Description: Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
readOnlyEndpoint:
{
Description: Read-only endpoint of the failover group instance. ,
Required: False ,
}
{
failoverPolicy:
{
Description: Failover policy of the read-only endpoint for the failover group. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
replicationRole:
{
Description: Local replication role of the failover group instance. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
replicationState:
{
Description: Replication state of the failover group instance. ,
Required: False ,
}
string ,
partnerRegions:
{
Description: Partner region information for the failover group. ,
Required: True ,
}
[
{
location:
{
Description: Geo location of the partner managed instances. ,
Required: False ,
}
string ,
replicationRole:
{
Description: Replication role of the partner managed instances. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
managedInstancePairs:
{
Description: List of managed instance pairs in the failover group. ,
Required: True ,
}
[
{
primaryManagedInstanceId:
{
Description: Id of Primary Managed Instance in pair. ,
Required: False ,
}
string ,
partnerManagedInstanceId:
{
Description: Id of Partner Managed Instance in pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
InstancePools_List (new)
Description :  Gets a list of all instance pools in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools
{
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InstancePools_ListByResourceGroup (new)
Description :  Gets a list of instance pools in the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InstancePools_Get (new)
Description :  Gets an instance pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The name of the instance pool to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InstancePools_CreateOrUpdate (new)
Description :  Creates or updates an instance pool.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The name of the instance pool to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested instance pool resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
InstancePools_Delete (new)
Description :  Deletes an instance pool
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The name of the instance pool to be deleted ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
InstancePools_Update (new)
Description :  Updates an instance pool.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The name of the instance pool to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested instance pool resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Resource ID of the subnet to place this instance pool in. ,
Required: True ,
}
string ,
vCores:
{
Description: Count of vCores belonging to this instance pool. ,
Format: int32 ,
Required: True ,
}
integer ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: True ,
}
enum ,
dnsZone:
{
Description: The Dns Zone that the managed instance pool is in. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
JobAgents_ListByServer (new)
Description :  Gets a list of job agents in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobAgents_Get (new)
Description :  Gets a job agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobAgents_CreateOrUpdate (new)
Description :  Creates or updates a job agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested job agent resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
JobAgents_Delete (new)
Description :  Deletes a job agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
JobAgents_Update (new)
Description :  Updates a job agent.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The update to the job agent. ,
Required: True ,
}
{
identity:
{
Description: Managed identity assigned to job agent ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the job agent. ,
Required: False ,
}
{
tenantId:
{
Description: The job agent identity tenant id ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The job agent identity type ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssignedUserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseId:
{
Description: Resource ID of the database to store job metadata in. ,
Format: arm-id ,
Required: True ,
}
string ,
state:
{
Description: The state of the job agent. ,
Enum:
{
Creating: No description available. ,
Ready: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
JobCredentials_ListByAgent (new)
Description :  Gets a list of jobs credentials.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
username:
{
Description: The credential user name. ,
Required: True ,
}
string ,
password:
{
Description: The credential password. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobCredentials_Get (new)
Description :  Gets a jobs credential.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
credentialName:
{
Description: The name of the credential. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
username:
{
Description: The credential user name. ,
Required: True ,
}
string ,
password:
{
Description: The credential password. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobCredentials_CreateOrUpdate (new)
Description :  Creates or updates a job credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
credentialName:
{
Description: The name of the credential. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested job credential state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
username:
{
Description: The credential user name. ,
Required: True ,
}
string ,
password:
{
Description: The credential password. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
username:
{
Description: The credential user name. ,
Required: True ,
}
string ,
password:
{
Description: The credential password. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
username:
{
Description: The credential user name. ,
Required: True ,
}
string ,
password:
{
Description: The credential password. ,
Required: True ,
}
string ,
}
,
}
JobCredentials_Delete (new)
Description :  Deletes a job credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
credentialName:
{
Description: The name of the credential. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
JobExecutions_ListByAgent (new)
Description :  Lists all executions in a job agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
createTimeMin:
{
Description: If specified, only job executions created at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
createTimeMax:
{
Description: If specified, only job executions created before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMin:
{
Description: If specified, only job executions completed at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMax:
{
Description: If specified, only job executions completed before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
isActive:
{
Description: If specified, only active or only completed job executions are included. ,
Required: False ,
}
boolean ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobExecutions_ListByJob (new)
Description :  Lists a job's executions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
createTimeMin:
{
Description: If specified, only job executions created at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
createTimeMax:
{
Description: If specified, only job executions created before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMin:
{
Description: If specified, only job executions completed at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMax:
{
Description: If specified, only job executions completed before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
isActive:
{
Description: If specified, only active or only completed job executions are included. ,
Required: False ,
}
boolean ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobExecutions_Get (new)
Description :  Gets a job execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobExecutions_CreateOrUpdate (new)
Description :  Creates or updates a job execution.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The job execution id to create the job execution under. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
JobExecutions_Cancel (new)
Description :  Requests cancellation of a job execution.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/cancel
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The id of the job execution to cancel. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobExecutions_Create (new)
Description :  Starts an elastic job execution.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/start
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
JobPrivateEndpoints_ListByAgent (new)
Description :  Gets a list of job agent private endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetServerAzureResourceId:
{
Description: ARM resource id of the server the private endpoint will target. ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Private endpoint id of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobPrivateEndpoints_Get (new)
Description :  Gets a private endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints/{privateEndpointName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
privateEndpointName:
{
Description: The name of the private endpoint to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetServerAzureResourceId:
{
Description: ARM resource id of the server the private endpoint will target. ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Private endpoint id of the private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobPrivateEndpoints_CreateOrUpdate (new)
Description :  Creates or updates a private endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints/{privateEndpointName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
privateEndpointName:
{
Description: The name of the private endpoint. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested private endpoint state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetServerAzureResourceId:
{
Description: ARM resource id of the server the private endpoint will target. ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Private endpoint id of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetServerAzureResourceId:
{
Description: ARM resource id of the server the private endpoint will target. ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Private endpoint id of the private endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetServerAzureResourceId:
{
Description: ARM resource id of the server the private endpoint will target. ,
Format: arm-id ,
Required: True ,
}
string ,
privateEndpointId:
{
Description: Private endpoint id of the private endpoint. ,
Required: False ,
}
string ,
}
,
}
JobPrivateEndpoints_Delete (new)
Description :  Deletes a private endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints/{privateEndpointName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
privateEndpointName:
{
Description: The name of the private endpoint to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
JobStepExecutions_ListByJobExecution (new)
Description :  Lists the step executions of a job execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
createTimeMin:
{
Description: If specified, only job executions created at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
createTimeMax:
{
Description: If specified, only job executions created before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMin:
{
Description: If specified, only job executions completed at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMax:
{
Description: If specified, only job executions completed before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
isActive:
{
Description: If specified, only active or only completed job executions are included. ,
Required: False ,
}
boolean ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobStepExecutions_Get (new)
Description :  Gets a step execution of a job execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The unique id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the step. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobSteps_ListByJob (new)
Description :  Gets all job steps for a job's current version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobSteps_Get (new)
Description :  Gets a job step in a job's current version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the job step. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobSteps_CreateOrUpdate (new)
Description :  Creates or updates a job step. This will implicitly create a new job version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the job step. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested state of the job step. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
JobSteps_Delete (new)
Description :  Deletes a job step. This will implicitly create a new job version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the job step to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
JobSteps_ListByVersion (new)
Description :  Gets all job steps in the specified job version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobVersion:
{
Description: The version of the job to get. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobSteps_GetByVersion (new)
Description :  Gets the specified version of a job step.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps/{stepName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
jobVersion:
{
Description: The version of the job to get. ,
Format: int32 ,
Required: True ,
}
integer ,
stepName:
{
Description: The name of the job step. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
stepId:
{
Description: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified. ,
Format: int32 ,
Required: False ,
}
integer ,
targetGroup:
{
Description: The resource ID of the target group that the job step will be executed on. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the job credential that will be used to connect to the targets. ,
Required: False ,
}
string ,
action:
{
Description: The action payload of the job step. ,
Required: True ,
}
{
type:
{
Description: Type of action being executed by the job step. ,
Enum:
{
TSql: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: The source of the action to execute. ,
Enum:
{
Inline: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The action value, for example the text of the T-SQL script to execute. ,
Required: True ,
}
string ,
}
,
output:
{
Description: Output destination properties of the job step. ,
Required: False ,
}
{
type:
{
Description: The output destination type. ,
Enum:
{
SqlDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The output destination subscription id. ,
Format: uuid ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: The output destination resource group. ,
Required: False ,
}
string ,
serverName:
{
Description: The output destination server name. ,
Required: True ,
}
string ,
databaseName:
{
Description: The output destination database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The output destination schema. ,
Required: False ,
}
string ,
tableName:
{
Description: The output destination table. ,
Required: True ,
}
string ,
credential:
{
Description: The resource ID of the credential to use to connect to the output destination. ,
Required: False ,
}
string ,
}
,
executionOptions:
{
Description: Execution options for the job step. ,
Required: False ,
}
{
timeoutSeconds:
{
Description: Execution timeout for the job step. ,
Format: int32 ,
Required: False ,
}
integer ,
retryAttempts:
{
Description: Maximum number of times the job step will be reattempted if the first attempt fails. ,
Format: int32 ,
Required: False ,
}
integer ,
initialRetryIntervalSeconds:
{
Description: Initial delay between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumRetryIntervalSeconds:
{
Description: The maximum amount of time to wait between retries for job step execution. ,
Format: int32 ,
Required: False ,
}
integer ,
retryIntervalBackoffMultiplier:
{
Description: The backoff multiplier for the time between retries. ,
Format: float ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetExecutions_ListByStep (new)
Description :  Lists the target executions of a job step execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the step. ,
Required: True ,
}
string ,
createTimeMin:
{
Description: If specified, only job executions created at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
createTimeMax:
{
Description: If specified, only job executions created before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMin:
{
Description: If specified, only job executions completed at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMax:
{
Description: If specified, only job executions completed before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
isActive:
{
Description: If specified, only active or only completed job executions are included. ,
Required: False ,
}
boolean ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetExecutions_Get (new)
Description :  Gets a target execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The unique id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
stepName:
{
Description: The name of the step. ,
Required: True ,
}
string ,
targetId:
{
Description: The target id. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetExecutions_ListByJobExecution (new)
Description :  Lists target executions for all steps of a job execution.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/targets
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
jobExecutionId:
{
Description: The id of the job execution ,
Format: uuid ,
Required: True ,
}
string ,
createTimeMin:
{
Description: If specified, only job executions created at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
createTimeMax:
{
Description: If specified, only job executions created before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMin:
{
Description: If specified, only job executions completed at or after the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeMax:
{
Description: If specified, only job executions completed before the specified time are included. ,
Format: date-time ,
Required: False ,
}
string ,
isActive:
{
Description: If specified, only active or only completed job executions are included. ,
Required: False ,
}
boolean ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
jobVersion:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
stepName:
{
Description: The job step name. ,
Required: False ,
}
string ,
stepId:
{
Description: The job step id. ,
Format: int32 ,
Required: False ,
}
integer ,
jobExecutionId:
{
Description: The unique identifier of the job execution. ,
Format: uuid ,
Required: False ,
}
string ,
lifecycle:
{
Description: The detailed state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
WaitingForChildJobExecutions: No description available. ,
WaitingForRetry: No description available. ,
Succeeded: No description available. ,
SucceededWithSkipped: No description available. ,
Failed: No description available. ,
TimedOut: No description available. ,
Canceled: No description available. ,
Skipped: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The ARM provisioning state of the job execution. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: The time that the job execution was created. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time that the job execution started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time that the job execution completed. ,
Format: date-time ,
Required: False ,
}
string ,
currentAttempts:
{
Description: Number of times the job execution has been attempted. ,
Format: int32 ,
Required: False ,
}
integer ,
currentAttemptStartTime:
{
Description: Start time of the current attempt. ,
Format: date-time ,
Required: False ,
}
string ,
lastMessage:
{
Description: The last status or error message. ,
Required: False ,
}
string ,
target:
{
Description: The target that this execution is executed on. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: False ,
}
enum ,
serverName:
{
Description: The server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The database name. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetGroups_ListByAgent (new)
Description :  Gets all target groups in an agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
members:
{
Description: Members of the target group. ,
Required: True ,
}
[
{
membershipType:
{
Description: Whether the target is included or excluded from the group. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The target type. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: True ,
}
enum ,
serverName:
{
Description: The target server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The target database name. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The target elastic pool name. ,
Required: False ,
}
string ,
shardMapName:
{
Description: The target shard map. ,
Required: False ,
}
string ,
refreshCredential:
{
Description: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetGroups_Get (new)
Description :  Gets a target group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
targetGroupName:
{
Description: The name of the target group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
members:
{
Description: Members of the target group. ,
Required: True ,
}
[
{
membershipType:
{
Description: Whether the target is included or excluded from the group. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The target type. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: True ,
}
enum ,
serverName:
{
Description: The target server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The target database name. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The target elastic pool name. ,
Required: False ,
}
string ,
shardMapName:
{
Description: The target shard map. ,
Required: False ,
}
string ,
refreshCredential:
{
Description: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobTargetGroups_CreateOrUpdate (new)
Description :  Creates or updates a target group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
targetGroupName:
{
Description: The name of the target group. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested state of the target group. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
members:
{
Description: Members of the target group. ,
Required: True ,
}
[
{
membershipType:
{
Description: Whether the target is included or excluded from the group. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The target type. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: True ,
}
enum ,
serverName:
{
Description: The target server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The target database name. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The target elastic pool name. ,
Required: False ,
}
string ,
shardMapName:
{
Description: The target shard map. ,
Required: False ,
}
string ,
refreshCredential:
{
Description: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
members:
{
Description: Members of the target group. ,
Required: True ,
}
[
{
membershipType:
{
Description: Whether the target is included or excluded from the group. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The target type. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: True ,
}
enum ,
serverName:
{
Description: The target server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The target database name. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The target elastic pool name. ,
Required: False ,
}
string ,
shardMapName:
{
Description: The target shard map. ,
Required: False ,
}
string ,
refreshCredential:
{
Description: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
members:
{
Description: Members of the target group. ,
Required: True ,
}
[
{
membershipType:
{
Description: Whether the target is included or excluded from the group. ,
Enum:
{
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The target type. ,
Enum:
{
TargetGroup: No description available. ,
SqlDatabase: No description available. ,
SqlElasticPool: No description available. ,
SqlShardMap: No description available. ,
SqlServer: No description available. ,
}
,
Required: True ,
}
enum ,
serverName:
{
Description: The target server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: The target database name. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The target elastic pool name. ,
Required: False ,
}
string ,
shardMapName:
{
Description: The target shard map. ,
Required: False ,
}
string ,
refreshCredential:
{
Description: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
JobTargetGroups_Delete (new)
Description :  Deletes a target group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
targetGroupName:
{
Description: The name of the target group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
JobVersions_ListByJob (new)
Description :  Gets all versions of a job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobVersions_Get (new)
Description :  Gets a job version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job. ,
Required: True ,
}
string ,
jobVersion:
{
Description: The version of the job to get. ,
Format: int32 ,
Required: True ,
}
integer ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A job version. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_ListByAgent (new)
Description :  Gets a list of jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: User-defined description of the job. ,
Required: False ,
}
string ,
version:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
schedule:
{
Description: Schedule properties of the job. ,
Required: False ,
}
{
startTime:
{
Description: Schedule start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Schedule end time. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Schedule interval type ,
Enum:
{
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether or not the schedule is enabled. ,
Required: False ,
}
boolean ,
interval:
{
Description: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Get (new)
Description :  Gets a job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: User-defined description of the job. ,
Required: False ,
}
string ,
version:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
schedule:
{
Description: Schedule properties of the job. ,
Required: False ,
}
{
startTime:
{
Description: Schedule start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Schedule end time. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Schedule interval type ,
Enum:
{
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether or not the schedule is enabled. ,
Required: False ,
}
boolean ,
interval:
{
Description: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_CreateOrUpdate (new)
Description :  Creates or updates a job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to get. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested job state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: User-defined description of the job. ,
Required: False ,
}
string ,
version:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
schedule:
{
Description: Schedule properties of the job. ,
Required: False ,
}
{
startTime:
{
Description: Schedule start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Schedule end time. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Schedule interval type ,
Enum:
{
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether or not the schedule is enabled. ,
Required: False ,
}
boolean ,
interval:
{
Description: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: User-defined description of the job. ,
Required: False ,
}
string ,
version:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
schedule:
{
Description: Schedule properties of the job. ,
Required: False ,
}
{
startTime:
{
Description: Schedule start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Schedule end time. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Schedule interval type ,
Enum:
{
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether or not the schedule is enabled. ,
Required: False ,
}
boolean ,
interval:
{
Description: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: User-defined description of the job. ,
Required: False ,
}
string ,
version:
{
Description: The job version number. ,
Format: int32 ,
Required: False ,
}
integer ,
schedule:
{
Description: Schedule properties of the job. ,
Required: False ,
}
{
startTime:
{
Description: Schedule start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Schedule end time. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Schedule interval type ,
Enum:
{
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether or not the schedule is enabled. ,
Required: False ,
}
boolean ,
interval:
{
Description: Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. ,
Required: False ,
}
string ,
}
,
}
,
}
Jobs_Delete (new)
Description :  Deletes a job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
jobAgentName:
{
Description: The name of the job agent. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
LedgerDigestUploads_ListByDatabase (new)
Description :  Gets all ledger digest upload settings on a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LedgerDigestUploads_Get (new)
Description :  Gets the current ledger digest upload configuration for a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LedgerDigestUploads_CreateOrUpdate (new)
Description :  Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LedgerDigestUploads_Disable (new)
Description :  Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}/disable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Capabilities_ListByLocation (new)
Description :  Gets the subscription capabilities available for the specified location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/capabilities
{
locationName:
{
Description: The location name whose capabilities are retrieved. ,
Required: True ,
}
string ,
include:
{
Description: If specified, restricts the response to only include the selected item. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The location name. ,
Required: False ,
}
string ,
supportedServerVersions:
{
Description: The list of supported server versions. ,
Required: False ,
}
[
{
name:
{
Description: The server version name. ,
Required: False ,
}
string ,
supportedEditions:
{
Description: The list of supported database editions. ,
Required: False ,
}
[
{
name:
{
Description: The database edition name. ,
Required: False ,
}
string ,
supportedServiceLevelObjectives:
{
Description: The list of supported service objectives for the edition. ,
Required: False ,
}
[
{
id:
{
Description: The unique ID of the service objective. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The service objective name. ,
Required: False ,
}
string ,
supportedMaxSizes:
{
Description: The list of supported maximum database sizes. ,
Required: False ,
}
[
{
minValue:
{
Description: Minimum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maxValue:
{
Description: Maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
logSize:
{
Description: Size of transaction log. ,
Required: False ,
}
{
limit:
{
Description: The log size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
Percent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
performanceLevel:
{
Description: The performance level. ,
Required: False ,
}
{
value:
{
Description: Performance level value. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit type used to measure performance level. ,
Enum:
{
DTU: No description available. ,
VCores: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportedLicenseTypes:
{
Description: List of supported license types. ,
Required: False ,
}
[
{
name:
{
Description: License type identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
includedMaxSize:
{
Description: The included (free) max size. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the service objective. ,
Required: False ,
}
boolean ,
supportedAutoPauseDelay:
{
Description: Supported time range for auto pause delay ,
Required: False ,
}
{
minValue:
{
Description: Minimum value ,
Format: int32 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value ,
Format: int32 ,
Required: False ,
}
integer ,
stepSize:
{
Description: Step value for discrete values between the minimum value and the maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default value is no value is provided ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: Unit of time that delay is expressed in ,
Enum:
{
Minutes: No description available. ,
}
,
Required: False ,
}
enum ,
doNotPauseValue:
{
Description: Value that is used to not pause (infinite delay before pause) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportedMinCapacities:
{
Description: List of supported min capacities ,
Required: False ,
}
[
{
value:
{
Description: Min capacity value ,
Format: double ,
Required: False ,
}
number ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
computeModel:
{
Description: The compute model ,
Required: False ,
}
string ,
supportedMaintenanceConfigurations:
{
Description: List of supported maintenance configurations ,
Required: False ,
}
[
{
name:
{
Description: Maintenance configuration name ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the maintenance configuration. ,
Required: False ,
}
boolean ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
zonePinning:
{
Description: Whether or not zone pinning is supported. ,
Required: False ,
}
boolean ,
supportedZones:
{
Description: List of supported availability zones ,
Required: False ,
}
[
{
availabilityZone:
{
Description: Name of the availability zone ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedFreeLimitExhaustionBehaviors:
{
Description: List of supported free limit exhaustion behaviors ,
Required: False ,
}
[
{
exhaustionBehaviorType:
{
Description: Free limit exhaustion behavior type ,
Enum:
{
AutoPause: No description available. ,
BillOverUsage: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Free limit exhaustion behavior status ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the edition. ,
Required: False ,
}
boolean ,
readScale:
{
Description: The read scale capability for the edition. ,
Required: False ,
}
{
maxNumberOfReplicas:
{
Description: The maximum number of read scale replicas. ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
supportedStorageCapabilities:
{
Description: The list of supported storage capabilities for this edition ,
Required: False ,
}
[
{
storageAccountType:
{
Description: The storage account type for the database's backups. ,
Enum:
{
GRS: No description available. ,
LRS: No description available. ,
ZRS: No description available. ,
GZRS: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
zonePinning:
{
Description: Whether or not zone pinning is supported for the edition. ,
Required: False ,
}
boolean ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedElasticPoolEditions:
{
Description: The list of supported elastic pool editions. ,
Required: False ,
}
[
{
name:
{
Description: The elastic pool edition name. ,
Required: False ,
}
string ,
supportedElasticPoolPerformanceLevels:
{
Description: The list of supported elastic pool DTU levels for the edition. ,
Required: False ,
}
[
{
performanceLevel:
{
Description: The performance level for the pool. ,
Required: False ,
}
{
value:
{
Description: Performance level value. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit type used to measure performance level. ,
Enum:
{
DTU: No description available. ,
VCores: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportedLicenseTypes:
{
Description: List of supported license types. ,
Required: False ,
}
[
{
name:
{
Description: License type identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
maxDatabaseCount:
{
Description: The maximum number of databases supported. ,
Format: int32 ,
Required: False ,
}
integer ,
includedMaxSize:
{
Description: The included (free) max size for this performance level. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportedMaxSizes:
{
Description: The list of supported max sizes. ,
Required: False ,
}
[
{
minValue:
{
Description: Minimum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maxValue:
{
Description: Maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
logSize:
{
Description: Size of transaction log. ,
Required: False ,
}
{
limit:
{
Description: The log size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
Percent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedPerDatabaseMaxSizes:
{
Description: The list of supported per database max sizes. ,
Required: False ,
}
[
{
minValue:
{
Description: Minimum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maxValue:
{
Description: Maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
logSize:
{
Description: Size of transaction log. ,
Required: False ,
}
{
limit:
{
Description: The log size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
Percent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedPerDatabaseMaxPerformanceLevels:
{
Description: The list of supported per database max performance levels. ,
Required: False ,
}
[
{
limit:
{
Description: The maximum performance level per database. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit type used to measure performance level. ,
Enum:
{
DTU: No description available. ,
VCores: No description available. ,
}
,
Required: False ,
}
enum ,
supportedPerDatabaseMinPerformanceLevels:
{
Description: The list of supported min database performance levels. ,
Required: False ,
}
[
{
limit:
{
Description: The minimum performance level per database. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit type used to measure performance level. ,
Enum:
{
DTU: No description available. ,
VCores: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the performance level. ,
Required: False ,
}
boolean ,
supportedMaintenanceConfigurations:
{
Description: List of supported maintenance configurations ,
Required: False ,
}
[
{
name:
{
Description: Maintenance configuration name ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the maintenance configuration. ,
Required: False ,
}
boolean ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedMinCapacities:
{
Description: List of supported min capacities ,
Required: False ,
}
[
{
value:
{
Description: Min capacity value ,
Format: double ,
Required: False ,
}
number ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedAutoPauseDelay:
{
Description: Supported time range for auto pause delay ,
Required: False ,
}
{
minValue:
{
Description: Minimum value ,
Format: int32 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value ,
Format: int32 ,
Required: False ,
}
integer ,
stepSize:
{
Description: Step value for discrete values between the minimum value and the maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default value is no value is provided ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: Unit of time that delay is expressed in ,
Enum:
{
Minutes: No description available. ,
}
,
Required: False ,
}
enum ,
doNotPauseValue:
{
Description: Value that is used to not pause (infinite delay before pause) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportedPerDatabaseAutoPauseDelay:
{
Description: Supported time range for per database auto pause delay ,
Required: False ,
}
{
minValue:
{
Description: Minimum value ,
Format: int32 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value ,
Format: int32 ,
Required: False ,
}
integer ,
stepSize:
{
Description: Step value for discrete values between the minimum value and the maximum value. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: Default value if no value is provided ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: Unit of time that delay is expressed in ,
Enum:
{
Minutes: No description available. ,
}
,
Required: False ,
}
enum ,
doNotPauseValue:
{
Description: Value that is used to not pause (infinite delay before pause) ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
supportedZones:
{
Description: List of supported availability zones ,
Required: False ,
}
[
{
availabilityZone:
{
Description: Name of the availability zone ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the edition. ,
Required: False ,
}
boolean ,
zonePinning:
{
Description: Whether or not zone pinning is supported for the edition. ,
Required: False ,
}
boolean ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedManagedInstanceVersions:
{
Description: The list of supported managed instance versions. ,
Required: False ,
}
[
{
name:
{
Description: The server version name. ,
Required: False ,
}
string ,
supportedEditions:
{
Description: The list of supported managed instance editions. ,
Required: False ,
}
[
{
name:
{
Description: The managed server version name. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
supportedFamilies:
{
Description: The supported families. ,
Required: False ,
}
[
{
name:
{
Description: Family name. ,
Required: False ,
}
string ,
sku:
{
Description: SKU name. ,
Required: False ,
}
string ,
zoneRedundant:
{
Description: Whether or not zone redundancy is supported for the family. ,
Required: False ,
}
boolean ,
supportedLicenseTypes:
{
Description: List of supported license types. ,
Required: False ,
}
[
{
name:
{
Description: License type identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedVcoresValues:
{
Description: List of supported virtual cores values. ,
Required: False ,
}
[
{
name:
{
Description: The virtual cores identifier. ,
Required: False ,
}
string ,
value:
{
Description: The virtual cores value. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedMemoryLimitsMB:
{
Description: Memory limit MB ranges. ,
Required: False ,
}
{
minValue:
{
Description: Minimum value. ,
Format: int64 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
includedMaxSize:
{
Description: Included size. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportedStorageSizes:
{
Description: Storage size ranges. ,
Required: False ,
}
[
{
minValue:
{
Description: Minimum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
maxValue:
{
Description: Maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
logSize:
{
Description: Size of transaction log. ,
Required: False ,
}
{
limit:
{
Description: The log size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
Percent: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
includedStorageIOps:
{
Description: Included storage IOps. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageIOps:
{
Description: Storage IOps ranges. ,
Required: False ,
}
{
minValue:
{
Description: Minimum value. ,
Format: int64 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
iopsMinValueOverrideFactorPerSelectedStorageGB:
{
Description: Min IOps override factor per selected storage GB. ,
Format: double ,
Required: False ,
}
number ,
iopsIncludedValueOverrideFactorPerSelectedStorageGB:
{
Description: Included IOps override factor per selected storage GB. ,
Format: double ,
Required: False ,
}
number ,
includedStorageThroughputMBps:
{
Description: Included storage throughput MBps. ,
Format: int64 ,
Required: False ,
}
integer ,
supportedStorageThroughputMBps:
{
Description: Storage throughput MBps ranges. ,
Required: False ,
}
{
minValue:
{
Description: Minimum value. ,
Format: int64 ,
Required: False ,
}
integer ,
maxValue:
{
Description: Maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
scaleSize:
{
Description: Scale/step size for discrete values between the minimum value and the maximum value. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
throughputMBpsMinValueOverrideFactorPerSelectedStorageGB:
{
Description: Min throughput MBps override factor per selected storage GB. ,
Format: double ,
Required: False ,
}
number ,
throughputMBpsIncludedValueOverrideFactorPerSelectedStorageGB:
{
Description: Included throughput MBps override factor per selected storage GB. ,
Format: double ,
Required: False ,
}
number ,
instancePoolSupported:
{
Description: True if this service objective is supported for managed instances in an instance pool. ,
Required: False ,
}
boolean ,
standaloneSupported:
{
Description: True if this service objective is supported for standalone managed instances. ,
Required: False ,
}
boolean ,
supportedMaintenanceConfigurations:
{
Description: List of supported maintenance configurations ,
Required: False ,
}
[
{
name:
{
Description: Maintenance configuration name ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedStorageCapabilities:
{
Description: The list of supported storage capabilities for this edition ,
Required: False ,
}
[
{
storageAccountType:
{
Description: The storage account type for the database's backups. ,
Enum:
{
GRS: No description available. ,
LRS: No description available. ,
ZRS: No description available. ,
GZRS: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedInstancePoolEditions:
{
Description: The list of supported instance pool editions. ,
Required: False ,
}
[
{
name:
{
Description: The instance pool version name. ,
Required: False ,
}
string ,
supportedFamilies:
{
Description: The supported families. ,
Required: False ,
}
[
{
name:
{
Description: Family name. ,
Required: False ,
}
string ,
supportedLicenseTypes:
{
Description: List of supported license types. ,
Required: False ,
}
[
{
name:
{
Description: License type identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedVcoresValues:
{
Description: List of supported virtual cores values. ,
Required: False ,
}
[
{
name:
{
Description: The virtual cores identifier. ,
Required: False ,
}
string ,
value:
{
Description: The virtual cores value. ,
Format: int32 ,
Required: False ,
}
integer ,
storageLimit:
{
Description: Storage limit. ,
Required: False ,
}
{
limit:
{
Description: The maximum size limit (see 'unit' for the units). ,
Format: int32 ,
Required: False ,
}
integer ,
unit:
{
Description: The units that the limit is expressed in. ,
Enum:
{
Megabytes: No description available. ,
Gigabytes: No description available. ,
Terabytes: No description available. ,
Petabytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
supportedJobAgentVersions:
{
Description: The list of supported job agent versions. ,
Required: False ,
}
[
{
name:
{
Description: The job agent version name. ,
Required: False ,
}
string ,
supportedEditions:
{
Description: The list of supported editions. ,
Required: False ,
}
[
{
name:
{
Description: The job agent edition name. ,
Required: False ,
}
string ,
supportedServiceLevelObjectives:
{
Description: The list of supported service level objectives for the edition. ,
Required: False ,
}
[
{
name:
{
Description: The service objective name. ,
Required: False ,
}
string ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The status of the capability. ,
Enum:
{
Visible: No description available. ,
Available: No description available. ,
Default: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason for the capability not being available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_ListByLocation (new)
Description :  Lists the long term retention backups for a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups
{
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_ListByServer (new)
Description :  Lists the long term retention backups for a given server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups
{
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_ListByDatabase (new)
Description :  Lists all long term retention backups for a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups
{
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_Get (new)
Description :  Gets a long term retention backup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_Delete (new)
Description :  Deletes a long term retention backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}
{
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_ChangeAccessTier (new)
Description :  Change a long term retention backup access tier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/changeAccessTier
{
locationName:
{
Required: True ,
}
string ,
longTermRetentionServerName:
{
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Required: True ,
}
string ,
backupName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
backupStorageAccessTier:
{
Description: The long term retention backup storage access tier ,
Required: True ,
}
string ,
operationMode:
{
Description: The operation mode when updating ltr backup storage access tier ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_Copy (new)
Description :  Copy an existing long term retention backup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/copy
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters needed for long term retention copy request ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetSubscriptionId:
{
Description: The subscription that owns the target server ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: The resource group that owns the target server ,
Required: False ,
}
string ,
targetServerResourceId:
{
Description: The resource Id of the target server that owns the database ,
Required: False ,
}
string ,
targetServerFullyQualifiedDomainName:
{
Description: The fully qualified domain name of the target server ,
Required: False ,
}
string ,
targetDatabaseName:
{
Description: The name of the database owns the copied backup. ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Required: False ,
}
string ,
fromBackupResourceId:
{
Description: Source backup resource id ,
Required: False ,
}
string ,
toBackupResourceId:
{
Description: Target backup resource id ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
message:
{
Description: Progress message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_Update (new)
Description :  Updates an existing long term retention backup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/update
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested backup resource state ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Required: False ,
}
string ,
fromBackupResourceId:
{
Description: Source backup resource id ,
Required: False ,
}
string ,
toBackupResourceId:
{
Description: Target backup resource id ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
message:
{
Description: Progress message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_ListByResourceGroupLocation (new)
Description :  Lists the long term retention backups for a given location based on resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_ListByResourceGroupServer (new)
Description :  Lists the long term retention backups for a given server based on resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_ListByResourceGroupDatabase (new)
Description :  Lists all long term retention backups for a database based on a particular resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_GetByResourceGroup (new)
Description :  Gets a long term retention backup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionBackups_DeleteByResourceGroup (new)
Description :  Deletes a long term retention backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_ChangeAccessTierByResourceGroup (new)
Description :  Change a long term retention backup access tier.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/changeAccessTier
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Required: True ,
}
string ,
longTermRetentionServerName:
{
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Required: True ,
}
string ,
backupName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
backupStorageAccessTier:
{
Description: The long term retention backup storage access tier ,
Required: True ,
}
string ,
operationMode:
{
Description: The operation mode when updating ltr backup storage access tier ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverName:
{
Description: The server name that the backup database belong to. ,
Required: False ,
}
string ,
serverCreateTime:
{
Description: The create time of the server. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
isBackupImmutable:
{
Description: The setting whether the LTR backup is immutable ,
Required: False ,
}
boolean ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_CopyByResourceGroup (new)
Description :  Copy an existing long term retention backup to a different server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/copy
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters needed for long term retention copy request ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
targetSubscriptionId:
{
Description: The subscription that owns the target server ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: The resource group that owns the target server ,
Required: False ,
}
string ,
targetServerResourceId:
{
Description: The resource Id of the target server that owns the database ,
Required: False ,
}
string ,
targetServerFullyQualifiedDomainName:
{
Description: The fully qualified domain name of the target server ,
Required: False ,
}
string ,
targetDatabaseName:
{
Description: The name of the database owns the copied backup. ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Required: False ,
}
string ,
fromBackupResourceId:
{
Description: Source backup resource id ,
Required: False ,
}
string ,
toBackupResourceId:
{
Description: Target backup resource id ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
message:
{
Description: Progress message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionBackups_UpdateByResourceGroup (new)
Description :  Updates an existing long term retention backup.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/update
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
longTermRetentionServerName:
{
Description: The name of the server ,
Required: True ,
}
string ,
longTermRetentionDatabaseName:
{
Description: The name of the database ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested backup resource state ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestedBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
operationType:
{
Description: Operation type. ,
Required: False ,
}
string ,
fromBackupResourceId:
{
Description: Source backup resource id ,
Required: False ,
}
string ,
toBackupResourceId:
{
Description: Target backup resource id ,
Required: False ,
}
string ,
targetBackupStorageRedundancy:
{
Description: The storage redundancy type of the copied backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
message:
{
Description: Progress message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionManagedInstanceBackups_ListByLocation (new)
Description :  Lists the long term retention backups for managed databases in a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstanceBackups
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_ListByDatabase (new)
Description :  Lists all long term retention backups for a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_Get (new)
Description :  Gets a long term retention backup for a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_Delete (new)
Description :  Deletes a long term retention backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}
{
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionManagedInstanceBackups_ListByInstance (new)
Description :  Lists the long term retention backups for a given managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionManagedInstanceBackups
{
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_ListByResourceGroupLocation (new)
Description :  Lists the long term retention backups for managed databases in a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstanceBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_ListByResourceGroupDatabase (new)
Description :  Lists all long term retention backups for a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_GetByResourceGroup (new)
Description :  Gets a long term retention backup for a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionManagedInstanceBackups_DeleteByResourceGroup (new)
Description :  Deletes a long term retention backup.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionDatabases/{databaseName}/longTermRetentionManagedInstanceBackups/{backupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database. ,
Required: True ,
}
string ,
backupName:
{
Description: The backup name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
LongTermRetentionManagedInstanceBackups_ListByResourceGroupInstance (new)
Description :  Lists the long term retention backups for a given managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionManagedInstances/{managedInstanceName}/longTermRetentionManagedInstanceBackups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The location of the database. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest backup for each database. ,
Required: False ,
}
boolean ,
databaseState:
{
Description: Whether to query against just live databases, just deleted databases, or all databases. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The managed instance that the backup database belongs to. ,
Required: False ,
}
string ,
managedInstanceCreateTime:
{
Description: The create time of the instance. ,
Format: date-time ,
Required: False ,
}
string ,
databaseName:
{
Description: The name of the database the backup belong to ,
Required: False ,
}
string ,
databaseDeletionTime:
{
Description: The delete time of the database ,
Format: date-time ,
Required: False ,
}
string ,
backupTime:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
backupExpirationTime:
{
Description: The time the long term retention backup will expire. ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage redundancy type of the backup ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backup ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionPolicies_ListByDatabase (new)
Description :  Gets a database's long term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionPolicies_Get (new)
Description :  Gets a database's long term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be Default. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LongTermRetentionPolicies_CreateOrUpdate (new)
Description :  Sets a database's long term retention policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be Default. ,
Required: True ,
}
string ,
parameters:
{
Description: The long term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
MaintenanceWindowOptions_Get (new)
Description :  Gets a list of available maintenance windows.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/maintenanceWindowOptions/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to get maintenance windows options for. ,
Required: True ,
}
string ,
maintenanceWindowOptionsName:
{
Description: Maintenance window options name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Whether maintenance windows are enabled for the database. ,
Required: False ,
}
boolean ,
maintenanceWindowCycles:
{
Description: Available maintenance cycles e.g. {Saturday, 0, 48*60}, {Wednesday, 0, 24*60}. ,
Required: False ,
}
[
{
dayOfWeek:
{
Description: Day of maintenance window. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time minutes offset from 12am. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of maintenance window in minutes. ,
Required: False ,
}
string ,
}
,
]
,
minDurationInMinutes:
{
Description: Minimum duration of maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDurationInMinutes:
{
Description: Default duration for maintenance window. ,
Format: int32 ,
Required: False ,
}
integer ,
minCycles:
{
Description: Minimum number of maintenance windows cycles to be set on the database. ,
Format: int32 ,
Required: False ,
}
integer ,
timeGranularityInMinutes:
{
Description: Time granularity in minutes for maintenance windows. ,
Format: int32 ,
Required: False ,
}
integer ,
allowMultipleMaintenanceWindowsPerCycle:
{
Description: Whether we allow multiple maintenance windows per cycle. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MaintenanceWindows_Get (new)
Description :  Gets maintenance windows settings for a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/maintenanceWindows/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to get maintenance windows for. ,
Required: True ,
}
string ,
maintenanceWindowName:
{
Description: Maintenance window name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timeRanges:
{
Required: False ,
}
[
{
dayOfWeek:
{
Description: Day of maintenance window. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time minutes offset from 12am. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of maintenance window in minutes. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{}
MaintenanceWindows_CreateOrUpdate (new)
Description :  Sets maintenance windows settings for a database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/maintenanceWindows/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database to set maintenance windows for. ,
Required: True ,
}
string ,
maintenanceWindowName:
{
Description: Maintenance window name. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timeRanges:
{
Required: False ,
}
[
{
dayOfWeek:
{
Description: Day of maintenance window. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Start time minutes offset from 12am. ,
Required: False ,
}
string ,
duration:
{
Description: Duration of maintenance window in minutes. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{}
ManagedBackupShortTermRetentionPolicies_ListByDatabase (new)
Description :  Gets a managed database's short term retention policy list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedBackupShortTermRetentionPolicies_Get (new)
Description :  Gets a managed database's short term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedBackupShortTermRetentionPolicies_CreateOrUpdate (new)
Description :  Updates a managed database's short term retention policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedBackupShortTermRetentionPolicies_Update (new)
Description :  Updates a managed database's short term retention policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabaseAdvancedThreatProtectionSettings_ListByDatabase (new)
Description :  Gets a list of managed database's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/advancedThreatProtectionSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseAdvancedThreatProtectionSettings_Get (new)
Description :  Gets a managed database's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseAdvancedThreatProtectionSettings_CreateOrUpdate (new)
Description :  Creates or updates a managed database's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed database Advanced Threat Protection state. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
ManagedDatabaseColumns_ListByDatabase (new)
Description :  List managed database columns
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/columns
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schema:
{
Required: False ,
}
array ,
table:
{
Required: False ,
}
array ,
column:
{
Required: False ,
}
array ,
orderBy:
{
Required: False ,
}
array ,
$skiptoken:
{
Description: An opaque token that identifies a starting point in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseColumns_ListByTable (new)
Description :  List managed database columns
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseColumns_Get (new)
Description :  Get managed database column
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
columnType:
{
Description: The column data type. ,
Enum:
{
image: No description available. ,
text: No description available. ,
uniqueidentifier: No description available. ,
date: No description available. ,
time: No description available. ,
datetime2: No description available. ,
datetimeoffset: No description available. ,
tinyint: No description available. ,
smallint: No description available. ,
int: No description available. ,
smalldatetime: No description available. ,
real: No description available. ,
money: No description available. ,
datetime: No description available. ,
float: No description available. ,
sql_variant: No description available. ,
ntext: No description available. ,
bit: No description available. ,
decimal: No description available. ,
numeric: No description available. ,
smallmoney: No description available. ,
bigint: No description available. ,
hierarchyid: No description available. ,
geometry: No description available. ,
geography: No description available. ,
varbinary: No description available. ,
varchar: No description available. ,
binary: No description available. ,
char: No description available. ,
timestamp: No description available. ,
nvarchar: No description available. ,
nchar: No description available. ,
xml: No description available. ,
sysname: No description available. ,
}
,
Required: False ,
}
enum ,
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the column belongs to a memory optimized table. ,
Required: False ,
}
boolean ,
isComputed:
{
Description: Whether or not the column is computed. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseMoveOperations_ListByLocation (new)
Description :  Lists managed database move operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/managedDatabaseMoveOperationResults
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Required: True ,
}
string ,
onlyLatestPerDatabase:
{
Description: Whether or not to only get the latest operation for each database. Has higher priority than $filter. ,
Required: False ,
}
boolean ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
operationMode:
{
Description: Operation mode. ,
Enum:
{
Move: No description available. ,
Copy: No description available. ,
}
,
Required: False ,
}
enum ,
sourceManagedInstanceName:
{
Description: Source Managed Instance name. ,
Required: False ,
}
string ,
targetManagedInstanceName:
{
Description: Target Managed Instance name. ,
Required: False ,
}
string ,
sourceManagedInstanceId:
{
Description: Source Managed Instance resource id. ,
Required: False ,
}
string ,
targetManagedInstanceId:
{
Description: Target Managed instance resource id. ,
Required: False ,
}
string ,
sourceDatabaseName:
{
Description: Source database name. ,
Required: False ,
}
string ,
targetDatabaseName:
{
Description: Target database name. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Is move operation cancellable. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseMoveOperations_Get (new)
Description :  Gets a managed database move operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/managedDatabaseMoveOperationResults/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Required: True ,
}
string ,
operationId:
{
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
operationMode:
{
Description: Operation mode. ,
Enum:
{
Move: No description available. ,
Copy: No description available. ,
}
,
Required: False ,
}
enum ,
sourceManagedInstanceName:
{
Description: Source Managed Instance name. ,
Required: False ,
}
string ,
targetManagedInstanceName:
{
Description: Target Managed Instance name. ,
Required: False ,
}
string ,
sourceManagedInstanceId:
{
Description: Source Managed Instance resource id. ,
Required: False ,
}
string ,
targetManagedInstanceId:
{
Description: Target Managed instance resource id. ,
Required: False ,
}
string ,
sourceDatabaseName:
{
Description: Source database name. ,
Required: False ,
}
string ,
targetDatabaseName:
{
Description: Target database name. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Is move operation cancellable. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseQueries_Get (new)
Description :  Get query by query id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/queries/{queryId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
queryId:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
queryText:
{
Description: Query text. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseQueries_ListByQuery (new)
Description :  Get query execution statistics by query id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/queries/{queryId}/statistics
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
queryId:
{
Required: True ,
}
string ,
startTime:
{
Description: Start time for observed period. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for observed period. ,
Required: False ,
}
string ,
interval:
{
Description: The time step to be used to summarize the metric values. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: Database name of the database in which this query was executed. ,
Required: False ,
}
string ,
queryId:
{
Description: Unique query id (unique within one database). ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
intervals:
{
Description: List of intervals with appropriate metric data ,
Required: False ,
}
[
{
intervalStartTime:
{
Description: The start time for the metric interval (ISO-8601 format). ,
Required: False ,
}
string ,
intervalType:
{
Description: Interval type (length). ,
Enum:
{
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
executionCount:
{
Description: Execution count of a query in this interval. ,
Format: int64 ,
Required: False ,
}
integer ,
metrics:
{
Description: List of metric objects for this interval ,
Required: False ,
}
[
{
name:
{
Description: The name information for the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: The UI appropriate name for the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
percentage: No description available. ,
KB: No description available. ,
microseconds: No description available. ,
count: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the metric. ,
Format: double ,
Required: False ,
}
number ,
min:
{
Description: Metric value when min() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Metric value when max() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
avg:
{
Description: Metric value when avg() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
sum:
{
Description: Metric value when sum() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
stdev:
{
Description: Metric value when stdev aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseRestoreDetails_Get (new)
Description :  Gets managed database restore details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/restoreDetails/{restoreDetailsName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
restoreDetailsName:
{
Description: The name of the restore details to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
type:
{
Description: Restore type. ,
Required: False ,
}
string ,
status:
{
Description: Restore status. ,
Required: False ,
}
string ,
blockReason:
{
Description: The reason why restore is in Blocked state. ,
Required: False ,
}
string ,
lastUploadedFileName:
{
Description: Last uploaded file name. ,
Required: False ,
}
string ,
lastUploadedFileTime:
{
Description: Last uploaded file time. ,
Format: date-time ,
Required: False ,
}
string ,
lastRestoredFileName:
{
Description: Last restored file name. ,
Required: False ,
}
string ,
lastRestoredFileTime:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
percentCompleted:
{
Description: Percent completed. ,
Format: int32 ,
Required: False ,
}
integer ,
currentRestoredSizeMB:
{
Description: Current restored size MB. ,
Format: int32 ,
Required: False ,
}
integer ,
currentRestorePlanSizeMB:
{
Description: Current restore plan size MB. ,
Format: int32 ,
Required: False ,
}
integer ,
currentBackupType:
{
Description: Current backup type. ,
Required: False ,
}
string ,
currentRestoringFileName:
{
Description: Current restoring file name. ,
Required: False ,
}
string ,
numberOfFilesDetected:
{
Description: Number of files detected. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfFilesQueued:
{
Description: Number of files queued. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfFilesSkipped:
{
Description: Number of files skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfFilesRestoring:
{
Description: Number of files restoring. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfFilesRestored:
{
Description: Number of files restored. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfFilesUnrestorable:
{
Description: Number of files unrestorable. ,
Format: int32 ,
Required: False ,
}
integer ,
fullBackupSets:
{
Description: Full backup sets. ,
Required: False ,
}
[
{
status:
{
Description: Backup set status. ,
Required: False ,
}
string ,
firstStripeName:
{
Description: First stripe name. ,
Required: False ,
}
string ,
numberOfStripes:
{
Description: Number of stripes. ,
Format: int32 ,
Required: False ,
}
integer ,
backupSizeMB:
{
Description: Backup size. ,
Format: int32 ,
Required: False ,
}
integer ,
restoreStartedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
restoreFinishedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
diffBackupSets:
{
Description: Diff backup sets. ,
Required: False ,
}
[
{
status:
{
Description: Backup set status. ,
Required: False ,
}
string ,
firstStripeName:
{
Description: First stripe name. ,
Required: False ,
}
string ,
numberOfStripes:
{
Description: Number of stripes. ,
Format: int32 ,
Required: False ,
}
integer ,
backupSizeMB:
{
Description: Backup size. ,
Format: int32 ,
Required: False ,
}
integer ,
restoreStartedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
restoreFinishedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
logBackupSets:
{
Description: Log backup sets. ,
Required: False ,
}
[
{
status:
{
Description: Backup set status. ,
Required: False ,
}
string ,
firstStripeName:
{
Description: First stripe name. ,
Required: False ,
}
string ,
numberOfStripes:
{
Description: Number of stripes. ,
Format: int32 ,
Required: False ,
}
integer ,
backupSizeMB:
{
Description: Backup size. ,
Format: int32 ,
Required: False ,
}
integer ,
restoreStartedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
restoreFinishedTimestampUtc:
{
Description: Last restored file time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
unrestorableFiles:
{
Description: Unrestorable files. ,
Required: False ,
}
[
{
name:
{
Description: File name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSchemas_ListByDatabase (new)
Description :  List managed database schemas
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
object ,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSchemas_Get (new)
Description :  Get managed database schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A database schema resource. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSecurityAlertPolicies_ListByDatabase (new)
Description :  Gets a list of managed database's security alert policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityAlertPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the security alert policies are defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSecurityAlertPolicies_Get (new)
Description :  Gets a managed database's security alert policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the security alert policy is defined. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSecurityAlertPolicies_CreateOrUpdate (new)
Description :  Creates or updates a database's security alert policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the security alert policy is defined. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The database security alert policy. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
ManagedDatabaseSecurityEvents_ListByDatabase (new)
Description :  Gets a list of security events.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityEvents
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the security events are retrieved. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of elements in the collection to skip. ,
Format: int64 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of elements to return from the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
$skiptoken:
{
Description: An opaque token that identifies a starting point in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
eventTime:
{
Description: The time when the security event occurred. ,
Format: date-time ,
Required: False ,
}
string ,
securityEventType:
{
Description: The type of the security event. ,
Enum:
{
Undefined: No description available. ,
SqlInjectionVulnerability: No description available. ,
SqlInjectionExploit: No description available. ,
}
,
Required: False ,
}
enum ,
subscription:
{
Description: The subscription name ,
Required: False ,
}
string ,
server:
{
Description: The server name ,
Required: False ,
}
string ,
database:
{
Description: The database name ,
Required: False ,
}
string ,
clientIp:
{
Description: The IP address of the client who executed the statement. ,
Required: False ,
}
string ,
applicationName:
{
Description: The application used to execute the statement. ,
Required: False ,
}
string ,
principalName:
{
Description: The principal user who executed the statement ,
Required: False ,
}
string ,
securityEventSqlInjectionAdditionalProperties:
{
Description: The sql injection additional properties, populated only if the type of the security event is sql injection. ,
Required: False ,
}
{
threatId:
{
Description: The threat ID. ,
Required: False ,
}
string ,
statement:
{
Description: The statement ,
Required: False ,
}
string ,
statementHighlightOffset:
{
Description: The statement highlight offset ,
Format: int32 ,
Required: False ,
}
integer ,
statementHighlightLength:
{
Description: The statement highlight length ,
Format: int32 ,
Required: False ,
}
integer ,
errorCode:
{
Description: The sql error code ,
Format: int32 ,
Required: False ,
}
integer ,
errorSeverity:
{
Description: The sql error severity ,
Format: int32 ,
Required: False ,
}
integer ,
errorMessage:
{
Description: The sql error message ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_ListCurrentByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
$count:
{
Required: False ,
}
boolean ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_Update (new)
Description :  Update sensitivity labels of a given database using an operations batch.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
operations:
{
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
op:
{
Enum:
{
set: No description available. ,
remove: No description available. ,
}
,
Required: True ,
}
enum ,
schema:
{
Description: Schema name of the column to update. ,
Required: True ,
}
string ,
table:
{
Description: Table name of the column to update. ,
Required: True ,
}
string ,
column:
{
Description: Column name to update. ,
Required: True ,
}
string ,
sensitivityLabel:
{
Description: The sensitivity label information to apply on a column. ,
Required: False ,
}
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_ListRecommendedByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
includeDisabledRecommendations:
{
Description: Specifies whether to include disabled recommendations or not. ,
Required: False ,
}
boolean ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseRecommendedSensitivityLabels_Update (new)
Description :  Update recommended sensitivity labels states of a given database using an operations batch.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
operations:
{
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
op:
{
Enum:
{
enable: No description available. ,
disable: No description available. ,
}
,
Required: True ,
}
enum ,
schema:
{
Description: Schema name of the column to update. ,
Required: True ,
}
string ,
table:
{
Description: Table name of the column to update. ,
Required: True ,
}
string ,
column:
{
Description: Column name to update. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_Get (new)
Description :  Gets the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_CreateOrUpdate (new)
Description :  Creates or updates the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
parameters:
{
Description: The column sensitivity label resource. ,
Required: True ,
}
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ManagedDatabaseSensitivityLabels_Delete (new)
Description :  Deletes the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_DisableRecommendation (new)
Description :  Disables sensitivity recommendations on a given column
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_EnableRecommendation (new)
Description :  Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseSensitivityLabels_ListByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/sensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseTables_ListBySchema (new)
Description :  List managed database tables
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the table is memory optimized. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseTables_Get (new)
Description :  Get managed database table
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
temporalType:
{
Description: The table temporal type. ,
Enum:
{
NonTemporalTable: No description available. ,
HistoryTable: No description available. ,
SystemVersionedTemporalTable: No description available. ,
}
,
Required: False ,
}
enum ,
memoryOptimized:
{
Description: Whether or not the table is memory optimized. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseTransparentDataEncryption_ListByDatabase (new)
Description :  Gets a list of managed database's transparent data encryptions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/transparentDataEncryption
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the transparent data encryption is defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseTransparentDataEncryption_Get (new)
Description :  Gets a managed database's transparent data encryption.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the transparent data encryption is defined. ,
Required: True ,
}
string ,
tdeName:
{
Description: The name of the transparent data encryption configuration. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseTransparentDataEncryption_CreateOrUpdate (new)
Description :  Updates a database's transparent data encryption configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the managed database for which the security alert policy is defined. ,
Required: True ,
}
string ,
tdeName:
{
Description: The name of the transparent data encryption configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The database transparent data encryption. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
ManagedDatabaseVulnerabilityAssessmentRuleBaselines_Get (new)
Description :  Gets a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessmentRuleBaselines_CreateOrUpdate (new)
Description :  Creates or updates a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
baselineResults:
{
Description: The rule baseline result ,
Required: True ,
}
[
{
result:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessmentRuleBaselines_Delete (new)
Description :  Removes the database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment rule baseline is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
baselineName:
{
Description: The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessmentScans_ListByDatabase (new)
Description :  Lists the vulnerability assessment scans of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
storageContainerPath:
{
Description: The scan results storage container path. ,
Required: False ,
}
string ,
numberOfFailedSecurityChecks:
{
Description: The number of failed security checks. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessmentScans_Get (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id of the scan to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
storageContainerPath:
{
Description: The scan results storage container path. ,
Required: False ,
}
string ,
numberOfFailedSecurityChecks:
{
Description: The number of failed security checks. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessmentScans_Export (new)
Description :  Convert an existing scan result to a human readable format. If already exists nothing happens
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/export
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the scanned database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
exportedReportLocation:
{
Description: Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx). ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
exportedReportLocation:
{
Description: Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx). ,
Required: False ,
}
string ,
}
,
}
ManagedDatabaseVulnerabilityAssessmentScans_InitiateScan (new)
Description :  Executes a Vulnerability Assessment database scan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The vulnerability assessment scan Id of the scan to retrieve. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabaseVulnerabilityAssessments_ListByDatabase (new)
Description :  Lists the vulnerability assessments of a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessments_Get (new)
Description :  Gets the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabaseVulnerabilityAssessments_CreateOrUpdate (new)
Description :  Creates or updates the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set ,
Required: False ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedDatabaseVulnerabilityAssessments_Delete (new)
Description :  Removes the database's vulnerability assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabases_ListByInstance (new)
Description :  Gets a list of managed databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabases_Get (new)
Description :  Gets a managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedDatabases_CreateOrUpdate (new)
Description :  Creates a new database or updates an existing database.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested database resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}
ManagedDatabases_Delete (new)
Description :  Deletes a managed database.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedDatabases_Update (new)
Description :  Updates an existing database.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested database resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabases_CancelMove (new)
Description :  Cancels a managed database move operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/cancelMove
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters of the cancel managed database move operation. ,
Required: True ,
}
{
destinationManagedDatabaseId:
{
Description: The destination managed database ID ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabases_CompleteMove (new)
Description :  Completes a managed database move operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/completeMove
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters of the complete managed database move operation. ,
Required: True ,
}
{
destinationManagedDatabaseId:
{
Description: The destination managed database ID ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabases_CompleteRestore (new)
Description :  Completes the restore operation on a managed database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/completeRestore
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The definition for completing the restore of this managed database. ,
Required: True ,
}
{
lastBackupName:
{
Description: The last backup name to apply ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabases_StartMove (new)
Description :  Starts a managed database move operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/startMove
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters of the start managed database move operation. ,
Required: True ,
}
{
destinationManagedDatabaseId:
{
Description: The destination managed database ID ,
Required: True ,
}
string ,
operationMode:
{
Description: The move operation mode. ,
Enum:
{
Move: No description available. ,
Copy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedDatabases_ListInaccessibleByInstance (new)
Description :  Gets a list of inaccessible managed databases in a managed instance
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/inaccessibleManagedDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
collation:
{
Description: Collation of the managed database. ,
Required: False ,
}
string ,
status:
{
Description: Status of the database. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Shutdown: No description available. ,
Creating: No description available. ,
Inaccessible: No description available. ,
Restoring: No description available. ,
Updating: No description available. ,
Stopping: No description available. ,
Stopped: No description available. ,
Starting: No description available. ,
DbMoving: No description available. ,
DbCopying: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: Creation date of the database. ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestorePoint:
{
Description: Earliest restore point in time for point in time restore. ,
Format: date-time ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
defaultSecondaryLocation:
{
Description: Geo paired region. ,
Required: False ,
}
string ,
catalogCollation:
{
Description: Collation of the metadata catalog. ,
Enum:
{
DATABASE_DEFAULT: No description available. ,
SQL_Latin1_General_CP1_CI_AS: No description available. ,
}
,
Required: False ,
}
enum ,
createMode:
{
Description: Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). ,
Enum:
{
Default: No description available. ,
RestoreExternalBackup: No description available. ,
PointInTimeRestore: No description available. ,
Recovery: No description available. ,
RestoreLongTermRetentionBackup: No description available. ,
}
,
Required: False ,
}
enum ,
storageContainerUri:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. ,
Required: False ,
}
string ,
sourceDatabaseId:
{
Description: The resource identifier of the source database associated with create operation of this database. ,
Required: False ,
}
string ,
crossSubscriptionSourceDatabaseId:
{
Description: The resource identifier of the cross-subscription source database associated with create operation of this database. ,
Required: False ,
}
string ,
restorableDroppedDatabaseId:
{
Description: The restorable dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
crossSubscriptionRestorableDroppedDatabaseId:
{
Description: The restorable cross-subscription dropped database resource id to restore when creating this database. ,
Required: False ,
}
string ,
storageContainerIdentity:
{
Description: Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. ,
Required: False ,
}
string ,
storageContainerSasToken:
{
Description: Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. ,
Required: False ,
}
string ,
failoverGroupId:
{
Description: Instance Failover Group resource identifier that this managed database belongs to. ,
Required: False ,
}
string ,
recoverableDatabaseId:
{
Description: The resource identifier of the recoverable database associated with create operation of this database. ,
Required: False ,
}
string ,
longTermRetentionBackupResourceId:
{
Description: The name of the Long Term Retention backup to be used for restore of this managed database. ,
Required: False ,
}
string ,
autoCompleteRestore:
{
Description: Whether to auto complete restore of this managed database. ,
Required: False ,
}
boolean ,
lastBackupName:
{
Description: Last backup file name for restore of this managed database. ,
Required: False ,
}
string ,
crossSubscriptionTargetManagedInstanceId:
{
Description: Target managed instance id used in cross-subscription restore. ,
Required: False ,
}
string ,
isLedgerOn:
{
Description: Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAdministrators_ListByInstance (new)
Description :  Gets a list of managed instance administrators.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the managed instance administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: True ,
}
enum ,
login:
{
Description: Login name of the managed instance administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the managed instance administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the managed instance administrator. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAdministrators_Get (new)
Description :  Gets a managed instance administrator.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
administratorName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the managed instance administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: True ,
}
enum ,
login:
{
Description: Login name of the managed instance administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the managed instance administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the managed instance administrator. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAdministrators_CreateOrUpdate (new)
Description :  Creates or updates a managed instance administrator.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
administratorName:
{
Required: True ,
}
string ,
parameters:
{
Description: The requested administrator parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the managed instance administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: True ,
}
enum ,
login:
{
Description: Login name of the managed instance administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the managed instance administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the managed instance administrator. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the managed instance administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: True ,
}
enum ,
login:
{
Description: Login name of the managed instance administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the managed instance administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the managed instance administrator. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the managed instance administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: True ,
}
enum ,
login:
{
Description: Login name of the managed instance administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the managed instance administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the managed instance administrator. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
ManagedInstanceAdministrators_Delete (new)
Description :  Deletes a managed instance administrator.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
administratorName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceAdvancedThreatProtectionSettings_ListByInstance (new)
Description :  Get the managed instance's Advanced Threat Protection settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/advancedThreatProtectionSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAdvancedThreatProtectionSettings_Get (new)
Description :  Get a managed instance's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAdvancedThreatProtectionSettings_CreateOrUpdate (new)
Description :  Creates or updates Advanced Threat Protection settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed instance Advanced Threat Protection state. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceAzureADOnlyAuthentications_ListByInstance (new)
Description :  Gets a list of server Azure Active Directory only authentications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAzureADOnlyAuthentications_Get (new)
Description :  Gets a specific Azure Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceAzureADOnlyAuthentications_CreateOrUpdate (new)
Description :  Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating an Active Directory only authentication property. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
ManagedInstanceAzureADOnlyAuthentications_Delete (new)
Description :  Deletes an existing server Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedInstanceDtcs_ListByManagedInstance (new)
Description :  Gets a list of managed instance DTC settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dtc
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dtcEnabled:
{
Description: Active status of managed instance DTC. ,
Required: False ,
}
boolean ,
securitySettings:
{
Description: Security settings of managed instance DTC. ,
Required: False ,
}
{
transactionManagerCommunicationSettings:
{
Description: Transaction Manager communication settings of managed instance DTC. ,
Required: False ,
}
{
allowInboundEnabled:
{
Description: Allow Inbound traffic to managed instance DTC. ,
Required: False ,
}
boolean ,
allowOutboundEnabled:
{
Description: Allow Outbound traffic of managed instance DTC. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication type of managed instance DTC. ,
Required: False ,
}
string ,
}
,
xaTransactionsEnabled:
{
Description: Allow XA Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
snaLu6point2TransactionsEnabled:
{
Description: Allow SNA LU 6.2 Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
xaTransactionsDefaultTimeout:
{
Description: Default timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
xaTransactionsMaximumTimeout:
{
Description: Maximum timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
externalDnsSuffixSearchList:
{
Description: External dns suffix search list of managed instance DTC. ,
Required: False ,
}
[
string ,
]
,
dtcHostNameDnsSuffix:
{
Description: Host name dns suffix of managed instance DTC. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of managed instance DTC. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceDtcs_Get (new)
Description :  Gets managed instance DTC settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dtc/{dtcName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dtcName:
{
Description: The name of the managed instance DTC. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dtcEnabled:
{
Description: Active status of managed instance DTC. ,
Required: False ,
}
boolean ,
securitySettings:
{
Description: Security settings of managed instance DTC. ,
Required: False ,
}
{
transactionManagerCommunicationSettings:
{
Description: Transaction Manager communication settings of managed instance DTC. ,
Required: False ,
}
{
allowInboundEnabled:
{
Description: Allow Inbound traffic to managed instance DTC. ,
Required: False ,
}
boolean ,
allowOutboundEnabled:
{
Description: Allow Outbound traffic of managed instance DTC. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication type of managed instance DTC. ,
Required: False ,
}
string ,
}
,
xaTransactionsEnabled:
{
Description: Allow XA Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
snaLu6point2TransactionsEnabled:
{
Description: Allow SNA LU 6.2 Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
xaTransactionsDefaultTimeout:
{
Description: Default timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
xaTransactionsMaximumTimeout:
{
Description: Maximum timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
externalDnsSuffixSearchList:
{
Description: External dns suffix search list of managed instance DTC. ,
Required: False ,
}
[
string ,
]
,
dtcHostNameDnsSuffix:
{
Description: Host name dns suffix of managed instance DTC. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of managed instance DTC. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceDtcs_CreateOrUpdate (new)
Description :  Updates managed instance DTC settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dtc/{dtcName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dtcName:
{
Description: The name of the managed instance DTC. ,
Required: True ,
}
string ,
parameters:
{
Description: Managed instance DTC settings. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dtcEnabled:
{
Description: Active status of managed instance DTC. ,
Required: False ,
}
boolean ,
securitySettings:
{
Description: Security settings of managed instance DTC. ,
Required: False ,
}
{
transactionManagerCommunicationSettings:
{
Description: Transaction Manager communication settings of managed instance DTC. ,
Required: False ,
}
{
allowInboundEnabled:
{
Description: Allow Inbound traffic to managed instance DTC. ,
Required: False ,
}
boolean ,
allowOutboundEnabled:
{
Description: Allow Outbound traffic of managed instance DTC. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication type of managed instance DTC. ,
Required: False ,
}
string ,
}
,
xaTransactionsEnabled:
{
Description: Allow XA Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
snaLu6point2TransactionsEnabled:
{
Description: Allow SNA LU 6.2 Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
xaTransactionsDefaultTimeout:
{
Description: Default timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
xaTransactionsMaximumTimeout:
{
Description: Maximum timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
externalDnsSuffixSearchList:
{
Description: External dns suffix search list of managed instance DTC. ,
Required: False ,
}
[
string ,
]
,
dtcHostNameDnsSuffix:
{
Description: Host name dns suffix of managed instance DTC. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of managed instance DTC. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
dtcEnabled:
{
Description: Active status of managed instance DTC. ,
Required: False ,
}
boolean ,
securitySettings:
{
Description: Security settings of managed instance DTC. ,
Required: False ,
}
{
transactionManagerCommunicationSettings:
{
Description: Transaction Manager communication settings of managed instance DTC. ,
Required: False ,
}
{
allowInboundEnabled:
{
Description: Allow Inbound traffic to managed instance DTC. ,
Required: False ,
}
boolean ,
allowOutboundEnabled:
{
Description: Allow Outbound traffic of managed instance DTC. ,
Required: False ,
}
boolean ,
authentication:
{
Description: Authentication type of managed instance DTC. ,
Required: False ,
}
string ,
}
,
xaTransactionsEnabled:
{
Description: Allow XA Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
snaLu6point2TransactionsEnabled:
{
Description: Allow SNA LU 6.2 Transactions to managed instance DTC. ,
Required: False ,
}
boolean ,
xaTransactionsDefaultTimeout:
{
Description: Default timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
xaTransactionsMaximumTimeout:
{
Description: Maximum timeout for XA Transactions (in seconds). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
externalDnsSuffixSearchList:
{
Description: External dns suffix search list of managed instance DTC. ,
Required: False ,
}
[
string ,
]
,
dtcHostNameDnsSuffix:
{
Description: Host name dns suffix of managed instance DTC. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of managed instance DTC. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceEncryptionProtectors_ListByInstance (new)
Description :  Gets a list of managed instance encryption protectors
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyName:
{
Description: The name of the managed instance key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceEncryptionProtectors_Get (new)
Description :  Gets a managed instance encryption protector.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyName:
{
Description: The name of the managed instance key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceEncryptionProtectors_CreateOrUpdate (new)
Description :  Updates an existing encryption protector.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested encryption protector resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyName:
{
Description: The name of the managed instance key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyName:
{
Description: The name of the managed instance key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceEncryptionProtectors_Revalidate (new)
Description :  Revalidates an existing encryption protector.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}/revalidate
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
encryptionProtectorName:
{
Description: The name of the encryption protector to be updated. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceKeys_ListByInstance (new)
Description :  Gets a list of managed instance keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceKeys_Get (new)
Description :  Gets a managed instance key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the managed instance key to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceKeys_CreateOrUpdate (new)
Description :  Creates or updates a managed instance key.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the managed instance key to be operated on (updated or created). ,
Required: True ,
}
string ,
parameters:
{
Description: The requested managed instance key resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverKeyType:
{
Description: The key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
ManagedInstanceKeys_Delete (new)
Description :  Deletes the managed instance key with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the managed instance key to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedInstanceLongTermRetentionPolicies_ListByDatabase (new)
Description :  Gets a database's long term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backups ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceLongTermRetentionPolicies_Get (new)
Description :  Gets a managed database's long term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be Default. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backups ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceLongTermRetentionPolicies_CreateOrUpdate (new)
Description :  Sets a managed database's long term retention policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be Default. ,
Required: True ,
}
string ,
parameters:
{
Description: The long term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backups ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backups ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceLongTermRetentionPolicies_Delete (new)
Description :  Deletes a managed database's long term retention policy.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be Default. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
backupStorageAccessTier:
{
Description: The BackupStorageAccessTier for the LTR backups ,
Enum:
{
Hot: No description available. ,
Archive: No description available. ,
}
,
Required: False ,
}
enum ,
weeklyRetention:
{
Description: The weekly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
monthlyRetention:
{
Description: The monthly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
yearlyRetention:
{
Description: The yearly retention policy for an LTR backup in an ISO 8601 format. ,
Required: False ,
}
string ,
weekOfYear:
{
Description: The week of year to take the yearly backup in an ISO 8601 format. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceOperations_ListByManagedInstance (new)
Description :  Gets a list of operations performed on the managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/operations
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The name of the managed instance the operation is being performed on. ,
Required: False ,
}
string ,
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the operation completed. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
estimatedCompletionTime:
{
Description: The estimated completion time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Whether the operation can be cancelled. ,
Required: False ,
}
boolean ,
operationParameters:
{
Description: The operation parameters. ,
Required: False ,
}
{
currentParameters:
{
Description: The current parameters. ,
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
tier:
{
Required: False ,
}
string ,
vCores:
{
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
requestedParameters:
{
Description: The requested parameters. ,
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
tier:
{
Required: False ,
}
string ,
vCores:
{
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
operationSteps:
{
Description: The operation steps. ,
Required: False ,
}
{
totalSteps:
{
Description: The total number of operation steps. ,
Required: False ,
}
string ,
currentStep:
{
Description: The number of current operation steps. ,
Format: int32 ,
Required: False ,
}
integer ,
stepsList:
{
Description: The operation steps list. ,
Required: False ,
}
[
{
stepStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
stepEndTime:
{
Format: date-time ,
Required: False ,
}
string ,
timeElapsed:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
status:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
SlowedDown: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceOperations_Get (new)
Description :  Gets a management operation on a managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
operationId:
{
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
managedInstanceName:
{
Description: The name of the managed instance the operation is being performed on. ,
Required: False ,
}
string ,
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the operation completed. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
estimatedCompletionTime:
{
Description: The estimated completion time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Whether the operation can be cancelled. ,
Required: False ,
}
boolean ,
operationParameters:
{
Description: The operation parameters. ,
Required: False ,
}
{
currentParameters:
{
Description: The current parameters. ,
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
tier:
{
Required: False ,
}
string ,
vCores:
{
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
requestedParameters:
{
Description: The requested parameters. ,
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
tier:
{
Required: False ,
}
string ,
vCores:
{
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
operationSteps:
{
Description: The operation steps. ,
Required: False ,
}
{
totalSteps:
{
Description: The total number of operation steps. ,
Required: False ,
}
string ,
currentStep:
{
Description: The number of current operation steps. ,
Format: int32 ,
Required: False ,
}
integer ,
stepsList:
{
Description: The operation steps list. ,
Required: False ,
}
[
{
stepStartTime:
{
Format: date-time ,
Required: False ,
}
string ,
stepEndTime:
{
Format: date-time ,
Required: False ,
}
string ,
timeElapsed:
{
Required: False ,
}
string ,
order:
{
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Required: False ,
}
string ,
status:
{
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
SlowedDown: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceOperations_Cancel (new)
Description :  Cancels the asynchronous operation on the managed instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/operations/{operationId}/cancel
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
operationId:
{
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstancePrivateEndpointConnections_ListByManagedInstance (new)
Description :  Gets all private endpoint connections on a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstancePrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstancePrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstancePrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedInstancePrivateLinkResources_ListByManagedInstance (new)
Description :  Gets the private link resources for SQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: The private link resource group id. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstancePrivateLinkResources_Get (new)
Description :  Gets a private link resource for SQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/privateLinkResources/{groupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The private link resource group id. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceTdeCertificates_Create (new)
Description :  Creates a TDE certificate for a given server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/tdeCertificates
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested TDE certificate to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateBlob:
{
Description: The base64 encoded certificate private blob. ,
Required: True ,
}
string ,
certPassword:
{
Description: The certificate password. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstanceVulnerabilityAssessments_ListByInstance (new)
Description :  Gets the managed instance's vulnerability assessment policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/vulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance for which the vulnerability assessments is defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceVulnerabilityAssessments_Get (new)
Description :  Gets the managed instance's vulnerability assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstanceVulnerabilityAssessments_CreateOrUpdate (new)
Description :  Creates or updates the managed instance's vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ManagedInstanceVulnerabilityAssessments_Delete (new)
Description :  Removes the managed instance's vulnerability assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_List (new)
Description :  Gets a list of all managed instances in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/managedInstances
{
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_ListByInstancePool (new)
Description :  Gets a list of all managed instances in an instance pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/managedInstances
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The instance pool name. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_ListByResourceGroup (new)
Description :  Gets a list of managed instances in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_Get (new)
Description :  Gets a managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_CreateOrUpdate (new)
Description :  Creates or updates a managed instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested managed instance resource state. ,
Required: True ,
}
{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ManagedInstances_Delete (new)
Description :  Deletes a managed instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedInstances_Update (new)
Description :  Updates a managed instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested managed instance resource state. ,
Required: True ,
}
{
sku:
{
Description: Managed instance sku ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed instance identity ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstances_Failover (new)
Description :  Failovers a managed instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance to failover. ,
Required: True ,
}
string ,
replicaType:
{
Description: The type of replica to be failed over. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance (new)
Description :  Gets the collection of outbound network dependencies for the given managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/outboundNetworkDependenciesEndpoints
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
category:
{
Description: The type of service accessed by the managed instance service, e.g., Azure Storage, Azure Active Directory, etc. ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints that the managed instance service communicates with in order to function correctly. ,
Required: False ,
}
[
{
domainName:
{
Description: The domain name of the dependency. ,
Required: False ,
}
string ,
endpointDetails:
{
Description: The IP Addresses and Ports used when connecting to DomainName. ,
Required: False ,
}
[
{
port:
{
Description: The port an endpoint is connected to. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedInstances_RefreshStatus (new)
Description :  Refresh external governance enablement status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/refreshExternalGovernanceStatus
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
managedInstanceName:
{
Description: Managed instance name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstances_Start (new)
Description :  Starts the managed instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/start
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstances_Stop (new)
Description :  Stops the managed instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the managed instance. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of managed instance. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
managedInstanceCreateMode:
{
Description: Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. ,
Enum:
{
Default: No description available. ,
PointInTimeRestore: No description available. ,
}
,
Required: False ,
}
enum ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the managed instance. ,
Required: False ,
}
string ,
isGeneralPurposeV2:
{
Description: Whether or not this is a GPv2 variant of General Purpose edition. ,
Required: False ,
}
boolean ,
administratorLogin:
{
Description: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation). ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for managed instance creation). ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet resource ID for the managed instance. ,
Format: arm-id ,
Required: False ,
}
string ,
state:
{
Description: The state of the managed instance. ,
Required: False ,
}
string ,
licenseType:
{
Description: The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). ,
Enum:
{
LicenseIncluded: No description available. ,
BasePrice: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsage:
{
Description: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
hybridSecondaryUsageDetected:
{
Description: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). ,
Enum:
{
Active: No description available. ,
Passive: No description available. ,
}
,
Required: False ,
}
enum ,
vCores:
{
Description: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGB:
{
Description: Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageIOps:
{
Description: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores. ,
Format: int32 ,
Required: False ,
}
integer ,
storageThroughputMBps:
{
Description: Storage throughput MBps parameter is not supported in the instance create/update operation. ,
Format: int32 ,
Required: False ,
}
integer ,
collation:
{
Description: Collation of the managed instance. ,
Required: False ,
}
string ,
dnsZone:
{
Description: The Dns Zone that the managed instance is in. ,
Required: False ,
}
string ,
dnsZonePartner:
{
Description: The resource id of another managed instance whose DNS zone this managed instance will share after creation. ,
Format: arm-id ,
Required: False ,
}
string ,
publicDataEndpointEnabled:
{
Description: Whether or not the public data endpoint is enabled. ,
Required: False ,
}
boolean ,
sourceManagedInstanceId:
{
Description: The resource identifier of the source managed instance associated with create operation of this instance. ,
Format: arm-id ,
Required: False ,
}
string ,
restorePointInTime:
{
Description: Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. ,
Format: date-time ,
Required: False ,
}
string ,
proxyOverride:
{
Description: Connection type used for connecting to the instance. ,
Enum:
{
Proxy: No description available. ,
Redirect: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
timezoneId:
{
Description: Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time". ,
Required: False ,
}
string ,
instancePoolId:
{
Description: The Id of the instance pool this managed server belongs to. ,
Required: False ,
}
string ,
maintenanceConfigurationId:
{
Description: Specifies maintenance configuration id to apply to this managed instance. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a managed instance. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the Private Endpoint Connection. ,
Required: False ,
}
string ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2' ,
Required: False ,
}
string ,
currentBackupStorageRedundancy:
{
Description: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
requestedBackupStorageRedundancy:
{
Description: The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage) ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
zoneRedundant:
{
Description: Whether or not the multi-az is enabled. ,
Required: False ,
}
boolean ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Format: arm-id ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
servicePrincipal:
{
Description: The managed instance's service principal. ,
Required: False ,
}
{
principalId:
{
Description: The Azure Active Directory application object id. ,
Required: False ,
}
string ,
clientId:
{
Description: The Azure Active Directory application client id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Required: False ,
}
string ,
type:
{
Description: Service principal type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
virtualClusterId:
{
Description: Virtual cluster resource id for the Managed Instance. ,
Required: False ,
}
string ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
pricingModel:
{
Description: Pricing model of Managed Instance. ,
Enum:
{
Regular: No description available. ,
Freemium: No description available. ,
}
,
Required: False ,
}
enum ,
createTime:
{
Description: Specifies the point in time (ISO8601 format) of the Managed Instance creation. ,
Format: date-time ,
Required: False ,
}
string ,
authenticationMetadata:
{
Description: The managed instance's authentication metadata lookup mode. ,
Enum:
{
AzureAD: No description available. ,
Paired: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
databaseFormat:
{
Description: Specifies the internal format of instance databases specific to the SQL engine version. ,
Enum:
{
AlwaysUpToDate: No description available. ,
SQLServer2022: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedInstances_ListByManagedInstance (new)
Description :  Get top resource consuming queries of a managed instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
numberOfQueries:
{
Description: How many 'top queries' to return. Default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
databases:
{
Description: Comma separated list of databases to be included into search. All DB's are included if this parameter is not specified. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time for observed period. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for observed period. ,
Required: False ,
}
string ,
interval:
{
Description: The time step to be used to summarize the metric values. Default value is PT1H ,
Required: False ,
}
string ,
aggregationFunction:
{
Description: Aggregation function to be used, default value is 'sum' ,
Required: False ,
}
string ,
observationMetric:
{
Description: Metric to be used for ranking top queries. Default is 'cpu' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
numberOfQueries:
{
Description: Requested number of top queries. ,
Format: int32 ,
Required: False ,
}
integer ,
aggregationFunction:
{
Description: Aggregation function used to calculate query metrics. ,
Required: False ,
}
string ,
observationMetric:
{
Description: Metric used to rank queries. ,
Required: False ,
}
string ,
intervalType:
{
Description: Interval type (length). ,
Enum:
{
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
queries:
{
Description: List of top resource consuming queries with appropriate metric data ,
Required: False ,
}
[
{
databaseName:
{
Description: Database name of the database in which this query was executed. ,
Required: False ,
}
string ,
queryId:
{
Description: Unique query id (unique within one database). ,
Required: False ,
}
string ,
startTime:
{
Description: The start time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
endTime:
{
Description: The end time for the metric (ISO-8601 format). ,
Required: False ,
}
string ,
intervals:
{
Description: List of intervals with appropriate metric data ,
Required: False ,
}
[
{
intervalStartTime:
{
Description: The start time for the metric interval (ISO-8601 format). ,
Required: False ,
}
string ,
intervalType:
{
Description: Interval type (length). ,
Enum:
{
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
executionCount:
{
Description: Execution count of a query in this interval. ,
Format: int64 ,
Required: False ,
}
integer ,
metrics:
{
Description: List of metric objects for this interval ,
Required: False ,
}
[
{
name:
{
Description: The name information for the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: The UI appropriate name for the metric. ,
Required: False ,
}
string ,
unit:
{
Description: The unit of the metric. ,
Enum:
{
percentage: No description available. ,
KB: No description available. ,
microseconds: No description available. ,
count: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the metric. ,
Format: double ,
Required: False ,
}
number ,
min:
{
Description: Metric value when min() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
max:
{
Description: Metric value when max() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
avg:
{
Description: Metric value when avg() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
sum:
{
Description: Metric value when sum() aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
stdev:
{
Description: Metric value when stdev aggregate function is used over the interval. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedLedgerDigestUploads_ListByDatabase (new)
Description :  Gets all ledger digest upload settings on a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/ledgerDigestUploads
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedLedgerDigestUploads_Get (new)
Description :  Gets the current ledger digest upload configuration for a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedLedgerDigestUploads_CreateOrUpdate (new)
Description :  Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Description: The name of the Ledger Digest Upload Configurations. ,
Required: True ,
}
string ,
parameters:
{
Description: The Ledger Digest Storage Endpoint. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedLedgerDigestUploads_Disable (new)
Description :  Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/ledgerDigestUploads/{ledgerDigestUploads}/disable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
ledgerDigestUploads:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
digestStorageEndpoint:
{
Description: The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger. ,
Required: False ,
}
string ,
state:
{
Description: Specifies the state of ledger digest upload. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_ListByRestorableDroppedDatabase (new)
Description :  Gets a dropped database's short term retention policy list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Get (new)
Description :  Gets a dropped database's short term retention policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
policyName:
{
Description: The policy name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_CreateOrUpdate (new)
Description :  Sets a database's short term retention policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Update (new)
Description :  Sets a database's short term retention policy.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies/{policyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
policyName:
{
Description: The policy name. Should always be "default". ,
Required: True ,
}
string ,
parameters:
{
Description: The short term retention policy info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
retentionDays:
{
Description: The backup retention period in days. This is how many days Point-in-Time Restore will be supported. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedServerDnsAliases_ListByManagedInstance (new)
Description :  Gets a list of managed server DNS aliases for a managed server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dnsAliases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for managed server alias ,
Required: False ,
}
string ,
publicAzureDnsRecord:
{
Description: The fully qualified public DNS record for managed server alias ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedServerDnsAliases_Get (new)
Description :  Gets a server DNS alias.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dnsAliasName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for managed server alias ,
Required: False ,
}
string ,
publicAzureDnsRecord:
{
Description: The fully qualified public DNS record for managed server alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedServerDnsAliases_CreateOrUpdate (new)
Description :  Creates a managed server DNS alias.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dnsAliasName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
createDnsRecord:
{
Description: Whether or not DNS record should be created for this alias. ,
Required: False ,
}
boolean ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for managed server alias ,
Required: False ,
}
string ,
publicAzureDnsRecord:
{
Description: The fully qualified public DNS record for managed server alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for managed server alias ,
Required: False ,
}
string ,
publicAzureDnsRecord:
{
Description: The fully qualified public DNS record for managed server alias ,
Required: False ,
}
string ,
}
,
}
ManagedServerDnsAliases_Delete (new)
Description :  Deletes the managed server DNS alias with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dnsAliasName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ManagedServerDnsAliases_Acquire (new)
Description :  Acquires managed server DNS alias from another managed server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/dnsAliases/{dnsAliasName}/acquire
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
dnsAliasName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
oldManagedServerDnsAliasResourceId:
{
Description: The resource ID of the managed server DNS alias that will be acquired to point to this managed server instead. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for managed server alias ,
Required: False ,
}
string ,
publicAzureDnsRecord:
{
Description: The fully qualified public DNS record for managed server alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ManagedServerSecurityAlertPolicies_ListByInstance (new)
Description :  Get the managed server's threat detection policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedServerSecurityAlertPolicies_Get (new)
Description :  Get a managed server's threat detection policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagedServerSecurityAlertPolicies_CreateOrUpdate (new)
Description :  Creates or updates a threat detection policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed server security alert policy. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
NetworkSecurityPerimeterConfigurations_ListByServer (new)
Description :  Gets a list of NSP configurations for a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/networkSecurityPerimeterConfigurations
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
networkSecurityPerimeter:
{
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessMode:
{
Required: False ,
}
string ,
}
,
profile:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessRulesVersion:
{
Required: False ,
}
string ,
accessRules:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
direction:
{
Required: False ,
}
string ,
addressPrefixes:
{
Required: False ,
}
[
string ,
]
,
fullyQualifiedDomainNames:
{
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Required: False ,
}
[
string ,
]
,
networkSecurityPerimeters:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
]
,
serviceTags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningIssues:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
issueType:
{
Required: False ,
}
string ,
severity:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
suggestedResourceIds:
{
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Get (new)
Description :  Gets a network security perimeter configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/networkSecurityPerimeterConfigurations/{nspConfigName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
nspConfigName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
networkSecurityPerimeter:
{
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessMode:
{
Required: False ,
}
string ,
}
,
profile:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessRulesVersion:
{
Required: False ,
}
string ,
accessRules:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
direction:
{
Required: False ,
}
string ,
addressPrefixes:
{
Required: False ,
}
[
string ,
]
,
fullyQualifiedDomainNames:
{
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Required: False ,
}
[
string ,
]
,
networkSecurityPerimeters:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
]
,
serviceTags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningIssues:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
issueType:
{
Required: False ,
}
string ,
severity:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
suggestedResourceIds:
{
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description :  Reconcile network security perimeter configuration for SQL Resource Provider
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/networkSecurityPerimeterConfigurations/{nspConfigName}/reconcile
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
nspConfigName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Required: False ,
}
string ,
networkSecurityPerimeter:
{
Required: False ,
}
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessMode:
{
Required: False ,
}
string ,
}
,
profile:
{
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
accessRulesVersion:
{
Required: False ,
}
string ,
accessRules:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
direction:
{
Required: False ,
}
string ,
addressPrefixes:
{
Required: False ,
}
[
string ,
]
,
fullyQualifiedDomainNames:
{
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Required: False ,
}
[
string ,
]
,
networkSecurityPerimeters:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
perimeterGuid:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
}
,
]
,
serviceTags:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningIssues:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
issueType:
{
Required: False ,
}
string ,
severity:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
suggestedResourceIds:
{
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Operations_List (new)
Description :  Lists all of the available SQL Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Sql/operations
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: The localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Enum:
{
user: No description available. ,
system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OutboundFirewallRules_ListByServer (new)
Description :  Gets all outbound firewall rules on a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the outbound rule. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OutboundFirewallRules_Get (new)
Description :  Gets an outbound firewall rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
outboundRuleFqdn:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the outbound rule. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OutboundFirewallRules_CreateOrUpdate (new)
Description :  Create a outbound firewall rule with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
outboundRuleFqdn:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the outbound rule. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the outbound rule. ,
Required: False ,
}
string ,
}
,
}
OutboundFirewallRules_Delete (new)
Description :  Deletes a outbound firewall rule with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/outboundFirewallRules/{outboundRuleFqdn}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
outboundRuleFqdn:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
PrivateEndpointConnections_ListByServer (new)
Description :  Gets all private endpoint connections on a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
PrivateLinkResources_ListByServer (new)
Description :  Gets the private link resources for SQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: The private link resource group id. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets a private link resource for SQL server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateLinkResources/{groupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The private link resource group id. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource required zone names. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoverableDatabases_ListByServer (new)
Description :  Gets a list of recoverable databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recoverableDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
edition:
{
Description: The edition of the database. ,
Required: False ,
}
string ,
serviceLevelObjective:
{
Description: The service level objective name of the database. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The elastic pool name of the database ,
Required: False ,
}
string ,
lastAvailableBackupDate:
{
Description: The last available backup date. ,
Format: date-time ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoverableDatabases_Get (new)
Description :  Gets a recoverable database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/recoverableDatabases/{databaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
edition:
{
Description: The edition of the database. ,
Required: False ,
}
string ,
serviceLevelObjective:
{
Description: The service level objective name of the database. ,
Required: False ,
}
string ,
elasticPoolName:
{
Description: The elastic pool name of the database ,
Required: False ,
}
string ,
lastAvailableBackupDate:
{
Description: The last available backup date. ,
Format: date-time ,
Required: False ,
}
string ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoverableManagedDatabases_ListByInstance (new)
Description :  Gets a list of recoverable managed databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/recoverableDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
lastAvailableBackupDate:
{
Description: The last available backup date. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoverableManagedDatabases_Get (new)
Description :  Gets a recoverable managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/recoverableDatabases/{recoverableDatabaseName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
recoverableDatabaseName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
lastAvailableBackupDate:
{
Description: The last available backup date. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorableDroppedDatabases_ListByServer (new)
Description :  Gets a list of restorable dropped databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: The name of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deletion date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: The earliest restore date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorableDroppedDatabases_Get (new)
Description :  Gets a restorable dropped database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and tier of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: The name of the database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: The max size of the database expressed in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deletion date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: The earliest restore date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
backupStorageRedundancy:
{
Description: The storage account type used to store backups for this database. ,
Enum:
{
Geo: No description available. ,
Local: No description available. ,
Zone: No description available. ,
GeoZone: No description available. ,
}
,
Required: False ,
}
enum ,
keys:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorableDroppedManagedDatabases_ListByInstance (new)
Description :  Gets a list of restorable dropped managed databases.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: The name of the database. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deletion date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: The earliest restore date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorableDroppedManagedDatabases_Get (new)
Description :  Gets a restorable dropped managed database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
restorableDroppedDatabaseId:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseName:
{
Description: The name of the database. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
deletionDate:
{
Description: The deletion date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
earliestRestoreDate:
{
Description: The earliest restore date of the database (ISO8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorePoints_ListByDatabase (new)
Description :  Gets a list of database restore points.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
restorePointType:
{
Description: The type of restore point ,
Enum:
{
CONTINUOUS: No description available. ,
DISCRETE: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest time to which this database can be restored ,
Format: date-time ,
Required: False ,
}
string ,
restorePointCreationDate:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
restorePointLabel:
{
Description: The label of restore point for backup request by user ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorePoints_Create (new)
Description :  Creates a restore point for a data warehouse.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Description: The definition for creating the restore point of this database. ,
Required: True ,
}
{
restorePointLabel:
{
Description: The restore point label to apply ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
restorePointType:
{
Description: The type of restore point ,
Enum:
{
CONTINUOUS: No description available. ,
DISCRETE: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest time to which this database can be restored ,
Format: date-time ,
Required: False ,
}
string ,
restorePointCreationDate:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
restorePointLabel:
{
Description: The label of restore point for backup request by user ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
restorePointType:
{
Description: The type of restore point ,
Enum:
{
CONTINUOUS: No description available. ,
DISCRETE: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest time to which this database can be restored ,
Format: date-time ,
Required: False ,
}
string ,
restorePointCreationDate:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
restorePointLabel:
{
Description: The label of restore point for backup request by user ,
Required: False ,
}
string ,
}
,
}
RestorePoints_Get (new)
Description :  Gets a restore point.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints/{restorePointName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
restorePointName:
{
Description: The name of the restore point. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
restorePointType:
{
Description: The type of restore point ,
Enum:
{
CONTINUOUS: No description available. ,
DISCRETE: No description available. ,
}
,
Required: False ,
}
enum ,
earliestRestoreDate:
{
Description: The earliest time to which this database can be restored ,
Format: date-time ,
Required: False ,
}
string ,
restorePointCreationDate:
{
Description: The time the backup was taken ,
Format: date-time ,
Required: False ,
}
string ,
restorePointLabel:
{
Description: The label of restore point for backup request by user ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RestorePoints_Delete (new)
Description :  Deletes a restore point.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/restorePoints/{restorePointName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
restorePointName:
{
Description: The name of the restore point. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_ListCurrentByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
$count:
{
Required: False ,
}
boolean ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_Update (new)
Description :  Update sensitivity labels of a given database using an operations batch.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
operations:
{
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
op:
{
Enum:
{
set: No description available. ,
remove: No description available. ,
}
,
Required: True ,
}
enum ,
schema:
{
Description: Schema name of the column to update. ,
Required: True ,
}
string ,
table:
{
Description: Table name of the column to update. ,
Required: True ,
}
string ,
column:
{
Description: Column name to update. ,
Required: True ,
}
string ,
sensitivityLabel:
{
Description: The sensitivity label information to apply on a column. ,
Required: False ,
}
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}
,
]
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_ListRecommendedByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$skipToken:
{
Required: False ,
}
string ,
includeDisabledRecommendations:
{
Description: Specifies whether to include disabled recommendations or not. ,
Required: False ,
}
boolean ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecommendedSensitivityLabels_Update (new)
Description :  Update recommended sensitivity labels states of a given database using an operations batch.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
operations:
{
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
op:
{
Enum:
{
enable: No description available. ,
disable: No description available. ,
}
,
Required: True ,
}
enum ,
schema:
{
Description: Schema name of the column to update. ,
Required: True ,
}
string ,
table:
{
Description: Table name of the column to update. ,
Required: True ,
}
string ,
column:
{
Description: Column name to update. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_Get (new)
Description :  Gets the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_CreateOrUpdate (new)
Description :  Creates or updates the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
parameters:
{
Description: The column sensitivity label resource. ,
Required: True ,
}
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
SensitivityLabels_Delete (new)
Description :  Deletes the sensitivity label of a given column
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Description: The source of the sensitivity label. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_DisableRecommendation (new)
Description :  Disables sensitivity recommendations on a given column
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_EnableRecommendation (new)
Description :  Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
schemaName:
{
Description: The name of the schema. ,
Required: True ,
}
string ,
tableName:
{
Description: The name of the table. ,
Required: True ,
}
string ,
columnName:
{
Description: The name of the column. ,
Required: True ,
}
string ,
sensitivityLabelSource:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SensitivityLabels_ListByDatabase (new)
Description :  Gets the sensitivity labels of a given database
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that filters elements in the collection. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
managedBy:
{
Description: Resource that manages the sensitivity label. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
tableName:
{
Description: The table name. ,
Required: False ,
}
string ,
columnName:
{
Description: The column name. ,
Required: False ,
}
string ,
labelName:
{
Description: The label name. ,
Required: False ,
}
string ,
labelId:
{
Description: The label ID. ,
Required: False ,
}
string ,
informationType:
{
Description: The information type. ,
Required: False ,
}
string ,
informationTypeId:
{
Description: The information type ID. ,
Required: False ,
}
string ,
isDisabled:
{
Description: Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not. ,
Required: False ,
}
boolean ,
rank:
{
Enum:
{
None: No description available. ,
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
Critical: No description available. ,
}
,
Required: False ,
}
enum ,
clientClassificationSource:
{
Enum:
{
None: No description available. ,
Native: No description available. ,
Recommended: No description available. ,
MIP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAdvancedThreatProtectionSettings_ListByServer (new)
Description :  Get a list of the server's Advanced Threat Protection states.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAdvancedThreatProtectionSettings_Get (new)
Description :  Get a server's Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAdvancedThreatProtectionSettings_CreateOrUpdate (new)
Description :  Creates or updates an Advanced Threat Protection state.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
advancedThreatProtectionName:
{
Description: The name of the Advanced Threat Protection state. ,
Required: True ,
}
string ,
parameters:
{
Description: The server Advanced Threat Protection state. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
New: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerAdvisors_ListByServer (new)
Description :  Gets a list of server advisors.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advisors
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAdvisors_Get (new)
Description :  Gets a server advisor.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advisors/{advisorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Server Advisor. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAdvisors_Update (new)
Description :  Updates a server advisor.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advisors/{advisorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
advisorName:
{
Description: The name of the Server Advisor. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested advisor resource state. ,
Required: True ,
}
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
advisorStatus:
{
Description: Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. ,
Enum:
{
GA: No description available. ,
PublicPreview: No description available. ,
LimitedPublicPreview: No description available. ,
PrivatePreview: No description available. ,
}
,
Required: False ,
}
enum ,
autoExecuteStatus:
{
Description: Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
Default: No description available. ,
}
,
Required: True ,
}
enum ,
autoExecuteStatusInheritedFrom:
{
Description: Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). ,
Enum:
{
Default: No description available. ,
Subscription: No description available. ,
Server: No description available. ,
ElasticPool: No description available. ,
Database: No description available. ,
}
,
Required: False ,
}
enum ,
recommendationsStatus:
{
Description: Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, 'Ok' (Recommendations available),LowActivity (not enough workload to analyze), 'DbSeemsTuned' (Database is doing well), etc. ,
Required: False ,
}
string ,
lastChecked:
{
Description: Gets the time when the current resource was analyzed for recommendations by this advisor. ,
Format: date-time ,
Required: False ,
}
string ,
recommendedActions:
{
Description: Gets the recommended actions for this advisor. ,
Required: False ,
}
[
{
kind:
{
Description: Resource kind. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recommendationReason:
{
Description: Gets the reason for recommending this action. e.g., DuplicateIndex ,
Required: False ,
}
string ,
validSince:
{
Description: Gets the time since when this recommended action is valid. ,
Format: date-time ,
Required: False ,
}
string ,
lastRefresh:
{
Description: Gets time when this recommended action was last refreshed. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the info of the current state the recommended action is in. ,
Required: True ,
}
{
currentValue:
{
Description: Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Executing: No description available. ,
Verifying: No description available. ,
PendingRevert: No description available. ,
RevertCancelled: No description available. ,
Reverting: No description available. ,
Reverted: No description available. ,
Ignored: No description available. ,
Expired: No description available. ,
Monitoring: No description available. ,
Resolved: No description available. ,
Success: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
actionInitiatedBy:
{
Description: Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
lastModified:
{
Description: Gets the time when the state was last modified ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isExecutableAction:
{
Description: Gets if this recommended action is actionable by user ,
Required: False ,
}
boolean ,
isRevertableAction:
{
Description: Gets if changes applied by this recommended action can be reverted by user ,
Required: False ,
}
boolean ,
isArchivedAction:
{
Description: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. ,
Required: False ,
}
boolean ,
executeActionStartTime:
{
Description: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time ,
Format: date-time ,
Required: False ,
}
string ,
executeActionDuration:
{
Description: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation ,
Format: duration ,
Required: False ,
}
string ,
revertActionStartTime:
{
Description: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionDuration:
{
Description: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. ,
Format: duration ,
Required: False ,
}
string ,
executeActionInitiatedBy:
{
Description: Gets if approval for applying this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
executeActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for execution. ,
Format: date-time ,
Required: False ,
}
string ,
revertActionInitiatedBy:
{
Description: Gets if approval for reverting this recommended action was given by user/system. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
revertActionInitiatedTime:
{
Description: Gets the time when this recommended action was approved for revert. ,
Format: date-time ,
Required: False ,
}
string ,
score:
{
Description: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact ,
Format: int32 ,
Required: False ,
}
integer ,
implementationDetails:
{
Description: Gets the implementation details of this recommended action for user to apply it manually. ,
Required: False ,
}
{
method:
{
Description: Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. ,
Enum:
{
TSql: No description available. ,
AzurePowerShell: No description available. ,
}
,
Required: False ,
}
enum ,
script:
{
Description: Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. ,
Required: False ,
}
string ,
}
,
errorDetails:
{
Description: Gets the error details if and why this recommended action is put to error state. ,
Required: False ,
}
{
errorCode:
{
Description: Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists ,
Required: False ,
}
string ,
isRetryable:
{
Description: Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No ,
Enum:
{
Yes: No description available. ,
No: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
estimatedImpact:
{
Description: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
observedImpact:
{
Description: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change ,
Required: False ,
}
[
{
dimensionName:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. ,
Required: False ,
}
string ,
absoluteValue:
{
Description: Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected ,
Format: double ,
Required: False ,
}
number ,
changeValueAbsolute:
{
Description: Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes ,
Format: double ,
Required: False ,
}
number ,
changeValueRelative:
{
Description: Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
timeSeries:
{
Description: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series ,
Required: False ,
}
[
{
metricName:
{
Description: Gets the name of the metric. e.g., CPU, Number of Queries. ,
Required: False ,
}
string ,
unit:
{
Description: Gets the unit in which metric is measured. e.g., DTU, Frequency ,
Required: False ,
}
string ,
timeGrain:
{
Description: Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time of time interval given by this MetricInfo. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: Gets the value of the metric in the time interval given by this MetricInfo. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
linkedObjects:
{
Description: Gets the linked objects, if any. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: Gets additional details specific to this recommended action. ,
Required: False ,
}
object ,
}
,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAutomaticTuning_Get (new)
Description :  Retrieves server automatic tuning options.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/automaticTuning/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAutomaticTuning_Update (new)
Description :  Update automatic tuning options on server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/automaticTuning/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested automatic tuning resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
desiredState:
{
Description: Automatic tuning desired state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
actualState:
{
Description: Automatic tuning actual state. ,
Enum:
{
Custom: No description available. ,
Auto: No description available. ,
Unspecified: No description available. ,
}
,
Required: False ,
}
enum ,
options:
{
Description: Automatic tuning options definition. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAzureADAdministrators_ListByServer (new)
Description :  Gets a list of Azure Active Directory administrators in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAzureADAdministrators_Get (new)
Description :  Gets a Azure Active Directory administrator.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
administratorName:
{
Description: The name of server active directory administrator. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAzureADAdministrators_CreateOrUpdate (new)
Description :  Creates or updates an existing Azure Active Directory administrator.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
administratorName:
{
Description: The name of server active directory administrator. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested Azure Active Directory administrator Resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: True ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
}
ServerAzureADAdministrators_Delete (new)
Description :  Deletes the Azure Active Directory administrator with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/administrators/{administratorName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
administratorName:
{
Description: The name of server active directory administrator. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerAzureADOnlyAuthentications_ListByServer (new)
Description :  Gets a list of server Azure Active Directory only authentications.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/azureADOnlyAuthentications
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAzureADOnlyAuthentications_Get (new)
Description :  Gets a specific Azure Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerAzureADOnlyAuthentications_CreateOrUpdate (new)
Description :  Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for creating or updating an Active Directory only authentication property. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: True ,
}
boolean ,
}
,
}
ServerAzureADOnlyAuthentications_Delete (new)
Description :  Deletes an existing server Active Directory only authentication property.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/azureADOnlyAuthentications/{authenticationName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
authenticationName:
{
Description: The name of server azure active directory only authentication. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerConfigurationOptions_ListByManagedInstance (new)
Description :  Gets a list of managed instance server configuration options.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverConfigurationOptions
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverConfigurationOptionValue:
{
Description: Value of the server configuration option. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of server configuration option. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerConfigurationOptions_Get (new)
Description :  Gets managed instance server configuration option.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverConfigurationOptions/{serverConfigurationOptionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
serverConfigurationOptionName:
{
Description: The name of the server configuration option. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverConfigurationOptionValue:
{
Description: Value of the server configuration option. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of server configuration option. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerConfigurationOptions_CreateOrUpdate (new)
Description :  Updates managed instance server configuration option.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverConfigurationOptions/{serverConfigurationOptionName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
serverConfigurationOptionName:
{
Description: The name of the server configuration option. ,
Required: True ,
}
string ,
parameters:
{
Description: Server configuration option parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverConfigurationOptionValue:
{
Description: Value of the server configuration option. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of server configuration option. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
serverConfigurationOptionValue:
{
Description: Value of the server configuration option. ,
Format: int32 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of server configuration option. ,
Enum:
{
Created: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerConnectionPolicies_ListByServer (new)
Description :  Lists connection policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/connectionPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
connectionType:
{
Description: The server connection type. ,
Enum:
{
Default: No description available. ,
Redirect: No description available. ,
Proxy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerConnectionPolicies_Get (new)
Description :  Gets a server connection policy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/connectionPolicies/{connectionPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
connectionPolicyName:
{
Description: The name of the connection policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
connectionType:
{
Description: The server connection type. ,
Enum:
{
Default: No description available. ,
Redirect: No description available. ,
Proxy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerConnectionPolicies_CreateOrUpdate (new)
Description :  Updates a server connection policy
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/connectionPolicies/{connectionPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
connectionPolicyName:
{
Description: The name of the connection policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The required parameters for updating a server connection policy. ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
connectionType:
{
Description: The server connection type. ,
Enum:
{
Default: No description available. ,
Redirect: No description available. ,
Proxy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
kind:
{
Description: Metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
connectionType:
{
Description: The server connection type. ,
Enum:
{
Default: No description available. ,
Redirect: No description available. ,
Proxy: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerDevOpsAuditSettings_ListByServer (new)
Description :  Lists DevOps audit settings of a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of ServerDevOpsAuditSettingsResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isAzureMonitorTargetEnabled:
{
Description: Specifies whether DevOps audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerDevOpsAuditSettings_Get (new)
Description :  Gets a server's DevOps audit settings.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/{devOpsAuditingSettingsName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
devOpsAuditingSettingsName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ServerDevOpsAuditSettingsResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isAzureMonitorTargetEnabled:
{
Description: Specifies whether DevOps audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerDevOpsAuditSettings_CreateOrUpdate (new)
Description :  Creates or updates a server's DevOps audit settings.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/{devOpsAuditingSettingsName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
devOpsAuditingSettingsName:
{
Required: True ,
}
string ,
parameters:
{
Description: Properties of DevOps audit settings ,
Required: True ,
}
{
systemData:
{
Description: SystemData of ServerDevOpsAuditSettingsResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isAzureMonitorTargetEnabled:
{
Description: Specifies whether DevOps audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of ServerDevOpsAuditSettingsResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
isAzureMonitorTargetEnabled:
{
Description: Specifies whether DevOps audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true. When using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207) or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043) ,
Required: False ,
}
boolean ,
isManagedIdentityInUse:
{
Description: Specifies whether Managed Identity is used to access blob storage ,
Required: False ,
}
boolean ,
state:
{
Description: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355) ,
Required: False ,
}
string ,
storageAccountSubscriptionId:
{
Description: Specifies the blob storage subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerDnsAliases_ListByServer (new)
Description :  Gets a list of server DNS aliases for a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server that the alias is pointing to. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for alias ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerDnsAliases_Get (new)
Description :  Gets a server DNS alias.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server that the alias is pointing to. ,
Required: True ,
}
string ,
dnsAliasName:
{
Description: The name of the server dns alias. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerDnsAliases_CreateOrUpdate (new)
Description :  Creates a server DNS alias.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server that the alias is pointing to. ,
Required: True ,
}
string ,
dnsAliasName:
{
Description: The name of the server dns alias. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for alias ,
Required: False ,
}
string ,
}
,
}
ServerDnsAliases_Delete (new)
Description :  Deletes the server DNS alias with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server that the alias is pointing to. ,
Required: True ,
}
string ,
dnsAliasName:
{
Description: The name of the server dns alias. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerDnsAliases_Acquire (new)
Description :  Acquires server DNS alias from another server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}/acquire
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server that the alias is pointing to. ,
Required: True ,
}
string ,
dnsAliasName:
{
Description: The name of the server dns alias. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
oldServerDnsAliasId:
{
Description: The id of the server alias that will be acquired to point to this server instead. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
azureDnsRecord:
{
Description: The fully qualified DNS record for alias ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerKeys_ListByServer (new)
Description :  Gets a list of server keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The server key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The server key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerKeys_Get (new)
Description :  Gets a server key.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the server key to be retrieved. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The server key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The server key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerKeys_CreateOrUpdate (new)
Description :  Creates or updates a server key.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion ,
Required: True ,
}
string ,
parameters:
{
Description: The requested server key resource state. ,
Required: True ,
}
{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The server key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The server key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The server key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The server key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of encryption protector. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subregion:
{
Description: Subregion of the server key. ,
Required: False ,
}
string ,
serverKeyType:
{
Description: The server key type like 'ServiceManaged', 'AzureKeyVault'. ,
Enum:
{
ServiceManaged: No description available. ,
AzureKeyVault: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ,
Required: False ,
}
string ,
thumbprint:
{
Description: Thumbprint of the server key. ,
Required: False ,
}
string ,
creationDate:
{
Description: The server key creation date. ,
Format: date-time ,
Required: False ,
}
string ,
autoRotationEnabled:
{
Description: Key auto rotation opt-in flag. Either true or false. ,
Required: False ,
}
boolean ,
}
,
}
ServerKeys_Delete (new)
Description :  Deletes the server key with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
keyName:
{
Description: The name of the server key to be deleted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerOperations_ListByServer (new)
Description :  Gets a list of operations performed on the server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/operations
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
operation:
{
Description: The name of operation. ,
Required: False ,
}
string ,
operationFriendlyName:
{
Description: The friendly name of operation. ,
Required: False ,
}
string ,
percentComplete:
{
Description: The percentage of the operation completed. ,
Format: int32 ,
Required: False ,
}
integer ,
serverName:
{
Description: The name of the server. ,
Required: False ,
}
string ,
startTime:
{
Description: The operation start time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The operation state. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
CancelInProgress: No description available. ,
Cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: The operation error code. ,
Format: int32 ,
Required: False ,
}
integer ,
errorDescription:
{
Description: The operation error description. ,
Required: False ,
}
string ,
errorSeverity:
{
Description: The operation error severity. ,
Format: int32 ,
Required: False ,
}
integer ,
isUserError:
{
Description: Whether or not the error is a user error. ,
Required: False ,
}
boolean ,
estimatedCompletionTime:
{
Description: The estimated completion time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
isCancellable:
{
Description: Whether the operation can be cancelled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerSecurityAlertPolicies_ListByServer (new)
Description :  Get the server's threat detection policies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerSecurityAlertPolicies_Get (new)
Description :  Get a server's security alert policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the security alert policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerSecurityAlertPolicies_CreateOrUpdate (new)
Description :  Creates or updates a threat detection policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
securityAlertPolicyName:
{
Description: The name of the threat detection policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The server security alert policy. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SecurityAlertPolicyResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
disabledAlerts:
{
Description: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Specifies an array of e-mail addresses to which the alert is sent. ,
Required: False ,
}
[
string ,
]
,
emailAccountAdmins:
{
Description: Specifies that the alert is sent to the account administrators. ,
Required: False ,
}
boolean ,
storageEndpoint:
{
Description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the Threat Detection audit storage account. ,
Required: False ,
}
string ,
retentionDays:
{
Description: Specifies the number of days to keep in the Threat Detection audit logs. ,
Format: int32 ,
Required: False ,
}
integer ,
creationTime:
{
Description: Specifies the UTC creation time of the policy. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
ServerTrustCertificates_ListByInstance (new)
Description :  Gets a list of the server trust certificates used to secure communication between SQL Server and the specified SQL Managed Instance
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustCertificates
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint ,
Required: False ,
}
string ,
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerTrustCertificates_Get (new)
Description :  Gets a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustCertificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of of the certificate to get. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint ,
Required: False ,
}
string ,
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerTrustCertificates_CreateOrUpdate (new)
Description :  Uploads a server trust certificate from SQL Server to SQL Managed Instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustCertificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of of the certificate to upload. ,
Required: True ,
}
string ,
parameters:
{
Description: The server trust certificate info. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint ,
Required: False ,
}
string ,
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint ,
Required: False ,
}
string ,
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
publicBlob:
{
Description: The certificate public blob ,
Required: False ,
}
string ,
thumbprint:
{
Description: The certificate thumbprint ,
Required: False ,
}
string ,
certificateName:
{
Description: The certificate name ,
Required: False ,
}
string ,
}
,
}
ServerTrustCertificates_Delete (new)
Description :  Deletes a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustCertificates/{certificateName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
certificateName:
{
Description: Name of of the certificate to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerTrustGroups_ListByLocation (new)
Description :  Lists a server trust group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerTrustGroups_Get (new)
Description :  Gets a server trust group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups/{serverTrustGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
serverTrustGroupName:
{
Description: The name of the server trust group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerTrustGroups_CreateOrUpdate (new)
Description :  Creates or updates a server trust group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups/{serverTrustGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
serverTrustGroupName:
{
Description: The name of the server trust group. ,
Required: True ,
}
string ,
parameters:
{
Description: The server trust group parameters. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}
ServerTrustGroups_Delete (new)
Description :  Deletes a server trust group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups/{serverTrustGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
serverTrustGroupName:
{
Description: The name of the server trust group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
ServerTrustGroups_ListByInstance (new)
Description :  Gets a server trust groups by instance name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupMembers:
{
Description: Group members information for the server trust group. ,
Required: True ,
}
[
{
serverId:
{
Description: Server Id. ,
Required: True ,
}
string ,
}
,
]
,
trustScopes:
{
Description: Trust scope of the server trust group. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerUsages_ListByServer (new)
Description :  Gets server usages.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/usages
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
displayName:
{
Description: User-readable name of the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: Boundary value of the metric. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerVulnerabilityAssessments_ListByServer (new)
Description :  Lists the vulnerability assessment policies associated with a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerVulnerabilityAssessments_Get (new)
Description :  Gets the server's vulnerability assessment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerVulnerabilityAssessments_CreateOrUpdate (new)
Description :  Creates or updates the server's vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested resource. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
storageContainerPath:
{
Description: A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). ,
Required: True ,
}
string ,
storageContainerSasKey:
{
Description: A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
storageAccountAccessKey:
{
Description: Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall ,
Required: False ,
}
string ,
recurringScans:
{
Description: The recurring scans settings ,
Required: False ,
}
{
isEnabled:
{
Description: Recurring scans state. ,
Required: False ,
}
boolean ,
emailSubscriptionAdmins:
{
Description: Specifies that the schedule scan notification will be is sent to the subscription administrators. ,
Required: False ,
}
boolean ,
emails:
{
Description: Specifies an array of e-mail addresses to which the scan notification is sent. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerVulnerabilityAssessments_Delete (new)
Description :  Removes the server's vulnerability assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server for which the vulnerability assessment is defined. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_CheckNameAvailability (new)
Description :  Determines whether a resource can be created with the specified name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability
{
parameters:
{
Description: The name availability request parameters. ,
Required: True ,
}
{
name:
{
Required: True ,
}
string ,
type:
{
Enum:
{
Microsoft.Sql/servers: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name whose availability was checked. ,
Required: False ,
}
string ,
available:
{
Description: True if the name is available, otherwise false. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason code explaining why the name is unavailable. Will be undefined if the name is available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A message explaining why the name is unavailable. Will be undefined if the name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_List (new)
Description :  Gets a list of all servers in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers
{
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (new)
Description :  Gets a list of servers in a resource groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_Get (new)
Description :  Gets a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
$expand:
{
Description: The child resources to include in the response. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Servers_CreateOrUpdate (new)
Description :  Creates or updates a server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested server resource state. ,
Required: True ,
}
{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
Servers_Delete (new)
Description :  Deletes a server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
Servers_Update (new)
Description :  Updates a server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested server resource state. ,
Required: True ,
}
{
identity:
{
Description: Server identity ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The Azure Active Directory identity of the server. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The resource ids of the user assigned identities to use ,
Required: False ,
}
object ,
principalId:
{
Description: The Azure Active Directory principal id. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The Azure Active Directory tenant id. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Kind of sql server. This is metadata used for the Azure portal experience. ,
Required: False ,
}
string ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
administratorLogin:
{
Description: Administrator username for the server. Once created it cannot be changed. ,
Required: False ,
}
string ,
administratorLoginPassword:
{
Description: The administrator login password (required for server creation). ,
Required: False ,
}
string ,
version:
{
Description: The version of the server. ,
Required: False ,
}
string ,
state:
{
Description: The state of the server. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: The fully qualified domain name of the server. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections on a server ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group IDs. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Enum:
{
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Enum:
{
Approving: No description available. ,
Ready: No description available. ,
Dropping: No description available. ,
Failed: No description available. ,
Rejecting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
minimalTlsVersion:
{
Description: Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' ,
Enum:
{
None: No description available. ,
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
workspaceFeature:
{
Description: Whether or not existing server has a workspace created and if it allows connection from workspace ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
primaryUserAssignedIdentityId:
{
Description: The resource id of a user assigned identity to be used by default. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: The Client id used for cross tenant CMK scenario ,
Format: uuid ,
Required: False ,
}
string ,
keyId:
{
Description: A CMK URI of the key to use for encryption. ,
Required: False ,
}
string ,
administrators:
{
Description: The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used. ,
Required: False ,
}
{
administratorType:
{
Description: Type of the sever administrator. ,
Enum:
{
ActiveDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
principalType:
{
Description: Principal Type of the sever administrator. ,
Enum:
{
User: No description available. ,
Group: No description available. ,
Application: No description available. ,
}
,
Required: False ,
}
enum ,
login:
{
Description: Login name of the server administrator. ,
Required: False ,
}
string ,
sid:
{
Description: SID (object ID) of the server administrator. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID of the administrator. ,
Format: uuid ,
Required: False ,
}
string ,
azureADOnlyAuthentication:
{
Description: Azure Active Directory only Authentication enabled. ,
Required: False ,
}
boolean ,
}
,
restrictOutboundNetworkAccess:
{
Description: Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isIPv6Enabled:
{
Description: Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
externalGovernanceStatus:
{
Description: Status of external governance. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Servers_ImportDatabase (new)
Description :  Imports a bacpac into a new database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/import
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The database import request parameters. ,
Required: True ,
}
{
databaseName:
{
Description: Name of the import database. ,
Required: False ,
}
string ,
edition:
{
Description: Edition of the import database. ,
Required: False ,
}
string ,
serviceObjectiveName:
{
Description: Service level objective name of the import database. ,
Required: False ,
}
string ,
maxSizeBytes:
{
Description: Max size in bytes for the import database. ,
Required: False ,
}
string ,
storageKeyType:
{
Description: Storage key type. ,
Enum:
{
SharedAccessKey: No description available. ,
StorageAccessKey: No description available. ,
}
,
Required: True ,
}
enum ,
storageKey:
{
Description: Storage key. ,
Required: True ,
}
string ,
storageUri:
{
Description: Storage Uri. ,
Required: True ,
}
string ,
administratorLogin:
{
Description: Administrator login name. ,
Required: True ,
}
string ,
administratorLoginPassword:
{
Description: Administrator login password. ,
Required: True ,
}
string ,
authenticationType:
{
Description: Authentication type. ,
Required: False ,
}
string ,
networkIsolation:
{
Description: Optional resource information to enable network isolation for request. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter. ,
Format: arm-id ,
Required: False ,
}
string ,
sqlServerResourceId:
{
Description: The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last modified time. ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob Uri. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: Gets the status of private endpoints associated with this request. ,
Required: False ,
}
[
{
privateLinkServiceId:
{
Description: Resource id for which the private endpoint is created. ,
Required: False ,
}
string ,
privateEndpointConnectionName:
{
Description: The connection name for the private endpoint. ,
Required: False ,
}
string ,
status:
{
Description: Status of this private endpoint connection. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
Servers_RefreshStatus (new)
Description :  Refresh external governance enablement status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/refreshExternalGovernanceStatus
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
requestId:
{
Description: Request Id. ,
Format: uuid ,
Required: False ,
}
string ,
requestType:
{
Description: Request type. ,
Required: False ,
}
string ,
queuedTime:
{
Description: Queued time. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SqlAgent_Get (new)
Description :  Gets current instance sql agent configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/sqlAgent/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of Sql Agent. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlAgent_CreateOrUpdate (new)
Description :  Puts new sql agent configuration to instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/sqlAgent/current
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of Sql Agent. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: The state of Sql Agent. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentBaseline_ListBySqlVulnerabilityAssessment (new)
Description :  Gets a list of database's sql vulnerability assessment rule baselines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentBaseline_Get (new)
Description :  Gets a list of database's sql vulnerability assessment rule baselines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentBaselines_CreateOrUpdate (new)
Description :  Add a database's vulnerability assessment rule baseline list.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineListInputResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
latestScan:
{
Description: The latest scan flag ,
Required: True ,
}
boolean ,
results:
{
Description: The rule baseline result list ,
Required: True ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentBaselineSetResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The baseline set result ,
Required: True ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentExecuteScan_Execute (new)
Description :  Executes a Vulnerability Assessment database scan.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/initiateScan
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SqlVulnerabilityAssessmentRuleBaseline_ListByBaseline (new)
Description :  Gets a system database's sql vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentRuleBaseline_Get (new)
Description :  Gets a system database's sql vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentRuleBaseline_CreateOrUpdate (new)
Description :  Creates or updates a database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested rule baseline resource. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineInputResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
latestScan:
{
Description: The latest scan flag ,
Required: True ,
}
boolean ,
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
results:
{
Description: The rule baseline result ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentRuleBaselines_Delete (new)
Description :  Removes the database's vulnerability assessment rule baseline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/baselines/{baselineName}/rules/{ruleId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
baselineName:
{
Required: True ,
}
string ,
ruleId:
{
Description: The vulnerability assessment rule ID. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SqlVulnerabilityAssessmentScanResult_ListByScan (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/scanResults
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The scan id of the SQL Vulnerability Assessment scan to retrieve result from. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The SQL vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
status:
{
Description: SQL Vulnerability Assessment rule result status. ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: SQL Vulnerability Assessment error message. ,
Required: False ,
}
string ,
isTrimmed:
{
Description: SQL Vulnerability Assessment is the query results trimmed. ,
Required: False ,
}
boolean ,
queryResults:
{
Description: SQL Vulnerability Assessment query results that was run. ,
Required: False ,
}
[
string ,
]
,
remediation:
{
Description: SQL Vulnerability Assessment the remediation details. ,
Required: False ,
}
{
description:
{
Description: SQL Vulnerability Assessment remediation description. ,
Required: False ,
}
string ,
scripts:
{
Description: SQL Vulnerability Assessment remediation script. ,
Required: False ,
}
[
string ,
]
,
automated:
{
Description: SQL Vulnerability Assessment is remediation automated. ,
Required: False ,
}
boolean ,
portalLink:
{
Description: SQL Vulnerability Assessment optional link to remediate in Azure Portal. ,
Required: False ,
}
string ,
}
,
baselineAdjustedResult:
{
Description: SQL Vulnerability Assessment rule result adjusted with baseline. ,
Required: False ,
}
{
baseline:
{
Description: SQL Vulnerability Assessment baseline details ,
Required: False ,
}
{
expectedResults:
{
Description: SQL Vulnerability Assessment baseline expected results ,
Required: False ,
}
[
string ,
]
,
updatedTime:
{
Description: SQL Vulnerability Assessment baseline update time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
status:
{
Description: SQL Vulnerability Assessment baseline status ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
resultsNotInBaseline:
{
Description: SQL Vulnerability Assessment results that are not in baseline ,
Required: False ,
}
[
string ,
]
,
resultsOnlyInBaseline:
{
Description: SQL Vulnerability Assessment results that are in baseline. ,
Required: False ,
}
[
string ,
]
,
}
,
ruleMetadata:
{
Description: SQL Vulnerability Assessment rule metadata. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
severity:
{
Description: SQL Vulnerability Assessment rule severity. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
Obsolete: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: SQL Vulnerability Assessment rule category. ,
Required: False ,
}
string ,
ruleType:
{
Description: SQL Vulnerability Assessment rule type. ,
Enum:
{
Binary: No description available. ,
BaselineExpected: No description available. ,
PositiveList: No description available. ,
NegativeList: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: SQL Vulnerability Assessment rule title. ,
Required: False ,
}
string ,
description:
{
Description: SQL Vulnerability Assessment rule description. ,
Required: False ,
}
string ,
rationale:
{
Description: SQL Vulnerability Assessment rule rationale. ,
Required: False ,
}
string ,
queryCheck:
{
Description: SQL Vulnerability Assessment rule query details. ,
Required: False ,
}
{
query:
{
Description: SQL Vulnerability Assessment rule query. ,
Required: False ,
}
string ,
expectedResult:
{
Description: SQL Vulnerability Assessment query expected result. ,
Required: False ,
}
[
string ,
]
,
columnNames:
{
Description: SQL Vulnerability Assessment column names of query expected result. ,
Required: False ,
}
[
string ,
]
,
}
,
benchmarkReferences:
{
Description: SQL Vulnerability Assessment benchmark references. ,
Required: False ,
}
[
{
benchmark:
{
Description: SQL Vulnerability Assessment benchmark name ,
Required: False ,
}
string ,
reference:
{
Description: SQL Vulnerability Assessment benchmark reference. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentScanResult_Get (new)
Description :  Gets a vulnerability assessment scan record of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/scanResults/{scanResultId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
scanId:
{
Description: The scan id of the SQL Vulnerability Assessment scan to retrieve result from. ,
Required: True ,
}
string ,
scanResultId:
{
Description: The scan result id of the specific result to retrieve. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The SQL vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of AdvancedThreatProtectionResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
status:
{
Description: SQL Vulnerability Assessment rule result status. ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: SQL Vulnerability Assessment error message. ,
Required: False ,
}
string ,
isTrimmed:
{
Description: SQL Vulnerability Assessment is the query results trimmed. ,
Required: False ,
}
boolean ,
queryResults:
{
Description: SQL Vulnerability Assessment query results that was run. ,
Required: False ,
}
[
string ,
]
,
remediation:
{
Description: SQL Vulnerability Assessment the remediation details. ,
Required: False ,
}
{
description:
{
Description: SQL Vulnerability Assessment remediation description. ,
Required: False ,
}
string ,
scripts:
{
Description: SQL Vulnerability Assessment remediation script. ,
Required: False ,
}
[
string ,
]
,
automated:
{
Description: SQL Vulnerability Assessment is remediation automated. ,
Required: False ,
}
boolean ,
portalLink:
{
Description: SQL Vulnerability Assessment optional link to remediate in Azure Portal. ,
Required: False ,
}
string ,
}
,
baselineAdjustedResult:
{
Description: SQL Vulnerability Assessment rule result adjusted with baseline. ,
Required: False ,
}
{
baseline:
{
Description: SQL Vulnerability Assessment baseline details ,
Required: False ,
}
{
expectedResults:
{
Description: SQL Vulnerability Assessment baseline expected results ,
Required: False ,
}
[
string ,
]
,
updatedTime:
{
Description: SQL Vulnerability Assessment baseline update time (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
status:
{
Description: SQL Vulnerability Assessment baseline status ,
Enum:
{
NonFinding: No description available. ,
Finding: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
resultsNotInBaseline:
{
Description: SQL Vulnerability Assessment results that are not in baseline ,
Required: False ,
}
[
string ,
]
,
resultsOnlyInBaseline:
{
Description: SQL Vulnerability Assessment results that are in baseline. ,
Required: False ,
}
[
string ,
]
,
}
,
ruleMetadata:
{
Description: SQL Vulnerability Assessment rule metadata. ,
Required: False ,
}
{
ruleId:
{
Description: SQL Vulnerability Assessment rule Id. ,
Required: False ,
}
string ,
severity:
{
Description: SQL Vulnerability Assessment rule severity. ,
Enum:
{
High: No description available. ,
Medium: No description available. ,
Low: No description available. ,
Informational: No description available. ,
Obsolete: No description available. ,
}
,
Required: False ,
}
enum ,
category:
{
Description: SQL Vulnerability Assessment rule category. ,
Required: False ,
}
string ,
ruleType:
{
Description: SQL Vulnerability Assessment rule type. ,
Enum:
{
Binary: No description available. ,
BaselineExpected: No description available. ,
PositiveList: No description available. ,
NegativeList: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: SQL Vulnerability Assessment rule title. ,
Required: False ,
}
string ,
description:
{
Description: SQL Vulnerability Assessment rule description. ,
Required: False ,
}
string ,
rationale:
{
Description: SQL Vulnerability Assessment rule rationale. ,
Required: False ,
}
string ,
queryCheck:
{
Description: SQL Vulnerability Assessment rule query details. ,
Required: False ,
}
{
query:
{
Description: SQL Vulnerability Assessment rule query. ,
Required: False ,
}
string ,
expectedResult:
{
Description: SQL Vulnerability Assessment query expected result. ,
Required: False ,
}
[
string ,
]
,
columnNames:
{
Description: SQL Vulnerability Assessment column names of query expected result. ,
Required: False ,
}
[
string ,
]
,
}
,
benchmarkReferences:
{
Description: SQL Vulnerability Assessment benchmark references. ,
Required: False ,
}
[
{
benchmark:
{
Description: SQL Vulnerability Assessment benchmark name ,
Required: False ,
}
string ,
reference:
{
Description: SQL Vulnerability Assessment benchmark reference. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentScans_ListBySqlVulnerabilityAssessments (new)
Description :  Lists the vulnerability assessment scans of a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentScanRecordResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
server:
{
Description: The server name. ,
Required: False ,
}
string ,
database:
{
Description: The database name. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
highSeverityFailedRulesCount:
{
Description: The number of failed rules with high severity. ,
Format: int32 ,
Required: False ,
}
integer ,
mediumSeverityFailedRulesCount:
{
Description: The number of failed rules with medium severity. ,
Format: int32 ,
Required: False ,
}
integer ,
lowSeverityFailedRulesCount:
{
Description: The number of failed rules with low severity. ,
Format: int32 ,
Required: False ,
}
integer ,
totalPassedRulesCount:
{
Description: The number of total passed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalFailedRulesCount:
{
Description: The number of total failed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRulesCount:
{
Description: The number of total rules assessed. ,
Format: int32 ,
Required: False ,
}
integer ,
isBaselineApplied:
{
Description: Baseline created for this database, and has one or more rules. ,
Required: False ,
}
boolean ,
lastScanTime:
{
Description: The last scan time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentScans_Get (new)
Description :  Get a system database vulnerability assessment scan record.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the vulnerability assessment. ,
Required: True ,
}
string ,
scanId:
{
Required: True ,
}
string ,
systemDatabaseName:
{
Description: The vulnerability assessment system database name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentScanRecordResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
scanId:
{
Description: The scan ID. ,
Required: False ,
}
string ,
triggerType:
{
Description: The scan trigger type. ,
Enum:
{
OnDemand: No description available. ,
Recurring: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The scan status. ,
Enum:
{
Passed: No description available. ,
Failed: No description available. ,
FailedToRun: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The scan start time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The scan end time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The scan errors. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
server:
{
Description: The server name. ,
Required: False ,
}
string ,
database:
{
Description: The database name. ,
Required: False ,
}
string ,
sqlVersion:
{
Description: The SQL version. ,
Required: False ,
}
string ,
highSeverityFailedRulesCount:
{
Description: The number of failed rules with high severity. ,
Format: int32 ,
Required: False ,
}
integer ,
mediumSeverityFailedRulesCount:
{
Description: The number of failed rules with medium severity. ,
Format: int32 ,
Required: False ,
}
integer ,
lowSeverityFailedRulesCount:
{
Description: The number of failed rules with low severity. ,
Format: int32 ,
Required: False ,
}
integer ,
totalPassedRulesCount:
{
Description: The number of total passed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalFailedRulesCount:
{
Description: The number of total failed rules. ,
Format: int32 ,
Required: False ,
}
integer ,
totalRulesCount:
{
Description: The number of total rules assessed. ,
Format: int32 ,
Required: False ,
}
integer ,
isBaselineApplied:
{
Description: Baseline created for this database, and has one or more rules. ,
Required: False ,
}
boolean ,
lastScanTime:
{
Description: The last scan time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentsSettings_ListByServer (new)
Description :  Lists SQL Vulnerability Assessment policies associated with a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentsSettings_Get (new)
Description :  Gets SQL Vulnerability Assessment policy.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SqlVulnerabilityAssessmentsSettings_CreateOrUpdate (new)
Description :  Creates or updates SQL Vulnerability Assessment policy.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested resource. ,
Required: True ,
}
{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: SystemData of SqlVulnerabilityAssessmentResource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
SqlVulnerabilityAssessments_Delete (new)
Description :  Removes SQL Vulnerability Assessment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/{vulnerabilityAssessmentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
vulnerabilityAssessmentName:
{
Description: The name of the SQL Vulnerability Assessment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
StartStopManagedInstanceSchedules_ListByInstance (new)
Description :  Lists the managed instance's Start/Stop schedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/startStopSchedules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
systemData:
{
Description: System data of the scheduled resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: The description of the schedule. ,
Required: False ,
}
string ,
timeZoneId:
{
Description: The time zone of the schedule. ,
Required: False ,
}
string ,
scheduleList:
{
Description: Schedule list. ,
Required: True ,
}
[
{
startDay:
{
Description: Start day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time. ,
Required: True ,
}
string ,
stopDay:
{
Description: Stop day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
stopTime:
{
Description: Stop time. ,
Required: True ,
}
string ,
}
,
]
,
nextRunAction:
{
Description: Next action to be executed (Start or Stop) ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Timestamp when the next action will be executed in the corresponding schedule time zone. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StartStopManagedInstanceSchedules_Get (new)
Description :  Gets the managed instance's Start/Stop schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/startStopSchedules/{startStopScheduleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
startStopScheduleName:
{
Description: Name of the managed instance Start/Stop schedule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: System data of the scheduled resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: The description of the schedule. ,
Required: False ,
}
string ,
timeZoneId:
{
Description: The time zone of the schedule. ,
Required: False ,
}
string ,
scheduleList:
{
Description: Schedule list. ,
Required: True ,
}
[
{
startDay:
{
Description: Start day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time. ,
Required: True ,
}
string ,
stopDay:
{
Description: Stop day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
stopTime:
{
Description: Stop time. ,
Required: True ,
}
string ,
}
,
]
,
nextRunAction:
{
Description: Next action to be executed (Start or Stop) ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Timestamp when the next action will be executed in the corresponding schedule time zone. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StartStopManagedInstanceSchedules_CreateOrUpdate (new)
Description :  Creates or updates the managed instance's Start/Stop schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/startStopSchedules/{startStopScheduleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
startStopScheduleName:
{
Description: Name of the managed instance Start/Stop schedule. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested managed instance Start/Stop schedule. ,
Required: True ,
}
{
systemData:
{
Description: System data of the scheduled resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: The description of the schedule. ,
Required: False ,
}
string ,
timeZoneId:
{
Description: The time zone of the schedule. ,
Required: False ,
}
string ,
scheduleList:
{
Description: Schedule list. ,
Required: True ,
}
[
{
startDay:
{
Description: Start day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time. ,
Required: True ,
}
string ,
stopDay:
{
Description: Stop day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
stopTime:
{
Description: Stop time. ,
Required: True ,
}
string ,
}
,
]
,
nextRunAction:
{
Description: Next action to be executed (Start or Stop) ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Timestamp when the next action will be executed in the corresponding schedule time zone. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: System data of the scheduled resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: The description of the schedule. ,
Required: False ,
}
string ,
timeZoneId:
{
Description: The time zone of the schedule. ,
Required: False ,
}
string ,
scheduleList:
{
Description: Schedule list. ,
Required: True ,
}
[
{
startDay:
{
Description: Start day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time. ,
Required: True ,
}
string ,
stopDay:
{
Description: Stop day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
stopTime:
{
Description: Stop time. ,
Required: True ,
}
string ,
}
,
]
,
nextRunAction:
{
Description: Next action to be executed (Start or Stop) ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Timestamp when the next action will be executed in the corresponding schedule time zone. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: System data of the scheduled resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
description:
{
Description: The description of the schedule. ,
Required: False ,
}
string ,
timeZoneId:
{
Description: The time zone of the schedule. ,
Required: False ,
}
string ,
scheduleList:
{
Description: Schedule list. ,
Required: True ,
}
[
{
startDay:
{
Description: Start day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time. ,
Required: True ,
}
string ,
stopDay:
{
Description: Stop day. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: True ,
}
enum ,
stopTime:
{
Description: Stop time. ,
Required: True ,
}
string ,
}
,
]
,
nextRunAction:
{
Description: Next action to be executed (Start or Stop) ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Timestamp when the next action will be executed in the corresponding schedule time zone. ,
Required: False ,
}
string ,
}
,
}
StartStopManagedInstanceSchedules_Delete (new)
Description :  Deletes the managed instance's Start/Stop schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/startStopSchedules/{startStopScheduleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
managedInstanceName:
{
Description: The name of the managed instance. ,
Required: True ,
}
string ,
startStopScheduleName:
{
Description: Name of the managed instance Start/Stop schedule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (204)

{}
SubscriptionUsages_ListByLocation (new)
Description :  Gets all subscription usage metrics in a given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/usages
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
displayName:
{
Description: User-readable name of the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: Boundary value of the metric. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SubscriptionUsages_Get (new)
Description :  Gets a subscription usage metric.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/usages/{usageName}
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
usageName:
{
Description: Name of usage metric to return. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
displayName:
{
Description: User-readable name of the metric. ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of the metric. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: Boundary value of the metric. ,
Format: double ,
Required: False ,
}
number ,
unit:
{
Description: Unit of the metric. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SynapseLinkWorkspaces_ListByDatabase (new)
Description :  Gets all synapselink workspaces for a database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/linkWorkspaces
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
workspaces:
{
Description: List of all synapselink workspaces ,
Required: False ,
}
[
{
workspaceId:
{
Description: Synapse link workspace id. ,
Required: False ,
}
string ,
linkConnectionName:
{
Description: Link connection name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncAgents_ListByServer (new)
Description :  Lists sync agents in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
name:
{
Description: Name of the sync agent. ,
Required: False ,
}
string ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync agent. ,
Required: False ,
}
string ,
lastAliveTime:
{
Description: Last alive time of the sync agent. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of the sync agent. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
NeverConnected: No description available. ,
}
,
Required: False ,
}
enum ,
isUpToDate:
{
Description: If the sync agent version is up to date. ,
Required: False ,
}
boolean ,
expiryTime:
{
Description: Expiration time of the sync agent version. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the sync agent. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncAgents_Get (new)
Description :  Gets a sync agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
syncAgentName:
{
Description: The name of the sync agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
name:
{
Description: Name of the sync agent. ,
Required: False ,
}
string ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync agent. ,
Required: False ,
}
string ,
lastAliveTime:
{
Description: Last alive time of the sync agent. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of the sync agent. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
NeverConnected: No description available. ,
}
,
Required: False ,
}
enum ,
isUpToDate:
{
Description: If the sync agent version is up to date. ,
Required: False ,
}
boolean ,
expiryTime:
{
Description: Expiration time of the sync agent version. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the sync agent. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncAgents_CreateOrUpdate (new)
Description :  Creates or updates a sync agent.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
syncAgentName:
{
Description: The name of the sync agent. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested sync agent resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
name:
{
Description: Name of the sync agent. ,
Required: False ,
}
string ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync agent. ,
Required: False ,
}
string ,
lastAliveTime:
{
Description: Last alive time of the sync agent. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of the sync agent. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
NeverConnected: No description available. ,
}
,
Required: False ,
}
enum ,
isUpToDate:
{
Description: If the sync agent version is up to date. ,
Required: False ,
}
boolean ,
expiryTime:
{
Description: Expiration time of the sync agent version. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the sync agent. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
name:
{
Description: Name of the sync agent. ,
Required: False ,
}
string ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync agent. ,
Required: False ,
}
string ,
lastAliveTime:
{
Description: Last alive time of the sync agent. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of the sync agent. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
NeverConnected: No description available. ,
}
,
Required: False ,
}
enum ,
isUpToDate:
{
Description: If the sync agent version is up to date. ,
Required: False ,
}
boolean ,
expiryTime:
{
Description: Expiration time of the sync agent version. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the sync agent. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
name:
{
Description: Name of the sync agent. ,
Required: False ,
}
string ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync agent. ,
Required: False ,
}
string ,
lastAliveTime:
{
Description: Last alive time of the sync agent. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: State of the sync agent. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
NeverConnected: No description available. ,
}
,
Required: False ,
}
enum ,
isUpToDate:
{
Description: If the sync agent version is up to date. ,
Required: False ,
}
boolean ,
expiryTime:
{
Description: Expiration time of the sync agent version. ,
Format: date-time ,
Required: False ,
}
string ,
version:
{
Description: Version of the sync agent. ,
Required: False ,
}
string ,
}
,
}
SyncAgents_Delete (new)
Description :  Deletes a sync agent.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
syncAgentName:
{
Description: The name of the sync agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SyncAgents_GenerateKey (new)
Description :  Generates a sync agent key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
syncAgentName:
{
Description: The name of the sync agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
syncAgentKey:
{
Description: Key of sync agent. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncAgents_ListLinkedDatabases (new)
Description :  Lists databases linked to a sync agent.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server on which the sync agent is hosted. ,
Required: True ,
}
string ,
syncAgentName:
{
Description: The name of the sync agent. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Type of the sync agent linked database. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
databaseId:
{
Description: Id of the sync agent linked database. ,
Required: False ,
}
string ,
description:
{
Description: Description of the sync agent linked database. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the sync agent linked database. ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the sync agent linked database. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the sync agent linked database. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_ListSyncDatabaseIds (new)
Description :  Gets a collection of sync database ids.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/syncDatabaseIds
{
locationName:
{
Description: The name of the region where the resource is located. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
id:
{
Description: ARM resource id of sync database. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_ListByDatabase (new)
Description :  Lists sync groups under a hub database.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_Get (new)
Description :  Gets a sync group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_CreateOrUpdate (new)
Description :  Creates or updates a sync group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested sync group resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}
SyncGroups_Delete (new)
Description :  Deletes a sync group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SyncGroups_Update (new)
Description :  Updates a sync group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested sync group resource state. ,
Required: True ,
}
{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The name and capacity of the SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU, typically, a letter + Number code, e.g. P3. ,
Required: True ,
}
string ,
tier:
{
Description: The tier or edition of the particular SKU, e.g. Basic, Premium. ,
Required: False ,
}
string ,
size:
{
Description: Size of the particular SKU ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: Capacity of the particular SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
interval:
{
Description: Sync interval of the sync group. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncTime:
{
Description: Last sync time of the sync group. ,
Format: date-time ,
Required: False ,
}
string ,
conflictResolutionPolicy:
{
Description: Conflict resolution policy of the sync group. ,
Enum:
{
HubWin: No description available. ,
MemberWin: No description available. ,
}
,
Required: False ,
}
enum ,
syncDatabaseId:
{
Description: ARM resource id of the sync database in the sync group. ,
Required: False ,
}
string ,
hubDatabaseUserName:
{
Description: User name for the sync group hub database credential. ,
Required: False ,
}
string ,
hubDatabasePassword:
{
Description: Password for the sync group hub database credential. ,
Required: False ,
}
string ,
syncState:
{
Description: Sync state of the sync group. ,
Enum:
{
NotReady: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Progressing: No description available. ,
Good: No description available. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: Sync schema of the sync group. ,
Required: False ,
}
{
tables:
{
Description: List of tables in sync group schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in sync group schema. ,
Required: False ,
}
[
{
quotedName:
{
Description: Quoted name of sync group table column. ,
Required: False ,
}
string ,
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
}
,
]
,
quotedName:
{
Description: Quoted name of sync group schema table. ,
Required: False ,
}
string ,
}
,
]
,
masterSyncMemberName:
{
Description: Name of master sync member where the schema is from. ,
Required: False ,
}
string ,
}
,
enableConflictLogging:
{
Description: If conflict logging is enabled. ,
Required: False ,
}
boolean ,
conflictLoggingRetentionInDays:
{
Description: Conflict logging retention period. ,
Format: int32 ,
Required: False ,
}
integer ,
usePrivateLinkConnection:
{
Description: If use private link connection is enabled. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync group if use private link connection is enabled. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SyncGroups_CancelSync (new)
Description :  Cancels a sync group synchronization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/cancelSync
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_ListHubSchemas (new)
Description :  Gets a collection of hub database schemas.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
tables:
{
Description: List of tables in the database full schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in the table of database full schema. ,
Required: False ,
}
[
{
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
errorId:
{
Description: Error id of the column. ,
Required: False ,
}
string ,
hasError:
{
Description: If there is error in the table. ,
Required: False ,
}
boolean ,
isPrimaryKey:
{
Description: If it is the primary key of the table. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
quotedName:
{
Description: Quoted name of the column. ,
Required: False ,
}
string ,
}
,
]
,
errorId:
{
Description: Error id of the table. ,
Required: False ,
}
string ,
hasError:
{
Description: If there is error in the table. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
quotedName:
{
Description: Quoted name of the table. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdateTime:
{
Description: Last update time of the database schema. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_ListLogs (new)
Description :  Gets a collection of sync group logs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/logs
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
startTime:
{
Description: Get logs generated after this time. ,
Required: True ,
}
string ,
endTime:
{
Description: Get logs generated before this time. ,
Required: True ,
}
string ,
type:
{
Description: The types of logs to retrieve. ,
Required: True ,
}
string ,
continuationToken:
{
Description: The continuation token for this operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
timestamp:
{
Description: Timestamp of the sync group log. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Type of the sync group log. ,
Enum:
{
All: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Success: No description available. ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source of the sync group log. ,
Required: False ,
}
string ,
details:
{
Description: Details of the sync group log. ,
Required: False ,
}
string ,
tracingId:
{
Description: TracingId of the sync group log. ,
Format: uuid ,
Required: False ,
}
string ,
operationStatus:
{
Description: OperationStatus of the sync group log. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncGroups_RefreshHubSchema (new)
Description :  Refreshes a hub database schema.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/refreshHubSchema
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SyncGroups_TriggerSync (new)
Description :  Triggers a sync group synchronization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/triggerSync
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncMembers_ListBySyncGroup (new)
Description :  Lists sync members in the given sync group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncMembers_Get (new)
Description :  Gets a sync member.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SyncMembers_CreateOrUpdate (new)
Description :  Creates or updates a sync member.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested sync member resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
SyncMembers_Delete (new)
Description :  Deletes a sync member.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
SyncMembers_Update (new)
Description :  Updates an existing sync member.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested sync member resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
databaseType:
{
Description: Database type of the sync member. ,
Enum:
{
AzureSqlDatabase: No description available. ,
SqlServerDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
syncAgentId:
{
Description: ARM resource id of the sync agent in the sync member. ,
Required: False ,
}
string ,
sqlServerDatabaseId:
{
Description: SQL Server database id of the sync member. ,
Format: uuid ,
Required: False ,
}
string ,
syncMemberAzureDatabaseResourceId:
{
Description: ARM resource id of the sync member logical database, for sync members in Azure. ,
Required: False ,
}
string ,
usePrivateLinkConnection:
{
Description: Whether to use private link connection. ,
Required: False ,
}
boolean ,
privateEndpointName:
{
Description: Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure. ,
Required: False ,
}
string ,
serverName:
{
Description: Server name of the member database in the sync member ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name of the member database in the sync member. ,
Required: False ,
}
string ,
userName:
{
Description: User name of the member database in the sync member. ,
Required: False ,
}
string ,
password:
{
Description: Password of the member database in the sync member. ,
Required: False ,
}
string ,
syncDirection:
{
Description: Sync direction of the sync member. ,
Enum:
{
Bidirectional: No description available. ,
OneWayMemberToHub: No description available. ,
OneWayHubToMember: No description available. ,
}
,
Required: False ,
}
enum ,
syncState:
{
Description: Sync state of the sync member. ,
Enum:
{
SyncInProgress: No description available. ,
SyncSucceeded: No description available. ,
SyncFailed: No description available. ,
DisabledTombstoneCleanup: No description available. ,
DisabledBackupRestore: No description available. ,
SyncSucceededWithWarnings: No description available. ,
SyncCancelling: No description available. ,
SyncCancelled: No description available. ,
UnProvisioned: No description available. ,
Provisioning: No description available. ,
Provisioned: No description available. ,
ProvisionFailed: No description available. ,
DeProvisioning: No description available. ,
DeProvisioned: No description available. ,
DeProvisionFailed: No description available. ,
Reprovisioning: No description available. ,
ReprovisionFailed: No description available. ,
UnReprovisioned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SyncMembers_RefreshMemberSchema (new)
Description :  Refreshes a sync member database schema.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/refreshSchema
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
SyncMembers_ListMemberSchemas (new)
Description :  Gets a sync member database schema.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/schemas
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database on which the sync group is hosted. ,
Required: True ,
}
string ,
syncGroupName:
{
Description: The name of the sync group on which the sync member is hosted. ,
Required: True ,
}
string ,
syncMemberName:
{
Description: The name of the sync member. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
tables:
{
Description: List of tables in the database full schema. ,
Required: False ,
}
[
{
columns:
{
Description: List of columns in the table of database full schema. ,
Required: False ,
}
[
{
dataSize:
{
Description: Data size of the column. ,
Required: False ,
}
string ,
dataType:
{
Description: Data type of the column. ,
Required: False ,
}
string ,
errorId:
{
Description: Error id of the column. ,
Required: False ,
}
string ,
hasError:
{
Description: If there is error in the table. ,
Required: False ,
}
boolean ,
isPrimaryKey:
{
Description: If it is the primary key of the table. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of the column. ,
Required: False ,
}
string ,
quotedName:
{
Description: Quoted name of the column. ,
Required: False ,
}
string ,
}
,
]
,
errorId:
{
Description: Error id of the table. ,
Required: False ,
}
string ,
hasError:
{
Description: If there is error in the table. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of the table. ,
Required: False ,
}
string ,
quotedName:
{
Description: Quoted name of the table. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdateTime:
{
Description: Last update time of the database schema. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TdeCertificates_Create (new)
Description :  Creates a TDE certificate for a given server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/tdeCertificates
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested TDE certificate to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateBlob:
{
Description: The base64 encoded certificate private blob. ,
Required: True ,
}
string ,
certPassword:
{
Description: The certificate password. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
TimeZones_ListByLocation (new)
Description :  Gets a list of managed instance time zones by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/timeZones
{
locationName:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timeZoneId:
{
Description: The time zone id ,
Required: False ,
}
string ,
displayName:
{
Description: The time zone display name ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TimeZones_Get (new)
Description :  Gets a managed instance time zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/timeZones/{timeZoneId}
{
locationName:
{
Required: True ,
}
string ,
timeZoneId:
{
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
timeZoneId:
{
Description: The time zone id ,
Required: False ,
}
string ,
displayName:
{
Description: The time zone display name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TransparentDataEncryptions_ListByDatabase (new)
Description :  Gets a list of the logical database's transparent data encryption.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the logical database for which the transparent data encryption is defined. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TransparentDataEncryptions_Get (new)
Description :  Gets a logical database's transparent data encryption.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the logical database for which the transparent data encryption is defined. ,
Required: True ,
}
string ,
tdeName:
{
Description: The name of the transparent data encryption configuration. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TransparentDataEncryptions_CreateOrUpdate (new)
Description :  Updates a logical database's transparent data encryption configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/transparentDataEncryption/{tdeName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the logical database for which the security alert policy is defined. ,
Required: True ,
}
string ,
tdeName:
{
Description: The name of the transparent data encryption configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The database transparent data encryption. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
state:
{
Description: Specifies the state of the transparent data encryption. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
Usages_ListByInstancePool (new)
Description :  Gets all instance pool usage metrics
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}/usages
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
instancePoolName:
{
Description: The name of the instance pool to be retrieved. ,
Required: True ,
}
string ,
expandChildren:
{
Description: Optional request parameter to include managed instance usages within the instance pool. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
{
value:
{
Description: Usage name value ,
Required: False ,
}
string ,
localizedValue:
{
Description: Usage name localized value. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
unit:
{
Description: Usage unit. ,
Required: False ,
}
string ,
currentValue:
{
Description: Usage current value. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Usage limit. ,
Format: int32 ,
Required: False ,
}
integer ,
requestedLimit:
{
Description: Usage requested limit. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualClusters_List (new)
Description :  Gets a list of all virtualClusters in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sql/virtualClusters
{
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Subnet resource ID for the virtual cluster. ,
Required: False ,
}
string ,
version:
{
Description: Virtual cluster version. ,
Required: False ,
}
string ,
childResources:
{
Description: List of resources in this virtual cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualClusters_ListByResourceGroup (new)
Description :  Gets a list of virtual clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Subnet resource ID for the virtual cluster. ,
Required: False ,
}
string ,
version:
{
Description: Virtual cluster version. ,
Required: False ,
}
string ,
childResources:
{
Description: List of resources in this virtual cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualClusters_Get (new)
Description :  Gets a virtual cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
virtualClusterName:
{
Description: The name of the virtual cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Subnet resource ID for the virtual cluster. ,
Required: False ,
}
string ,
version:
{
Description: Virtual cluster version. ,
Required: False ,
}
string ,
childResources:
{
Description: List of resources in this virtual cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualClusters_Delete (new)
Description :  Deletes a virtual cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
virtualClusterName:
{
Description: The name of the virtual cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
VirtualClusters_Update (new)
Description :  Updates an existing virtual cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
virtualClusterName:
{
Description: The name of the virtual cluster. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested virtual cluster resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Subnet resource ID for the virtual cluster. ,
Required: False ,
}
string ,
version:
{
Description: Virtual cluster version. ,
Required: False ,
}
string ,
childResources:
{
Description: List of resources in this virtual cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
subnetId:
{
Description: Subnet resource ID for the virtual cluster. ,
Required: False ,
}
string ,
version:
{
Description: Virtual cluster version. ,
Required: False ,
}
string ,
childResources:
{
Description: List of resources in this virtual cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
VirtualClusters_UpdateDnsServers (new)
Description :  Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/virtualClusters/{virtualClusterName}/updateManagedInstanceDnsServers
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
virtualClusterName:
{
Description: The name of the virtual cluster. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
status:
{
Description: The status of the DNS refresh operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}
VirtualNetworkRules_ListByServer (new)
Description :  Gets a list of virtual network rules in a server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: The ARM resource id of the virtual network subnet. ,
Required: True ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
state:
{
Description: Virtual Network Rule State ,
Enum:
{
Initializing: No description available. ,
InProgress: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkRules_Get (new)
Description :  Gets a virtual network rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: The ARM resource id of the virtual network subnet. ,
Required: True ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
state:
{
Description: Virtual Network Rule State ,
Enum:
{
Initializing: No description available. ,
InProgress: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkRules_CreateOrUpdate (new)
Description :  Creates or updates an existing virtual network rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested virtual Network Rule Resource state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: The ARM resource id of the virtual network subnet. ,
Required: True ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
state:
{
Description: Virtual Network Rule State ,
Enum:
{
Initializing: No description available. ,
InProgress: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: The ARM resource id of the virtual network subnet. ,
Required: True ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
state:
{
Description: Virtual Network Rule State ,
Enum:
{
Initializing: No description available. ,
InProgress: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
virtualNetworkSubnetId:
{
Description: The ARM resource id of the virtual network subnet. ,
Required: True ,
}
string ,
ignoreMissingVnetServiceEndpoint:
{
Description: Create firewall rule before the virtual network has vnet service endpoint enabled. ,
Required: False ,
}
boolean ,
state:
{
Description: Virtual Network Rule State ,
Enum:
{
Initializing: No description available. ,
InProgress: No description available. ,
Ready: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
VirtualNetworkRules_Delete (new)
Description :  Deletes the virtual network rule with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
virtualNetworkRuleName:
{
Description: The name of the virtual network rule. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
WorkloadClassifiers_ListByWorkloadGroup (new)
Description :  Gets the list of workload classifiers for a workload group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group from which to receive the classifiers from. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
memberName:
{
Description: The workload classifier member name. ,
Required: True ,
}
string ,
label:
{
Description: The workload classifier label. ,
Required: False ,
}
string ,
context:
{
Description: The workload classifier context. ,
Required: False ,
}
string ,
startTime:
{
Description: The workload classifier start time for classification. ,
Required: False ,
}
string ,
endTime:
{
Description: The workload classifier end time for classification. ,
Required: False ,
}
string ,
importance:
{
Description: The workload classifier importance. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadClassifiers_Get (new)
Description :  Gets a workload classifier
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group from which to receive the classifier from. ,
Required: True ,
}
string ,
workloadClassifierName:
{
Description: The name of the workload classifier. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
memberName:
{
Description: The workload classifier member name. ,
Required: True ,
}
string ,
label:
{
Description: The workload classifier label. ,
Required: False ,
}
string ,
context:
{
Description: The workload classifier context. ,
Required: False ,
}
string ,
startTime:
{
Description: The workload classifier start time for classification. ,
Required: False ,
}
string ,
endTime:
{
Description: The workload classifier end time for classification. ,
Required: False ,
}
string ,
importance:
{
Description: The workload classifier importance. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadClassifiers_CreateOrUpdate (new)
Description :  Creates or updates a workload classifier.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group from which to receive the classifier from. ,
Required: True ,
}
string ,
workloadClassifierName:
{
Description: The name of the workload classifier to create/update. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the workload classifier. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
memberName:
{
Description: The workload classifier member name. ,
Required: True ,
}
string ,
label:
{
Description: The workload classifier label. ,
Required: False ,
}
string ,
context:
{
Description: The workload classifier context. ,
Required: False ,
}
string ,
startTime:
{
Description: The workload classifier start time for classification. ,
Required: False ,
}
string ,
endTime:
{
Description: The workload classifier end time for classification. ,
Required: False ,
}
string ,
importance:
{
Description: The workload classifier importance. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
memberName:
{
Description: The workload classifier member name. ,
Required: True ,
}
string ,
label:
{
Description: The workload classifier label. ,
Required: False ,
}
string ,
context:
{
Description: The workload classifier context. ,
Required: False ,
}
string ,
startTime:
{
Description: The workload classifier start time for classification. ,
Required: False ,
}
string ,
endTime:
{
Description: The workload classifier end time for classification. ,
Required: False ,
}
string ,
importance:
{
Description: The workload classifier importance. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
memberName:
{
Description: The workload classifier member name. ,
Required: True ,
}
string ,
label:
{
Description: The workload classifier label. ,
Required: False ,
}
string ,
context:
{
Description: The workload classifier context. ,
Required: False ,
}
string ,
startTime:
{
Description: The workload classifier start time for classification. ,
Required: False ,
}
string ,
endTime:
{
Description: The workload classifier end time for classification. ,
Required: False ,
}
string ,
importance:
{
Description: The workload classifier importance. ,
Required: False ,
}
string ,
}
,
}
WorkloadClassifiers_Delete (new)
Description :  Deletes a workload classifier.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group from which to receive the classifier from. ,
Required: True ,
}
string ,
workloadClassifierName:
{
Description: The name of the workload classifier to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}
WorkloadGroups_ListByDatabase (new)
Description :  Gets the list of workload groups
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
minResourcePercent:
{
Description: The workload group minimum percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
maxResourcePercent:
{
Description: The workload group cap percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
minResourcePercentPerRequest:
{
Description: The workload group request minimum grant percentage. ,
Format: double ,
Required: True ,
}
number ,
maxResourcePercentPerRequest:
{
Description: The workload group request maximum grant percentage. ,
Format: double ,
Required: False ,
}
number ,
importance:
{
Description: The workload group importance level. ,
Required: False ,
}
string ,
queryExecutionTimeout:
{
Description: The workload group query execution timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadGroups_Get (new)
Description :  Gets a workload group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
minResourcePercent:
{
Description: The workload group minimum percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
maxResourcePercent:
{
Description: The workload group cap percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
minResourcePercentPerRequest:
{
Description: The workload group request minimum grant percentage. ,
Format: double ,
Required: True ,
}
number ,
maxResourcePercentPerRequest:
{
Description: The workload group request maximum grant percentage. ,
Format: double ,
Required: False ,
}
number ,
importance:
{
Description: The workload group importance level. ,
Required: False ,
}
string ,
queryExecutionTimeout:
{
Description: The workload group query execution timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadGroups_CreateOrUpdate (new)
Description :  Creates or updates a workload group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group. ,
Required: True ,
}
string ,
parameters:
{
Description: The requested workload group state. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
minResourcePercent:
{
Description: The workload group minimum percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
maxResourcePercent:
{
Description: The workload group cap percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
minResourcePercentPerRequest:
{
Description: The workload group request minimum grant percentage. ,
Format: double ,
Required: True ,
}
number ,
maxResourcePercentPerRequest:
{
Description: The workload group request maximum grant percentage. ,
Format: double ,
Required: False ,
}
number ,
importance:
{
Description: The workload group importance level. ,
Required: False ,
}
string ,
queryExecutionTimeout:
{
Description: The workload group query execution timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
minResourcePercent:
{
Description: The workload group minimum percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
maxResourcePercent:
{
Description: The workload group cap percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
minResourcePercentPerRequest:
{
Description: The workload group request minimum grant percentage. ,
Format: double ,
Required: True ,
}
number ,
maxResourcePercentPerRequest:
{
Description: The workload group request maximum grant percentage. ,
Format: double ,
Required: False ,
}
number ,
importance:
{
Description: The workload group importance level. ,
Required: False ,
}
string ,
queryExecutionTimeout:
{
Description: The workload group query execution timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
minResourcePercent:
{
Description: The workload group minimum percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
maxResourcePercent:
{
Description: The workload group cap percentage resource. ,
Format: int32 ,
Required: True ,
}
integer ,
minResourcePercentPerRequest:
{
Description: The workload group request minimum grant percentage. ,
Format: double ,
Required: True ,
}
number ,
maxResourcePercentPerRequest:
{
Description: The workload group request maximum grant percentage. ,
Format: double ,
Required: False ,
}
number ,
importance:
{
Description: The workload group importance level. ,
Required: False ,
}
string ,
queryExecutionTimeout:
{
Description: The workload group query execution timeout. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
WorkloadGroups_Delete (new)
Description :  Deletes a workload group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the server. ,
Required: True ,
}
string ,
databaseName:
{
Description: The name of the database. ,
Required: True ,
}
string ,
workloadGroupName:
{
Description: The name of the workload group to delete. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID that identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}