bandwidth_settings

Creates, updates, deletes, gets or lists a bandwidth_settings resource.

Overview

Name	bandwidth_settings
Type	Resource
Id	azure_extras.storsimple_8000_series.bandwidth_settings

Fields

The following fields are returned by SELECT queries:

get

The bandwidth setting.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the bandwidth setting.
type	string	The hierarchical type of the object.

list_by_manager

The collection of bandwidth settings.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the bandwidth setting.
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bandwidthSettingName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified bandwidth setting name.
list_by_manager	select	subscriptionId, resourceGroupName, managerName		Retrieves all the bandwidth setting in a manager.
create_or_update	insert	bandwidthSettingName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the bandwidth setting
delete	delete	bandwidthSettingName, subscriptionId, resourceGroupName, managerName		Deletes the bandwidth setting

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bandwidthSettingName	string	The name of the bandwidth setting.
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id

SELECT examples

get

Returns the properties of the specified bandwidth setting name.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.bandwidth_settings
WHERE bandwidthSettingName = '{{ bandwidthSettingName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_manager

Retrieves all the bandwidth setting in a manager.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.bandwidth_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the bandwidth setting

INSERT INTO azure_extras.storsimple_8000_series.bandwidth_settings (
data__kind,
data__properties,
bandwidthSettingName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ bandwidthSettingName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: bandwidth_settings
  props:
    - name: bandwidthSettingName
      value: string
      description: Required parameter for the bandwidth_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the bandwidth_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bandwidth_settings resource.
    - name: managerName
      value: string
      description: Required parameter for the bandwidth_settings resource.
    - name: kind
      value: string
      description: |
        The Kind of the object. Currently only Series8000 is supported
      valid_values: ['Series8000']
    - name: properties
      value: object
      description: |
        The properties of the bandwidth setting.

DELETE examples

delete

Deletes the bandwidth setting

DELETE FROM azure_extras.storsimple_8000_series.bandwidth_settings
WHERE bandwidthSettingName = '{{ bandwidthSettingName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;