PartnerConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:partner_configurations> attribute.

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.

async 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. The name is case insensitive. Required.
partner_info Required	Partner or <xref:JSON> or IO[bytes] The information of the partner to be authorized. Is one of the following types: Partner, JSON, IO[bytes] Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration. The PartnerConfiguration is compatible with MutableMapping

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: _models.PartnerConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
partner_configuration_info Required	PartnerConfiguration or <xref:JSON> or IO[bytes] Partner configuration information. Is one of the following types: PartnerConfiguration, JSON, IO[bytes] Required.

Returns

Type	Description
AsyncLROPoller[PartnerConfiguration]	An instance of AsyncLROPoller that returns PartnerConfiguration. The PartnerConfiguration is compatible with MutableMapping

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. The name is case insensitive. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

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: _models.PartnerConfigurationUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
partner_configuration_update_parameters Required	PartnerConfigurationUpdateParameters or <xref:JSON> or IO[bytes] Partner configuration update information. Is one of the following types: PartnerConfigurationUpdateParameters, JSON, IO[bytes] Required.

Returns

Type	Description
AsyncLROPoller[PartnerConfiguration]	An instance of AsyncLROPoller that returns PartnerConfiguration. The PartnerConfiguration is compatible with MutableMapping

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. The name is case insensitive. Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration. The PartnerConfiguration is compatible with MutableMapping

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) -> AsyncItemPaged[PartnerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
AsyncItemPaged[PartnerConfiguration]	An iterator like instance of PartnerConfiguration

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) -> AsyncItemPaged[PartnerConfiguration]

Keyword-Only Parameters

Name	Description
filter	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. Default value: None
top	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. Default value: None

Name

Description

filter

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.

Default value: None

top

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.

Default value: None

Returns

Type	Description
AsyncItemPaged[PartnerConfiguration]	An iterator like instance of PartnerConfiguration

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: _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. The name is case insensitive. Required.
partner_info Required	Partner or <xref:JSON> or IO[bytes] The information of the partner to be unauthorized. Is one of the following types: Partner, JSON, IO[bytes] Required.

Returns

Type	Description
PartnerConfiguration	PartnerConfiguration. The PartnerConfiguration is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Comentários

Esta página foi útil?