BandwidthSchedulesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:bandwidth_schedules> attribute.
Constructor
BandwidthSchedulesOperations(*args, **kwargs)
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: _models.BandwidthSchedule, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BandwidthSchedule]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
name
Required
|
The bandwidth schedule name which needs to be added/updated. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
|
parameters
Required
|
The bandwidth schedule to be added or updated. Is either a BandwidthSchedule type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either BandwidthSchedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes the specified bandwidth schedule.
async begin_delete(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
name
Required
|
The bandwidth schedule name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets the properties of the specified bandwidth schedule.
async get(device_name: str, name: str, resource_group_name: str, **kwargs: Any) -> BandwidthSchedule
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
name
Required
|
The bandwidth schedule name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
BandwidthSchedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: Any) -> AsyncIterable[BandwidthSchedule]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either BandwidthSchedule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>