PartnerConfigurationsOperations Class

Reference

PartnerConfigurationsOperations 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

PartnerConfigurationsOperations

Constructor

PartnerConfigurationsOperations(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

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.

async authorize_partner(resource_group_name: str, partner_info: Partner, **kwargs: Any) -> PartnerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
partner_info Required	Partner The information of the partner to be authorized.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

async begin_create_or_update(resource_group_name: str, partner_configuration_info: PartnerConfiguration, **kwargs: Any) -> AsyncLROPoller[PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
partner_configuration_info Required	PartnerConfiguration Partner configuration information.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a partner configuration.

Delete existing partner configuration.

async begin_delete(resource_group_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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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

Synchronously updates a partner configuration with the specified parameters.

async begin_update(resource_group_name: str, partner_configuration_update_parameters: PartnerConfigurationUpdateParameters, **kwargs: Any) -> AsyncLROPoller[PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
partner_configuration_update_parameters Required	PartnerConfigurationUpdateParameters Partner configuration update information.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[PartnerConfiguration]	An instance of AsyncLROPoller 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.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[PartnerConfigurationsListResult]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[PartnerConfigurationsListResult]	An iterator like instance of either PartnerConfigurationsListResult 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) -> AsyncIterable[PartnerConfigurationsListResult]

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.

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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[PartnerConfigurationsListResult]	An iterator like instance of either PartnerConfigurationsListResult 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.

async unauthorize_partner(resource_group_name: str, partner_info: Partner, **kwargs: Any) -> PartnerConfiguration

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
partner_info Required	Partner The information of the partner to be unauthorized.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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'>

Share via

PartnerConfigurationsOperations Class

Constructor

Parameters

Variables

Methods

authorize_partner

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_create_or_update

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_delete

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_update

Parameters

Keyword-Only Parameters

Returns

Exceptions

get

Parameters

Keyword-Only Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Keyword-Only Parameters

Returns

Exceptions

list_by_subscription

Parameters

Keyword-Only Parameters

Returns

Exceptions

unauthorize_partner

Parameters

Keyword-Only Parameters

Returns

Exceptions

Attributes

models

Additional resources