Suppressions - 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.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions?api-version=2023-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions?api-version=2023-01-01&$top={$top}&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
The Azure subscription ID. |
api-version
|
query | True |
string |
The version of the API to be used with the client request. |
$skip
|
query |
string |
The page-continuation token to use with a paged version of this API. |
|
$top
|
query |
integer int32 |
The number of suppressions per page if a paged version of this API is being used. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. Successfully got all suppressions in a subscription. |
|
Other Status Codes |
Error response describing 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
ListSuppressions
Sample Request
GET https://management.azure.com/subscriptions/subscriptionId1/providers/Microsoft.Advisor/suppressions?api-version=2023-01-01
Sample Response
{
"nextLink": "https://management.azure.com/subscriptions/3f75fdf7-977e-44ad-990d-99f14f0f299f/providers/microsoft.Advisor/suppressions?api-version=2023-01-01&$top=3&$skiptoken=skiptoken",
"value": [
{
"id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId/suppressions/suppressionName1",
"name": "suppressionName1",
"type": "Microsoft.Advisor/suppressions",
"properties": {
"suppressionId": "suppressionId1",
"ttl": "7.00:00:00",
"expirationTimeStamp": "2022-10-24T22:24:43.3216408Z"
}
},
{
"id": "/resourceUri/providers/Microsoft.Advisor/recommendations/recommendationId/suppressions/suppressionName2",
"name": "suppressionName2",
"type": "Microsoft.Advisor/suppressions",
"properties": {
"suppressionId": "suppressionId2",
"ttl": "7.00:00:00",
"expirationTimeStamp": "2022-10-25T22:24:43.3216408Z"
}
}
]
}
Definitions
Name | Description |
---|---|
Arm |
|
ARMError |
ARM error response body. |
created |
The type of identity that created the resource. |
Suppression |
The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule. |
Suppression |
The list of Advisor suppressions. |
system |
Metadata pertaining to creation and last modification of the resource. |
ArmErrorResponse
Name | Type | Description |
---|---|---|
error |
ARM error response body. |
ARMErrorResponseBody
ARM error response body.
Name | Type | Description |
---|---|---|
code |
string |
Gets or sets the string that can be used to programmatically identify the error. |
message |
string |
Gets or sets the string that describes the error in detail and provides debugging information. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
SuppressionContract
The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.
Name | Type | Description |
---|---|---|
id |
string |
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.expirationTimeStamp |
string |
Gets or sets the expiration time stamp. |
properties.suppressionId |
string |
The GUID of the suppression. |
properties.ttl |
string |
The duration for which the suppression is valid. |
systemData |
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" |
SuppressionContractListResult
The list of Advisor suppressions.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link used to get the next page of suppressions. |
value |
The list of suppressions. |
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 |
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 |
The type of identity that last modified the resource. |