BandwidthSchedulesOperations Class

BandwidthSchedulesOperations operations.

Inheritance

builtins.object

BandwidthSchedulesOperations

Constructor

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

Name	Description
device_name Required	str The device name.
name Required	str The bandwidth schedule name which needs to be added/updated.
parameters Required	BandwidthSchedule The bandwidth schedule to be added or updated.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool The poller return type is ClientRawResponse, the direct response alongside the deserialized response default value: False
polling	True for ARMPolling, False for no polling, or a polling object for personal polling strategy default value: True

Returns

Type	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[BandwidthSchedule], <xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[BandwidthSchedule]]	An instance of LROPoller that returns BandwidthSchedule or ClientRawResponse if raw==True

Exceptions

Type	Description
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

Name	Description
device_name Required	str The device name.
name Required	str The bandwidth schedule name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool The poller return type is ClientRawResponse, the direct response alongside the deserialized response default value: False
polling	True for ARMPolling, False for no polling, or a polling object for personal polling strategy default value: True

Returns

Type	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[None], <xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:msrest.pipeline.ClientRawResponse>[None]]	An instance of LROPoller that returns None or ClientRawResponse if raw==True

Exceptions

Type	Description
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

Name	Description
device_name Required	str The device name.
name Required	str The bandwidth schedule name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
BandwidthSchedule, <xref:msrest.pipeline.ClientRawResponse>	BandwidthSchedule or ClientRawResponse if raw=true

Exceptions

Type	Description
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

Name	Description
device_name Required	str The device name.
resource_group_name Required	str The resource group name.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
BandwidthSchedulePaged[BandwidthSchedule]	An iterator like instance of BandwidthSchedule

Exceptions

Type	Description
msrestazure.azure_exceptions.CloudError

Attributes

models

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