Microsoft Azure DeviceSettings API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeviceSettings API
schemes:
- https
tags:
- name: DeviceSettings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/alertSettings/default
  : get:
      tags:
      - DeviceSettings
      description: Gets the alert settings of the specified device.
      operationId: microsoftAzureDevicesettingsGetalertsettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Alert settings.
          schema:
            $ref: '#/definitions/AlertSettings'
      deprecated: false
      x-ms-examples:
        DeviceSettingsGetAlertSettings:
          $ref: ./examples/DeviceSettingsGetAlertSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
    put:
      tags:
      - DeviceSettings
      description: Creates or updates the alert settings of the specified device.
      operationId: microsoftAzureDevicesettingsCreateorupdatealertsettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: The alert settings to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/AlertSettings'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the alert settings.
          schema:
            $ref: '#/definitions/AlertSettings'
        '202':
          description: Accepted the request to create or update the alert settings.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceSettingsCreateOrUpdateAlertSettings:
          $ref: ./examples/DeviceSettingsCreateOrUpdateAlertSettings.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Alertsettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/networkSettings/default
  : get:
      tags:
      - DeviceSettings
      description: Gets the network settings of the specified device.
      operationId: microsoftAzureDevicesettingsGetnetworksettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Network settings.
          schema:
            $ref: '#/definitions/NetworkSettings'
      deprecated: false
      x-ms-examples:
        DeviceSettingsGetNetworkSettings:
          $ref: ./examples/DeviceSettingsGetNetworkSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Networksettings Default
    patch:
      tags:
      - DeviceSettings
      description: Updates the network settings on the specified device.
      operationId: microsoftAzureDevicesettingsUpdatenetworksettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: The network settings to be updated.
        required: true
        schema:
          $ref: '#/definitions/NetworkSettingsPatch'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Network settings.
          schema:
            $ref: '#/definitions/NetworkSettings'
        '202':
          description: Accepted the request to update network settings.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceSettingsUpdateNetworkSettings:
          $ref: ./examples/DeviceSettingsUpdateNetworkSettings.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Networksettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default
  : get:
      tags:
      - DeviceSettings
      description: Returns the Security properties of the specified device name.
      operationId: microsoftAzureDevicesettingsGetsecuritysettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Device Security settings.
          schema:
            $ref: '#/definitions/SecuritySettings'
      deprecated: false
      x-ms-examples:
        DeviceSettingsGetSecuritySettings:
          $ref: ./examples/DeviceSettingsGetSecuritySettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default
    patch:
      tags:
      - DeviceSettings
      description: Patch Security properties of the specified device name.
      operationId: microsoftAzureDevicesettingsUpdatesecuritysettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: The security settings properties to be patched.
        required: true
        schema:
          $ref: '#/definitions/SecuritySettingsPatch'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The device Security settings.
          schema:
            $ref: '#/definitions/SecuritySettings'
        '202':
          description: Accepted the request to update device security settings.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceSettingsUpdateSecuritySettings:
          $ref: ./examples/DeviceSettingsUpdateSecuritySettings.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default/syncRemoteManagementCertificate
  : post:
      tags:
      - DeviceSettings
      description: sync Remote management Certificate between appliance and Service
      operationId: microsoftAzureDevicesettingsSyncremotemanagementcertificate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to sync Remote Management certificate settings.
        '204':
          description: Successfully synced Remote Management certificate settings.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceSettingsSyncRemotemanagementCertificate:
          $ref: ./examples/DeviceSettingsSyncRemotemanagementCertificate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Securitysettings Default Syncremotemanagementcertificate
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/timeSettings/default
  : get:
      tags:
      - DeviceSettings
      description: Gets the time settings of the specified device.
      operationId: microsoftAzureDevicesettingsGettimesettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The time settings.
          schema:
            $ref: '#/definitions/TimeSettings'
      deprecated: false
      x-ms-examples:
        DeviceSettingsGetTimeSettings:
          $ref: ./examples/DeviceSettingsGetTimeSettings.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Timesettings Default
    put:
      tags:
      - DeviceSettings
      description: Creates or updates the time settings of the specified device.
      operationId: microsoftAzureDevicesettingsCreateorupdatetimesettings
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: parameters
        in: body
        description: The time settings to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/TimeSettings'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the time settings.
          schema:
            $ref: '#/definitions/TimeSettings'
        '202':
          description: Accepted the request to create or update the time settings.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        DeviceSettingsCreateOrUpdateTimeSettings:
          $ref: ./examples/DeviceSettingsCreateOrUpdateTimeSettings.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Timesettings Default
