Microsoft Azure ChapSettings API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ChapSettings API
schemes:
- https
tags:
- name: ChapSettings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings
  : get:
      tags:
      - ChapSettings
      description: Retrieves all the chap settings in a device.
      operationId: microsoftAzureChapsettingsListbydevice
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The name of the device.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of chap settings.
          schema:
            $ref: '#/definitions/ChapSettingsList'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        ChapSettingsListByDevice:
          $ref: ./examples/ChapSettingsListByDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Chapsettings
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/chapSettings/{chapUserName}
  : get:
      tags:
      - ChapSettings
      description: Returns the properties of the specified chap setting name.
      operationId: microsoftAzureChapsettingsGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: chapUserName
        in: path
        description: The user name of chap to be fetched.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The chap setting.
          schema:
            $ref: '#/definitions/ChapSettings'
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-examples:
        ChapSettingsGet:
          $ref: ./examples/ChapSettingsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Chapsettings Chapusername
    put:
      tags:
      - ChapSettings
      description: Creates or updates the chap setting.
      operationId: microsoftAzureChapsettingsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: chapUserName
        in: path
        description: The chap user name.
        required: true
        type: string
      - name: chapSetting
        in: body
        description: The chap setting to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/ChapSettings'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the chap setting.
          schema:
            $ref: '#/definitions/ChapSettings'
        '202':
          description: Accepted the request to create or update the chap setting.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        ChapSettingsCreateOrUpdate:
          $ref: ./examples/ChapSettingsCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Chapsettings Chapusername
    delete:
      tags:
      - ChapSettings
      description: Deletes the chap setting.
      operationId: microsoftAzureChapsettingsDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: chapUserName
        in: path
        description: The chap user name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the chap setting.
        '204':
          description: Successfully deleted the chap setting.
        default:
          description: Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.
          schema:
            $ref: '#/definitions/Error'
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        ChapSettingsDelete:
          $ref: ./examples/ChapSettingsDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Chapsettings Chapusername
definitions:
  ChapProperties:
    description: Chap properties
    required:
    - password
    type: object
    properties:
      password:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The chap password.
  AsymmetricEncryptedSecret:
    description: This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null.
        type: string
      encryptionCertificateThumbprint:
        description: Thumbprint certificate that was used to encrypt "Value"
        type: string
      encryptionAlgorithm:
        description: Algorithm used to encrypt "Value"
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: false
  Message:
    type: object
    properties:
      language:
        type: string
      value:
        type: string
  ChapSettings:
    description: Challenge-Handshake Authentication Protocol (CHAP) setting
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/ChapProperties'
        description: Chap properties
        x-ms-client-flatten: true
  ChapSettingsList:
    description: Collection of Chap setting entities
    required:
    - value
    type: object
    properties:
      value:
        description: The chap settings entity collection
        type: array
        items:
          $ref: '#/definitions/ChapSettings'
  BaseModel:
    description: Base class for models
    type: object
    properties:
      id:
        description: The identifier.
        type: string
        readOnly: true
      name:
        description: The name.
        type: string
        readOnly: true
      type:
        description: The type.
        type: string
        readOnly: true
  Item:
    required:
    - key
    - value
    type: object
    properties:
      key:
        type: string
      value:
        type: string
  Error:
    required:
    - errorCode
    - message
    type: object
    properties:
      errorCode:
        type: string
      message:
        $ref: '#/definitions/Message'
      values:
        type: array
        items:
          $ref: '#/definitions/Item'
        x-ms-identifiers:
        - key
parameters:
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'