PartnerConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:partner_configurations> attribute.

Inheritance

builtins.object

PartnerConfigurationsOperations

Constructor

PartnerConfigurationsOperations(*args, **kwargs)

Methods

authorize_partner	Authorize a partner. Authorize a single partner either by partner registration immutable Id or by partner name.
begin_create_or_update	Create or update a partner configuration. Synchronously creates or updates a partner configuration with the specified parameters.
begin_delete	Delete a partner configuration. Delete existing partner configuration.
begin_update	Update a partner configuration. Synchronously updates a partner configuration with the specified parameters.
get	Get a partner configuration. Get properties of a partner configuration.
list_by_resource_group	List partner configurations under a resource group. List all the partner configurations under a resource group.
list_by_subscription	List partner configurations under an Azure subscription. List all the partner configurations under an Azure subscription.
unauthorize_partner	Unauthorize a partner. Unauthorize a single partner either by partner registration immutable Id or by partner name.

authorize_partner

Authorize a partner.

Authorize a single partner either by partner registration immutable Id or by partner name.

authorize_partner(resource_group_name: str, partner_info: _models.Partner, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_info Required	Partner or IO[bytes] The information of the partner to be authorized. Is either a Partner type or a IO[bytes] type. Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Create or update a partner configuration.

Synchronously creates or updates a partner configuration with the specified parameters.

begin_create_or_update(resource_group_name: str, partner_configuration_info: _models.PartnerConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_configuration_info Required	PartnerConfiguration or IO[bytes] Partner configuration information. Is either a PartnerConfiguration type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PartnerConfiguration]	An instance of LROPoller that returns either PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a partner configuration.

Delete existing partner configuration.

begin_delete(resource_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update a partner configuration.

Synchronously updates a partner configuration with the specified parameters.

begin_update(resource_group_name: str, partner_configuration_update_parameters: _models.PartnerConfigurationUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_configuration_update_parameters Required	PartnerConfigurationUpdateParameters or IO[bytes] Partner configuration update information. Is either a PartnerConfigurationUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PartnerConfiguration]	An instance of LROPoller that returns either PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get a partner configuration.

Get properties of a partner configuration.

get(resource_group_name: str, **kwargs: Any) -> PartnerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List partner configurations under a resource group.

List all the partner configurations under a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.

Returns

Type	Description
ItemPaged[PartnerConfiguration]	An iterator like instance of either PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List partner configurations under an Azure subscription.

List all the partner configurations under an Azure subscription.

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

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
ItemPaged[PartnerConfiguration]	An iterator like instance of either PartnerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

unauthorize_partner

Unauthorize a partner.

Unauthorize a single partner either by partner registration immutable Id or by partner name.

unauthorize_partner(resource_group_name: str, partner_info: _models.Partner, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_info Required	Partner or IO[bytes] The information of the partner to be unauthorized. Is either a Partner type or a IO[bytes] type. Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration 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'>