suppressions

Creates, updates, deletes, gets or lists a suppressions resource.

Overview

Name	suppressions
Type	Resource
Id	azure.advisor.suppressions

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully got suppression detail.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The properties of the suppression.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

OK. Successfully got all suppressions in a subscription.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The properties of the suppression.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri, recommendationId, name		Obtains the details of a suppression.
list	select	subscriptionId	$top, $skipToken	Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
create	insert	resourceUri, recommendationId, name		Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.
delete	delete	resourceUri, recommendationId, name		Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the suppression.
recommendationId	string	The recommendation ID.
resourceUri	string	The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
subscriptionId	string	The Azure subscription ID.
$skipToken	string	The page-continuation token to use with a paged version of this API.
$top	integer (int32)	The number of suppressions per page if a paged version of this API is being used.

SELECT examples

get

Obtains the details of a suppression.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.advisor.suppressions
WHERE resourceUri = '{{ resourceUri }}' -- required
AND recommendationId = '{{ recommendationId }}' -- required
AND name = '{{ name }}' -- required
;

list

Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.advisor.suppressions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.

INSERT INTO azure.advisor.suppressions (
data__properties,
resourceUri,
recommendationId,
name
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ recommendationId }}',
'{{ name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: suppressions
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the suppressions resource.
    - name: recommendationId
      value: string
      description: Required parameter for the suppressions resource.
    - name: name
      value: string
      description: Required parameter for the suppressions resource.
    - name: properties
      value: object
      description: |
        The properties of the suppression.

DELETE examples

delete

Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.

DELETE FROM azure.advisor.suppressions
WHERE resourceUri = '{{ resourceUri }}' --required
AND recommendationId = '{{ recommendationId }}' --required
AND name = '{{ name }}' --required
;