Azure Synapse Analytics: Sql Server
The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API enables users to create, retrieve, update, and delete SqlServers sub resources.
Endpoints 23
WorkspaceManagedSqlServer, BlobAuditing
- GETGet server's blob auditing policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/auditingSettings/:blobAuditingPolicyNameGet a workspace managed sql server's blob auditing policy. - PUTCreate or Update server's blob auditing policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/auditingSettings/:blobAuditingPolicyNameCreate or Update a workspace managed sql server's blob auditing policy. - GETList workspace server's blob auditing policies.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/auditingSettingsList workspace managed sql server's blob auditing policies. - GETGet server's extended blob auditing policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/extendedAuditingSettings/:blobAuditingPolicyNameGet a workspace SQL server's extended blob auditing policy. - PUTCreate or Update server's extended blob auditing policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/extendedAuditingSettings/:blobAuditingPolicyNameCreate or Update a workspace managed sql server's extended blob auditing policy. - GETList server's extended blob auditing policies.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/extendedAuditingSettingsList workspace managed sql server's extended blob auditing policies.
WorkspaceManagedSqlServer, SecurityAlertPolicies
- GETGet server's security alert policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/securityAlertPolicies/:securityAlertPolicyNameGet a workspace managed sql server's security alert policy. - PUTCreate or Update server's threat detection policy.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/securityAlertPolicies/:securityAlertPolicyNameCreate or Update a workspace managed sql server's threat detection policy. - GETGet server's threat detection policies.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/securityAlertPoliciesGet workspace managed sql server's threat detection policies.
WorkspaceManagedSqlServer, ServerVulnerabilityAssessments
- GETGet server's vulnerability assessment.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/vulnerabilityAssessments/:vulnerabilityAssessmentNameGet workspace managed sql server's vulnerability assessment. - PUTCreate or Update server's vulnerability assessment.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/vulnerabilityAssessments/:vulnerabilityAssessmentNameCreate or Update workspace managed sql server's vulnerability assessment. - DELETERemove server's vulnerability assessment.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/vulnerabilityAssessments/:vulnerabilityAssessmentNameRemove workspace managed sql server's vulnerability assessment. - GETLists the vulnerability assessment policies associated with a server.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/vulnerabilityAssessmentsLists the vulnerability assessment policies associated with a workspace managed sql server.
WorkspaceManagedSqlServer, ServerEncryptionProtector
- GETGet workspace server's encryption protector.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/encryptionProtector/:encryptionProtectorNameGet workspace managed sql server's encryption protector. - PUTUpdates workspace server's encryption protector.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/encryptionProtector/:encryptionProtectorNameUpdates workspace managed sql server's encryption protector. - GETGet list of encryption protectors for the server.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/encryptionProtectorGet list of encryption protectors for workspace managed sql server. - POSTRevalidates server's existing encryption protector.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/encryptionProtector/:encryptionProtectorName/revalidateRevalidates workspace managed sql server's existing encryption protector.
WorkspaceManagedSqlServer, sqlUsages
- GETGet list of usages metric for the server.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/sqlUsagesGet list of server usages metric for workspace managed sql server.
WorkspaceManagedSqlServer
- GETGet list of recoverable sql pools for the server.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/recoverableSqlPoolsGet list of recoverable sql pools for workspace managed sql server. - GETGet recoverable sql pools for the server.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/recoverableSqlPools/:sqlPoolNameGet recoverable sql pools for workspace managed sql server.
WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings
- GETGet server's minimal tls settings.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/dedicatedSQLminimalTlsSettings/:dedicatedSQLminimalTlsSettingsNameGet workspace managed sql server's minimal tls settings. - PUTUpdate server's tls settings.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/dedicatedSQLminimalTlsSettings/:dedicatedSQLminimalTlsSettingsNameUpdate workspace managed sql server's minimal tls settings. - GETList workspace server's minimal tls settings.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/dedicatedSQLminimalTlsSettingsList workspace managed sql server's minimal tls settings.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 23 operations on 16 pathsGET 15PUT 6POST 1DELETE 1
- Main resources
- WorkspaceManagedSqlServer, BlobAuditing 6WorkspaceManagedSqlServer, ServerEncryptionProtector 4WorkspaceManagedSqlServer, ServerVulnerabilityAssessments 4WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings 3WorkspaceManagedSqlServer, SecurityAlertPolicies 3WorkspaceManagedSqlServer 2recoverableSqlPools 2WorkspaceManagedSqlServer, sqlUsages 1
- Description format
- Swagger 2.0, API version
2021-06-01 - Links
- OpenAPI document
How to test the Azure Synapse Analytics: Sql Server in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Synapse Analytics: Sql Server collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get server's blob auditing policy.” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/auditingSettings/:blobAuditingPolicyName), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Synapse Analytics: Sql Server?
The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API… It is listed under Data & analytics and has 23 endpoints.
Who publishes the Azure Synapse Analytics: Sql Server?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Synapse Analytics: Sql Server?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Synapse Analytics: Sql Server?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Synapse Analytics: Sql Server have?
23 operations on 16 paths (15 GET, 6 PUT, 1 POST, 1 DELETE). The largest groups are WorkspaceManagedSqlServer, BlobAuditing, WorkspaceManagedSqlServer, ServerEncryptionProtector, WorkspaceManagedSqlServer, ServerVulnerabilityAssessments, WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings.
Is forking the Azure Synapse Analytics: Sql Server free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.