az databoxedge bandwidth-schedule

  • Preview
  • Reference

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage bandwidth schedule with databoxedge.

Commands

Name Description Type Status
az databoxedge bandwidth-schedule create

Create a bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule delete

Delete the specified bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule list

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

 Core Preview
az databoxedge bandwidth-schedule show

Get the properties of the specified bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule update

Update a bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule wait

Place the CLI in a waiting state until a condition of the databoxedge bandwidth-schedule is met.

 Core Preview

az databoxedge bandwidth-schedule create

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a bandwidth schedule.

az databoxedge bandwidth-schedule create --days
                                         --device-name
                                         --name
                                         --rate-in-mbps
                                         --resource-group
                                         --start
                                         --stop
                                         [--no-wait]

Examples

Create a bandwidth schedule.

az databoxedge bandwidth-schedule create --name "bandwidth-1" --device-name "testedgedevice" --days "Sunday" "Monday" --rate-in-mbps 100 --start "0:0:0" --stop "13:59:0" --resource-group "GroupForEdgeAutomation"

Required Parameters

--days

The days of the week when this schedule is applicable.

--device-name -d

The device name.

--name -n

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

--rate-in-mbps

The bandwidth rate in Mbps.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--start

The start time of the schedule in UTC.

--stop

The stop time of the schedule in UTC.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge bandwidth-schedule delete

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the specified bandwidth schedule.

az databoxedge bandwidth-schedule delete [--device-name]
                                         [--ids]
                                         [--name]
                                         [--no-wait]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete the specified bandwidth schedule.

az databoxedge bandwidth-schedule delete --name "bandwidth-1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name -d

The device name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The bandwidth schedule name.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge bandwidth-schedule list

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az databoxedge bandwidth-schedule list --device-name
                                       --resource-group

Examples

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

az databoxedge bandwidth-schedule list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Required Parameters

--device-name -d

The device name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge bandwidth-schedule show

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the properties of the specified bandwidth schedule.

az databoxedge bandwidth-schedule show [--device-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get the properties of the specified bandwidth schedule.

az databoxedge bandwidth-schedule show --name "bandwidth-1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name -d

The device name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The bandwidth schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge bandwidth-schedule update

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a bandwidth schedule.

az databoxedge bandwidth-schedule update --days
                                         --rate-in-mbps
                                         --start
                                         --stop
                                         [--add]
                                         [--device-name]
                                         [--force-string]
                                         [--ids]
                                         [--name]
                                         [--no-wait]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

Examples

Update a bandwidth schedule.

az databoxedge bandwidth-schedule update --name "bandwidth-1" --device-name "testedgedevice"         --rate-in-mbps 150 --resource-group "GroupForEdgeAutomation" --start "0:0:0" --stop 12:00:00 --days Sunday

Required Parameters

--days

The days of the week when this schedule is applicable.

--rate-in-mbps

The bandwidth rate in Mbps.

--start

The start time of the schedule in UTC.

--stop

The stop time of the schedule in UTC.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--device-name -d

The device name.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

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

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge bandwidth-schedule wait

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition of the databoxedge bandwidth-schedule is met.

az databoxedge bandwidth-schedule wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--device-name]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Examples

Pause executing next line of CLI script until the databoxedge bandwidth-schedule is successfully created.

az databoxedge bandwidth-schedule wait --name "bandwidth-1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --created

Pause executing next line of CLI script until the databoxedge bandwidth-schedule is successfully updated.

az databoxedge bandwidth-schedule wait --name "bandwidth-1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --updated

Pause executing next line of CLI script until the databoxedge bandwidth-schedule is successfully deleted.

az databoxedge bandwidth-schedule wait --name "bandwidth-1" --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--device-name -d

The device name.

--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name -n

The bandwidth schedule name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.