PeeringsOperations Class

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

Constructor

PeeringsOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

create_or_update

Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.

delete

Deletes an existing peering with the specified name under the given subscription and resource group.

get

Gets an existing peering with the specified name under the given subscription and resource group.

list_by_resource_group

Lists all of the peerings under the given subscription and resource group.

list_by_subscription

Lists all of the peerings under the given subscription.

update

Updates tags for a peering with the specified name under the given subscription and resource group.

create_or_update

Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.

async create_or_update(resource_group_name: str, peering_name: str, peering: azure.mgmt.peering.models._models_py3.Peering, **kwargs) -> azure.mgmt.peering.models._models_py3.Peering

Parameters

resource_group_name
str
Required

The name of the resource group.

peering_name
str
Required

The name of the peering.

peering
Peering
Required

The properties needed to create or update a peering.

cls
callable

A custom type or function that will be passed the direct response

Returns

Peering, or the result of cls(response)

Return type

Exceptions

delete

Deletes an existing peering with the specified name under the given subscription and resource group.

async delete(resource_group_name: str, peering_name: str, **kwargs) -> None

Parameters

resource_group_name
str
Required

The name of the resource group.

peering_name
str
Required

The name of the peering.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Gets an existing peering with the specified name under the given subscription and resource group.

async get(resource_group_name: str, peering_name: str, **kwargs) -> azure.mgmt.peering.models._models_py3.Peering

Parameters

resource_group_name
str
Required

The name of the resource group.

peering_name
str
Required

The name of the peering.

cls
callable

A custom type or function that will be passed the direct response

Returns

Peering, or the result of cls(response)

Return type

Exceptions

list_by_resource_group

Lists all of the peerings under the given subscription and resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.peering.models._models_py3.PeeringListResult]

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PeeringListResult or the result of cls(response)

Return type

Exceptions

list_by_subscription

Lists all of the peerings under the given subscription.

list_by_subscription(**kwargs) -> AsyncIterable[azure.mgmt.peering.models._models_py3.PeeringListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PeeringListResult or the result of cls(response)

Return type

Exceptions

update

Updates tags for a peering with the specified name under the given subscription and resource group.

async update(resource_group_name: str, peering_name: str, tags: azure.mgmt.peering.models._models_py3.ResourceTags, **kwargs) -> azure.mgmt.peering.models._models_py3.Peering

Parameters

resource_group_name
str
Required

The name of the resource group.

peering_name
str
Required

The name of the peering.

tags
ResourceTags
Required

The resource tags.

cls
callable

A custom type or function that will be passed the direct response

Returns

Peering, or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.peering.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\peering\\models\\__init__.py'>