Share via

SuppressionsOperations Class

  • Reference

SuppressionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
SuppressionsOperations

Constructor

SuppressionsOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

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.
delete

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

Obtains the details of a suppression.
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.

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.

create(resource_uri: str, recommendation_id: str, name: str, suppression_contract: '_models.SuppressionContract', **kwargs: Any) -> '_models.SuppressionContract' | '_models.ArmErrorResponse'

Parameters

Name Description
resource_uri
Required
str

The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
recommendation_id
Required
str

The recommendation ID.
name
Required
str

The name of the suppression.
suppression_contract
Required
SuppressionContract

The snoozed or dismissed attribute; for example, the snooze duration.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SuppressionContract,
ArmErrorResponse

SuppressionContract or ArmErrorResponse, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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(resource_uri: str, recommendation_id: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_uri
Required
str

The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
recommendation_id
Required
str

The recommendation ID.
name
Required
str

The name of the suppression.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
None

None, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Obtains the details of a suppression.

get(resource_uri: str, recommendation_id: str, name: str, **kwargs: Any) -> '_models.SuppressionContract' | '_models.ArmErrorResponse'

Parameters

Name Description
resource_uri
Required
str

The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies.
recommendation_id
Required
str

The recommendation ID.
name
Required
str

The name of the suppression.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
SuppressionContract,
ArmErrorResponse

SuppressionContract or ArmErrorResponse, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.

list(top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> Iterable['_models.SuppressionContractListResult']

Parameters

Name Description
top
int

The number of suppressions per page if a paged version of this API is being used.

default value: None
skip_token
str

The page-continuation token to use with a paged version of this API.

default value: None

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[SuppressionContractListResult]

An iterator like instance of either SuppressionContractListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.advisor.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\advisor\\models\\__init__.py'>