BandwidthSchedulesOperations Class

BandwidthSchedulesOperations 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

BandwidthSchedulesOperations

Constructor

BandwidthSchedulesOperations(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

begin_create_or_update	Creates or updates a bandwidth schedule.
begin_delete	Deletes the specified bandwidth schedule.
get	Gets the properties of the specified bandwidth schedule.
list_by_data_box_edge_device	Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

begin_create_or_update

Creates or updates a bandwidth schedule.

async begin_create_or_update(device_name: str, name: str, resource_group_name: str, parameters: azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.BandwidthSchedule, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.BandwidthSchedule]

Parameters

device_name

str

Required

The device name.

name

str

Required

The bandwidth schedule name which needs to be added/updated.

resource_group_name

str

Required

The resource group name.

parameters

BandwidthSchedule

Required

The bandwidth schedule to be added or updated.

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either BandwidthSchedule or the result of cls(response)

Return type

AsyncLROPoller[BandwidthSchedule]

Exceptions

HttpResponseError

begin_delete

Deletes the specified bandwidth schedule.

async begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

device_name

str

Required

The device name.

name

str

Required

The bandwidth schedule name.

resource_group_name

str

Required

The resource group name.

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets the properties of the specified bandwidth schedule.

async get(device_name: str, name: str, resource_group_name: str, **kwargs) -> azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.BandwidthSchedule

Parameters

device_name

str

Required

The device name.

name

str

Required

The bandwidth schedule name.

resource_group_name

str

Required

The resource group name.

cls

callable

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

Returns

BandwidthSchedule, or the result of cls(response)

Return type

BandwidthSchedule

Exceptions

HttpResponseError

list_by_data_box_edge_device

Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

list_by_data_box_edge_device(device_name: str, resource_group_name: str, **kwargs) -> AsyncIterable[azure.mgmt.databoxedge.v2020_05_01_preview.models._models_py3.BandwidthSchedulesList]

Parameters

device_name

str

Required

The device name.

resource_group_name

str

Required

The resource group name.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[BandwidthSchedulesList]

Exceptions

HttpResponseError

Attributes

models

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