Share via

PartnerDestinationsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:partner_destinations> attribute.

Inheritance
builtins.object
PartnerDestinationsOperations

Constructor

PartnerDestinationsOperations(*args, **kwargs)

Methods

activate

Activate a partner destination.

Activate a newly created partner destination.
begin_create_or_update

Create a partner destination.

Asynchronously creates a new partner destination with the specified parameters.
begin_delete

Delete a partner destination.

Delete existing partner destination.
begin_update

Update a partner destination.

Asynchronously updates a partner destination with the specified parameters.
get

Get a partner destination.

Get properties of a partner destination.
list_by_resource_group

List partner destinations under a resource group.

List all the partner destinations under a resource group.
list_by_subscription

List partner destinations under an Azure subscription.

List all the partner destinations under an Azure subscription.

activate

Activate a partner destination.

Activate a newly created partner destination.

async activate(resource_group_name: str, partner_destination_name: str, **kwargs: Any) -> PartnerDestination

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
partner_destination_name
Required
str

Name of the partner destination. Required.

Returns

Type Description
PartnerDestination

PartnerDestination or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update

Create a partner destination.

Asynchronously creates a new partner destination with the specified parameters.

async begin_create_or_update(resource_group_name: str, partner_destination_name: str, partner_destination: _models.PartnerDestination, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PartnerDestination]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
partner_destination_name
Required
str

Name of the partner destination. Required.
partner_destination
Required
PartnerDestination or IO[bytes]

Partner destination create information. Is either a PartnerDestination type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[PartnerDestination]

An instance of AsyncLROPoller that returns either PartnerDestination or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a partner destination.

Delete existing partner destination.

async begin_delete(resource_group_name: str, partner_destination_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
partner_destination_name
Required
str

Name of the partner destination. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Update a partner destination.

Asynchronously updates a partner destination with the specified parameters.

async begin_update(resource_group_name: str, partner_destination_name: str, partner_destination_update_parameters: _models.PartnerDestinationUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PartnerDestination]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
partner_destination_name
Required
str

Name of the partner destination. Required.
partner_destination_update_parameters
Required
PartnerDestinationUpdateParameters or IO[bytes]

Partner destination update information. Is either a PartnerDestinationUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[PartnerDestination]

An instance of AsyncLROPoller that returns either PartnerDestination or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a partner destination.

Get properties of a partner destination.

async get(resource_group_name: str, partner_destination_name: str, **kwargs: Any) -> PartnerDestination

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
partner_destination_name
Required
str

Name of the partner destination. Required.

Returns

Type Description
PartnerDestination

PartnerDestination or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List partner destinations under a resource group.

List all the partner destinations under a resource group.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PartnerDestination]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
filter
Required
str

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
top
Required
int

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

Returns

Type Description
AsyncItemPaged[PartnerDestination]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

List partner destinations under an Azure subscription.

List all the partner destinations under an Azure subscription.

list_by_subscription(filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PartnerDestination]

Parameters

Name Description
filter
Required
str

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
top
Required
int

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

Returns

Type Description
AsyncItemPaged[PartnerDestination]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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