SuppressionsOperations Class

SuppressionsOperations async 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

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

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.

async create(resource_uri: str, recommendation_id: str, name: str, suppression_contract: azure.mgmt.advisor.models._models_py3.SuppressionContract, **kwargs) -> Union[azure.mgmt.advisor.models._models_py3.SuppressionContract, azure.mgmt.advisor.models._models_py3.ArmErrorResponse]

Parameters

resource_uri

str

Required

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

recommendation_id

str

Required

The recommendation ID.

name

str

Required

The name of the suppression.

suppression_contract

SuppressionContract

Required

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

cls

callable

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

Returns

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

Return type

SuppressionContract,

ArmErrorResponse

Exceptions

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.

async delete(resource_uri: str, recommendation_id: str, name: str, **kwargs) -> None

Parameters

resource_uri

str

Required

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

recommendation_id

str

Required

The recommendation ID.

name

str

Required

The name of the suppression.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Obtains the details of a suppression.

async get(resource_uri: str, recommendation_id: str, name: str, **kwargs) -> Union[azure.mgmt.advisor.models._models_py3.SuppressionContract, azure.mgmt.advisor.models._models_py3.ArmErrorResponse]

Parameters

resource_uri

str

Required

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

recommendation_id

str

Required

The recommendation ID.

name

str

Required

The name of the suppression.

cls

callable

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

Returns

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

Return type

SuppressionContract,

ArmErrorResponse

Exceptions

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: Optional[int] = None, skip_token: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.advisor.models._models_py3.SuppressionContractListResult]

Parameters

top

int

default value: None

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

skip_token

str

default value: None

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

cls

callable

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

Returns

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

Return type

AsyncItemPaged[SuppressionContractListResult]

Exceptions

HttpResponseError

Attributes

models

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