Share via

PartnerRegistrationsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:partner_registrations> attribute.

Inheritance
builtins.object
PartnerRegistrationsOperations

Constructor

PartnerRegistrationsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create a partner registration.

Creates a new partner registration with the specified parameters.
begin_delete

Delete a partner registration.

Deletes a partner registration with the specified parameters.
begin_update

Update a partner registration.

Updates a partner registration with the specified parameters.
get

Get a partner registration.

Gets a partner registration with the specified parameters.
list_by_resource_group

List partner registrations under a resource group.

List all the partner registrations under a resource group.
list_by_subscription

List partner registrations under an Azure subscription.

List all the partner registrations under an Azure subscription.

begin_create_or_update

Create a partner registration.

Creates a new partner registration with the specified parameters.

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

Parameters

Name Description
resource_group_name
Required
str

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

Name of the partner registration. Required.
partner_registration_info
Required
PartnerRegistration or IO[bytes]

PartnerRegistration information. Is either a PartnerRegistration type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[PartnerRegistration]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a partner registration.

Deletes a partner registration with the specified parameters.

async begin_delete(resource_group_name: str, partner_registration_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_registration_name
Required
str

Name of the partner registration. 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 registration.

Updates a partner registration with the specified parameters.

async begin_update(resource_group_name: str, partner_registration_name: str, partner_registration_update_parameters: _models.PartnerRegistrationUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PartnerRegistration]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the partner registration. Required.
partner_registration_update_parameters
Required
PartnerRegistrationUpdateParameters or IO[bytes]

Partner registration update information. Is either a PartnerRegistrationUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[PartnerRegistration]

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

Exceptions

Type Description
HttpResponseError

get

Get a partner registration.

Gets a partner registration with the specified parameters.

async get(resource_group_name: str, partner_registration_name: str, **kwargs: Any) -> PartnerRegistration

Parameters

Name Description
resource_group_name
Required
str

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

Name of the partner registration. Required.

Returns

Type Description
PartnerRegistration

PartnerRegistration or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List partner registrations under a resource group.

List all the partner registrations under a resource group.

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

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[PartnerRegistration]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

List partner registrations under an Azure subscription.

List all the partner registrations under an Azure subscription.

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

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[PartnerRegistration]

An iterator like instance of either PartnerRegistration 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'>