chap_settings

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

Overview

Name	chap_settings
Type	Resource
Id	azure_extras.storsimple_1200_series.chap_settings

Fields

The following fields are returned by SELECT queries:

get

The chap setting.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Chap properties
type	string	The type.

list_by_device

The collection of chap settings.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Chap properties
type	string	The type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, chapUserName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified chap setting name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Retrieves all the chap settings in a device.
create_or_update	insert	deviceName, chapUserName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the chap setting.
delete	delete	deviceName, chapUserName, subscriptionId, resourceGroupName, managerName		Deletes the chap 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
chapUserName	string	The chap user name.
deviceName	string	The device name.
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 chap setting name.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.chap_settings
WHERE deviceName = '{{ deviceName }}' -- required
AND chapUserName = '{{ chapUserName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_device

Retrieves all the chap settings in a device.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.chap_settings
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the chap setting.

INSERT INTO azure_extras.storsimple_1200_series.chap_settings (
data__properties,
deviceName,
chapUserName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ chapUserName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: chap_settings
  props:
    - name: deviceName
      value: string
      description: Required parameter for the chap_settings resource.
    - name: chapUserName
      value: string
      description: Required parameter for the chap_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the chap_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the chap_settings resource.
    - name: managerName
      value: string
      description: Required parameter for the chap_settings resource.
    - name: properties
      value: object
      description: |
        Chap properties

DELETE examples

delete

Deletes the chap setting.

DELETE FROM azure_extras.storsimple_1200_series.chap_settings
WHERE deviceName = '{{ deviceName }}' --required
AND chapUserName = '{{ chapUserName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;