PartnerNamespacesOperations Class
PartnerNamespacesOperations 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.objectPartnerNamespacesOperations
Constructor
PartnerNamespacesOperations(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
| 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.
async begin_create_or_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_info: PartnerNamespace, **kwargs: Any) -> AsyncLROPoller[PartnerNamespace]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
|
partner_namespace_info
Required
|
PartnerNamespace information. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either PartnerNamespace or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete a partner namespace.
Delete existing partner namespace.
async begin_delete(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update a partner namespace.
Asynchronously updates a partner namespace with the specified parameters.
async begin_update(resource_group_name: str, partner_namespace_name: str, partner_namespace_update_parameters: PartnerNamespaceUpdateParameters, **kwargs: Any) -> AsyncLROPoller[PartnerNamespace]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
|
partner_namespace_update_parameters
Required
|
Partner namespace update information. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either PartnerNamespace or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a partner namespace.
Get properties of a partner namespace.
async get(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) -> PartnerNamespaceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PartnerNamespace, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[PartnerNamespacesListResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
filter
Required
|
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
|
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
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PartnerNamespacesListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[PartnerNamespacesListResult]Parameters
| Name | Description |
|---|---|
|
filter
Required
|
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
|
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
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either PartnerNamespacesListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_shared_access_keys
List keys for a partner namespace.
List the two keys used to publish to a partner namespace.
async list_shared_access_keys(resource_group_name: str, partner_namespace_name: str, **kwargs: Any) -> PartnerNamespaceSharedAccessKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PartnerNamespaceSharedAccessKeys, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
regenerate_key
Regenerate key for a partner namespace.
Regenerate a shared access key for a partner namespace.
async regenerate_key(resource_group_name: str, partner_namespace_name: str, regenerate_key_request: PartnerNamespaceRegenerateKeyRequest, **kwargs: Any) -> PartnerNamespaceSharedAccessKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the user's subscription. |
|
partner_namespace_name
Required
|
Name of the partner namespace. |
|
regenerate_key_request
Required
|
Request body to regenerate key. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
PartnerNamespaceSharedAccessKeys, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python