definitions:
  AlertNotificationProperties:
    description: The properties of the alert notification settings.
    required:
    - emailNotification
    type: object
    properties:
      emailNotification:
        description: Indicates whether email notification enabled or not.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: AlertEmailNotificationStatus
          modelAsString: false
      alertNotificationCulture:
        description: The alert notification culture.
        type: string
      notificationToServiceOwners:
        description: The value indicating whether alert notification enabled for admin or not.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: AlertEmailNotificationStatus
          modelAsString: false
      additionalRecipientEmailList:
        description: The alert notification email list.
        type: array
        items:
          type: string
  NetworkSettings:
    description: Represents the network settings of a device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/NetworkSettingsProperties'
        description: The properties of network settings of a device.
        x-ms-client-flatten: true
  NetworkAdapterList:
    description: The collection of network adapters on the device.
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/NetworkAdapters'
        x-ms-identifiers:
        - interfaceId
  WebproxySettings:
    description: The web proxy settings on the device.
    required:
    - authentication
    - username
    type: object
    properties:
      connectionUri:
        description: The connection URI.
        type: string
      authentication:
        description: The authentication type.
        enum:
        - Invalid
        - None
        - Basic
        - NTLM
        type: string
        x-ms-enum:
          name: AuthenticationType
          modelAsString: false
      username:
        description: The webproxy username.
        type: string
  NicIPv6:
    description: Details related to the IPv6 address configuration.
    type: object
    properties:
      ipv6Address:
        description: The IPv6 address of the network adapter.
        type: string
      ipv6Prefix:
        description: The IPv6 prefix of the network adapter.
        type: string
      ipv6Gateway:
        description: The IPv6 gateway of the network adapter.
        type: string
      controller0Ipv6Address:
        description: The IPv6 address of Controller0.
        type: string
      controller1Ipv6Address:
        description: The IPv6 address of Controller1.
        type: string
  TimeSettings:
    description: The time settings of a device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/TimeSettingsProperties'
        description: The properties of the time settings of a device.
        x-ms-client-flatten: true
  SecuritySettings:
    description: The security settings of a device.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/SecuritySettingsProperties'
        description: The properties of the security settings of a device.
        x-ms-client-flatten: true
  ChapSettings:
    description: The Challenge-Handshake Authentication Protocol (CHAP) settings.
    type: object
    properties:
      initiatorUser:
        description: The CHAP initiator user.
        type: string
      initiatorSecret:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The CHAP initiator secret.
      targetUser:
        description: The CHAP target user.
        type: string
      targetSecret:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The target secret.
  AlertSettings:
    description: The alert settings.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/AlertNotificationProperties'
        description: The properties of the alert notification settings.
        x-ms-client-flatten: true
  BaseModel:
    description: Represents the base class for all other ARM object models
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      kind:
        description: The Kind of the object. Currently only Series8000 is supported
        enum:
        - Series8000
        type: string
        x-ms-enum:
          name: Kind
          modelAsString: false
  DNSSettings:
    description: The DNS(Domain Name Server) settings of a device.
    type: object
    properties:
      primaryDnsServer:
        description: The primary IPv4 DNS server for the device
        type: string
      primaryIpv6DnsServer:
        description: The primary IPv6 DNS server for the device
        type: string
      secondaryDnsServers:
        description: The secondary IPv4 DNS server for the device
        type: array
        items:
          type: string
      secondaryIpv6DnsServers:
        description: The secondary IPv6 DNS server for the device
        type: array
        items:
          type: string
  SecuritySettingsPatch:
    description: Represents the patch request for the security settings of a device.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/SecuritySettingsPatchProperties'
        description: The properties of the security settings patch.
        x-ms-client-flatten: true
  SecuritySettingsProperties:
    description: The properties of security settings of a device.
    required:
    - remoteManagementSettings
    - chapSettings
    type: object
    properties:
      remoteManagementSettings:
        $ref: '#/definitions/RemoteManagementSettings'
        description: The settings for remote management of a device.
      chapSettings:
        $ref: '#/definitions/ChapSettings'
        description: The Challenge-Handshake Authentication Protocol (CHAP) settings.
  NicIPv4:
    description: Details related to the IPv4 address configuration.
    type: object
    properties:
      ipv4Address:
        description: The IPv4 address of the network adapter.
        type: string
      ipv4Netmask:
        description: The IPv4 netmask of the network adapter.
        type: string
      ipv4Gateway:
        description: The IPv4 gateway of the network adapter.
        type: string
      controller0Ipv4Address:
        description: The IPv4 address of Controller0.
        type: string
      controller1Ipv4Address:
        description: The IPv4 address of Controller1.
        type: string
  TimeSettingsProperties:
    description: The properties of time settings of a device.
    required:
    - timeZone
    type: object
    properties:
      timeZone:
        description: The timezone of device, like '(UTC -06:00) Central America'
        type: string
      primaryTimeServer:
        description: The primary Network Time Protocol (NTP) server name, like 'time.windows.com'.
        type: string
      secondaryTimeServer:
        description: The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional.
        type: array
        items:
          type: string
  SecuritySettingsPatchProperties:
    description: The properties of the security settings patch.
    type: object
    properties:
      remoteManagementSettings:
        $ref: '#/definitions/RemoteManagementSettingsPatch'
        description: The remote management settings.
      deviceAdminPassword:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The device administrator password.
      snapshotPassword:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The snapshot manager password.
      chapSettings:
        $ref: '#/definitions/ChapSettings'
        description: The device CHAP and reverse-CHAP settings.
      cloudApplianceSettings:
        $ref: '#/definitions/CloudApplianceSettings'
        description: The cloud appliance settings.
  NetworkSettingsProperties:
    description: The properties of the network settings of device.
    required:
    - dnsSettings
    - networkAdapters
    - webproxySettings
    type: object
    properties:
      dnsSettings:
        $ref: '#/definitions/DNSSettings'
        description: The DNS (Domain Name System) settings of device.
      networkAdapters:
        $ref: '#/definitions/NetworkAdapterList'
        description: The network adapter list of device.
      webproxySettings:
        $ref: '#/definitions/WebproxySettings'
        description: The webproxy settings of device.
  RemoteManagementSettings:
    description: The settings for remote management of a device.
    required:
    - remoteManagementMode
    type: object
    properties:
      remoteManagementMode:
        description: The remote management mode.
        enum:
        - Unknown
        - Disabled
        - HttpsEnabled
        - HttpsAndHttpEnabled
        type: string
        x-ms-enum:
          name: RemoteManagementModeConfiguration
          modelAsString: false
      remoteManagementCertificate:
        description: The remote management certificates.
        type: string
  AsymmetricEncryptedSecret:
    description: Represent the secrets intended for encryption with asymmetric key pair.
    required:
    - value
    - encryptionAlgorithm
    type: object
    properties:
      value:
        description: The value of the secret.
        type: string
      encryptionCertThumbprint:
        description: Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null.
        type: string
      encryptionAlgorithm:
        description: The algorithm used to encrypt "Value".
        enum:
        - None
        - AES256
        - RSAES_PKCS1_v_1_5
        type: string
        x-ms-enum:
          name: EncryptionAlgorithm
          modelAsString: false
  NetworkSettingsPatchProperties:
    description: The properties of the network settings patch.
    type: object
    properties:
      dnsSettings:
        $ref: '#/definitions/DNSSettings'
        description: The DNS (Domain Name System) settings of device.
      networkAdapters:
        $ref: '#/definitions/NetworkAdapterList'
        description: The network adapter list of device.
  CloudApplianceSettings:
    description: The cloud appliance settings.
    type: object
    properties:
      serviceDataEncryptionKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The service data encryption key (encrypted with DAK).
      channelIntegrityKey:
        $ref: '#/definitions/AsymmetricEncryptedSecret'
        description: The channel integrity key (encrypted with DAK).
  NetworkAdapters:
    description: Represents the network adapter on device.
    required:
    - interfaceId
    - netInterfaceStatus
    - iscsiAndCloudStatus
    - mode
    type: object
    properties:
      interfaceId:
        description: The ID of the network adapter.
        enum:
        - Invalid
        - Data0
        - Data1
        - Data2
        - Data3
        - Data4
        - Data5
        type: string
        x-ms-enum:
          name: NetInterfaceId
          modelAsString: false
      netInterfaceStatus:
        description: Value indicating status of network adapter.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: NetInterfaceStatus
          modelAsString: false
      isDefault:
        description: Value indicating whether this instance is default.
        type: boolean
      iscsiAndCloudStatus:
        description: Value indicating cloud and ISCSI status of network adapter.
        enum:
        - Disabled
        - IscsiEnabled
        - CloudEnabled
        - IscsiAndCloudEnabled
        type: string
        x-ms-enum:
          name: ISCSIAndCloudStatus
          modelAsString: false
      speed:
        format: int64
        description: The speed of the network adapter.
        type: integer
      mode:
        description: The mode of network adapter, either IPv4, IPv6 or both.
        enum:
        - Invalid
        - IPV4
        - IPV6
        - BOTH
        type: string
        x-ms-enum:
          name: NetworkMode
          modelAsString: false
      nicIpv4Settings:
        $ref: '#/definitions/NicIPv4'
        description: The IPv4 configuration of the network adapter.
      nicIpv6Settings:
        $ref: '#/definitions/NicIPv6'
        description: The IPv6 configuration of the network adapter.
  NetworkSettingsPatch:
    description: Represents the patch request for the network settings of a device.
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/NetworkSettingsPatchProperties'
        description: The properties of the network settings patch.
        x-ms-client-flatten: true
  RemoteManagementSettingsPatch:
    description: The settings for updating remote management mode of the device.
    required:
    - remoteManagementMode
    type: object
    properties:
      remoteManagementMode:
        description: The remote management mode.
        enum:
        - Unknown
        - Disabled
        - HttpsEnabled
        - HttpsAndHttpEnabled
        type: string
        x-ms-enum:
          name: RemoteManagementModeConfiguration
          modelAsString: false
parameters:
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  apiVersionParameter:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
    x-ms-skip-url-encoding: true
  deviceNameParameter:
    name: deviceName
    in: path
    description: The device name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'