Server Advanced Threat Protection Settings - List By Server

Service:

SQL Database

API Version:

2021-11-01

Get a list of the server's Advanced Threat Protection states.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	LogicalServerAdvancedThreatProtectionListResult	Successfully retrieved the list of server's Advanced Threat Protection states.
Other Status Codes		*** Error Responses: *** 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Setting the server Advanced Threat Protection settings is not allowed on a server with a paused Data Warehouse database 400 AdvancedThreatProtectionInsufficientDiskSpace - Insufficient disk space to save the Advanced Threat Protection settings metadata in the database 400 InvalidServerAdvancedThreatProtectionCreateRequest - The create server Advanced Threat Protection request does not exist or has no properties object 400 AdvancedThreatProtectionInvalidUserSuppliedParameter - An invalid parameter value was provided by the client 400 UpsertServerAdvancedThreatProtectionFailed - An error has occurred while saving the Advanced Threat Protection settings, please try again later 400 UpsertServerAdvancedThreatProtectionFailed - An error has occurred while saving the Advanced Threat Protection settings, please try again later 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 UpsertServerAdvancedThreatProtectionFailed - An error has occurred while saving the Advanced Threat Protection settings, please try again later 409 ServerAdvancedThreatProtectionInProgress - Setting the server Advanced Threat Protection settings is already in progress 409 UpsertServerAdvancedThreatProtectionFailed - An error has occurred while saving the Advanced Threat Protection settings, please try again later 500 DatabaseIsUnavailable - Loading failed. Please try again later. 500 UpsertServerAdvancedThreatProtectionFailed - An error has occurred while saving the Advanced Threat Protection settings, please try again later 500 GetServerAdvancedThreatProtectionFailed - Failed to get the Advanced Threat Protection settings

Examples

List the server's Advanced Threat Protection settings.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.Sql/servers/threatprotection-6440/advancedThreatProtectionSettings?api-version=2021-11-01

Java

/**
 * Samples for ServerAdvancedThreatProtectionSettings ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerAdvancedThreatProtectionSettingsListByServer.json
     */
    /**
     * Sample code: List the server's Advanced Threat Protection settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listTheServerSAdvancedThreatProtectionSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAdvancedThreatProtectionSettings()
            .listByServer("threatprotection-4799", "threatprotection-6440", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.Sql/servers/threatprotection-6440/advancedThreatProtectionSettings",
      "name": "Default",
      "type": "Microsoft.Sql/servers/advancedThreatProtectionSettings",
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2022-04-03T04:41:33.937Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2022-04-03T04:41:33.937Z"
      },
      "properties": {
        "state": "Disabled",
        "creationTime": "2022-04-03T04:41:33.937Z"
      }
    }
  ]
}

Definitions

Name	Description
AdvancedThreatProtectionState	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.
createdByType	The type of identity that created the resource.
LogicalServerAdvancedThreatProtectionListResult	A list of the server's Advanced Threat Protection configurations.
ServerAdvancedThreatProtection	A server Advanced Threat Protection.
systemData	Metadata pertaining to creation and last modification of the resource.

AdvancedThreatProtectionState

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.

Name	Type	Description
Disabled	string
Enabled	string
New	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

LogicalServerAdvancedThreatProtectionListResult

A list of the server's Advanced Threat Protection configurations.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ServerAdvancedThreatProtection[]	Array of results.

ServerAdvancedThreatProtection

A server Advanced Threat Protection.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.creationTime	string	Specifies the UTC creation time of the policy.
properties.state	AdvancedThreatProtectionState	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.
systemData	systemData	SystemData of AdvancedThreatProtectionResource.
type	string	Resource type.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.