Custom Recommendations - Delete

Service:

Defender for Cloud

API Version:

2024-08-01

Delete a custom recommendation over a given scope

DELETE https://management.azure.com/{scope}/providers/Microsoft.Security/customRecommendations/{customRecommendationName}?api-version=2024-08-01

URI Parameters

Name	In	Required	Type	Description
customRecommendationName	path	True	string	Name of the Custom Recommendation. Regex pattern: [{]?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$
scope	path	True	string	The scope of the custom recommendation. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK		OK - custom recommendation was deleted
204 No Content		No Content - custom recommendation does not exist
Other Status Codes	ErrorResponse	Error response that describes why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Delete a custom recommendation over management group scope

Delete a custom recommendation over security connector scope

Delete a custom recommendation over subscription scope

Delete a custom recommendation over management group scope

Sample request

HTTP

DELETE https://management.azure.com/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/customRecommendations/ad9a8e26-29d9-4829-bb30-e597a58cdbb8?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations Delete.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * DeleteByManagementGroupCustomRecommendation_example.json
     */
    /**
     * Sample code: Delete a custom recommendation over management group scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void deleteACustomRecommendationOverManagementGroupScope(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().deleteByResourceGroupWithResponse(
            "providers/Microsoft.Management/managementGroups/contoso", "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
            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

Status code:

204

Delete a custom recommendation over security connector scope

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/customRecommendations/ad9a8e26-29d9-4829-bb30-e597a58cdbb8?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations Delete.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * DeleteBySecurityConnectorCustomRecommendation_example.json
     */
    /**
     * Sample code: Delete a custom recommendation over security connector scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void deleteACustomRecommendationOverSecurityConnectorScope(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().deleteByResourceGroupWithResponse(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector",
            "ad9a8e26-29d9-4829-bb30-e597a58cdbb8", 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

Status code:

204

Delete a custom recommendation over subscription scope

Sample request

HTTP

DELETE https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/customRecommendations/1f3afdf9-d0c9-4c3d-847f-89da613e70a8?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations Delete.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * DeleteBySubscriptionCustomRecommendation_example.json
     */
    /**
     * Sample code: Delete a custom recommendation over subscription scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        deleteACustomRecommendationOverSubscriptionScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().deleteByResourceGroupWithResponse(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "1f3afdf9-d0c9-4c3d-847f-89da613e70a8",
            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

Status code:

204

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.