BandwidthSchedulesOperations Class

BandwidthSchedulesOperations operations.

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

api_version

The API version. Constant value: "2019-03-01".

Methods

create_or_update

Creates or updates a bandwidth schedule.

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/gateway device.

create_or_update

Creates or updates a bandwidth schedule.

create_or_update(device_name, name, parameters, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name
str
Required

The device name.

name
str
Required

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

parameters
BandwidthSchedule
Required

The bandwidth schedule to be added or updated.

resource_group_name
str
Required

The resource group name.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling
default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BandwidthSchedule or ClientRawResponse if raw==True

Return type

<xref:msrestazure.azure_operation.AzureOperationPoller>[BandwidthSchedule],
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[BandwidthSchedule]]

Exceptions

msrestazure.azure_exceptions.CloudError

delete

Deletes the specified bandwidth schedule.

delete(device_name, name, resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

device_name
str
Required

The device name.

name
str
Required

The bandwidth schedule name.

resource_group_name
str
Required

The resource group name.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling
default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

<xref:msrestazure.azure_operation.AzureOperationPoller>[None],
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[None]]

Exceptions

msrestazure.azure_exceptions.CloudError

get

Gets the properties of the specified bandwidth schedule.

get(device_name, name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name
str
Required

The device name.

name
str
Required

The bandwidth schedule name.

resource_group_name
str
Required

The resource group name.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

BandwidthSchedule or ClientRawResponse if raw=true

Return type

<xref:msrest.pipeline.ClientRawResponse>

Exceptions

msrestazure.azure_exceptions.CloudError

list_by_data_box_edge_device

Gets all the bandwidth schedules for a data box edge/gateway device.

list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

device_name
str
Required

The device name.

resource_group_name
str
Required

The resource group name.

custom_headers
dict
default value: None

headers that will be added to the request

raw
bool
default value: False

returns the direct response alongside the deserialized response

operation_config
Required

Operation configuration overrides.

Returns

An iterator like instance of BandwidthSchedule

Return type

Exceptions

msrestazure.azure_exceptions.CloudError

Attributes

models

models = <module 'azure.mgmt.edgegateway.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\edgegateway\\models\\__init__.py'>