NamespacesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:namespaces> attribute.

Constructor

NamespacesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a namespace. Asynchronously creates or updates a new namespace with the specified parameters.
begin_delete	Delete a namespace. Delete existing namespace.
begin_regenerate_key	Regenerate key for a namespace. Regenerate a shared access key for a namespace.
begin_update	Update a namespace. Asynchronously updates a namespace with the specified parameters.
begin_validate_custom_domain_ownership	Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.
get	Get a namespace. Get properties of a namespace.
list_by_resource_group	List namespaces under a resource group. List all the namespaces under a resource group.
list_by_subscription	List namespaces under an Azure subscription. List all the namespaces under an Azure subscription.
list_shared_access_keys	List keys for a namespace. List the two keys used to publish to a namespace.

begin_create_or_update

Create or update a namespace.

Asynchronously creates or updates a new namespace with the specified parameters.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a namespace.

Delete existing namespace.

begin_delete(resource_group_name: str, 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.
namespace_name Required	str Name of the 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_regenerate_key

Regenerate key for a namespace.

Regenerate a shared access key for a namespace.

begin_regenerate_key(resource_group_name: str, namespace_name: str, regenerate_key_request: _models.NamespaceRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NamespaceSharedAccessKeys]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Update a namespace.

Asynchronously updates a namespace with the specified parameters.

begin_update(resource_group_name: str, namespace_name: str, namespace_update_parameters: _models.NamespaceUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Namespace]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
namespace_name Required	str Name of the namespace. Required.
namespace_update_parameters Required	NamespaceUpdateParameters or IO[bytes] Namespace update information. Is either a NamespaceUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_validate_custom_domain_ownership

Validate ownership for all custom domains in a namespace.

Performs ownership validation via checking TXT records for all custom domains in a namespace.

begin_validate_custom_domain_ownership(resource_group_name: str, namespace_name: str, **kwargs: Any) -> LROPoller[CustomDomainOwnershipValidationResult]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get a namespace.

Get properties of a namespace.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List namespaces under a resource group.

List all the namespaces under a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription. Required.
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
ItemPaged[Namespace]	An iterator like instance of either Namespace or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List namespaces under an Azure subscription.

List all the namespaces under an Azure subscription.

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

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

Exceptions

Type	Description
HttpResponseError

list_shared_access_keys

List keys for a namespace.

List the two keys used to publish to a namespace.

list_shared_access_keys(resource_group_name: str, namespace_name: str, **kwargs: Any) -> NamespaceSharedAccessKeys

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv137\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>

Feedback

Was this page helpful?

Share via

NamespacesOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

begin_regenerate_key

Parameters

Returns

Exceptions

begin_update

Parameters

Returns

Exceptions

begin_validate_custom_domain_ownership

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Parameters

Returns

Exceptions

list_shared_access_keys

Parameters

Returns

Exceptions

Attributes

models

Feedback