PartnerNamespacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:partner_namespaces> attribute.

Inheritance

builtins.object

PartnerNamespacesOperations

Constructor

PartnerNamespacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create a partner namespace. Asynchronously creates a new partner namespace with the specified parameters.
begin_delete	Delete a partner namespace. Delete existing partner namespace.
begin_update	Update a partner namespace. Asynchronously updates a partner namespace with the specified parameters.
get	Get a partner namespace. Get properties of a partner namespace.
list_by_resource_group	List partner namespaces under a resource group. List all the partner namespaces under a resource group.
list_by_subscription	List partner namespaces under an Azure subscription. List all the partner namespaces under an Azure subscription.
list_shared_access_keys	List keys for a partner namespace. List the two keys used to publish to a partner namespace.
regenerate_key	Regenerate key for a partner namespace. Regenerate a shared access key for a partner namespace.

begin_create_or_update

Create a partner namespace.

Asynchronously creates a new partner namespace with the specified parameters.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_namespace_name Required	str Name of the partner namespace. Required.
partner_namespace_info Required	PartnerNamespace or IO[bytes] PartnerNamespace information. Is either a PartnerNamespace type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a partner namespace.

Delete existing partner namespace.

begin_delete(resource_group_name: str, partner_namespace_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.
partner_namespace_name Required	str Name of the partner namespace. 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 namespace.

Asynchronously updates a partner namespace with the specified parameters.

begin_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_update_parameters: _models.PartnerNamespaceUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PartnerNamespace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_namespace_name Required	str Name of the partner namespace. Required.
partner_namespace_update_parameters Required	PartnerNamespaceUpdateParameters or IO[bytes] Partner namespace update information. Is either a PartnerNamespaceUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get a partner namespace.

Get properties of a partner namespace.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List partner namespaces under a resource group.

List all the partner namespaces under a resource group.

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

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List partner namespaces under an Azure subscription.

List all the partner namespaces under an Azure subscription.

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

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

Exceptions

Type	Description
HttpResponseError

list_shared_access_keys

List keys for a partner namespace.

List the two keys used to publish to a partner namespace.

list_shared_access_keys(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) -> PartnerNamespaceSharedAccessKeys

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

regenerate_key

Regenerate key for a partner namespace.

Regenerate a shared access key for a partner namespace.

regenerate_key(resource_group_name: str, partner_namespace_name: str, regenerate_key_request: _models.PartnerNamespaceRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PartnerNamespaceSharedAccessKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
partner_namespace_name Required	str Name of the partner namespace. Required.
regenerate_key_request Required	PartnerNamespaceRegenerateKeyRequest or IO[bytes] Request body to regenerate key. Is either a PartnerNamespaceRegenerateKeyRequest type or a IO[bytes] type. Required.

Returns

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