Microsoft Azure DeviceSettings API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Device Settings API
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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Alert settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the alert settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertSettings'
        description: The alert settings to be added or updated.
        required: true
  ? /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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Network settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The Network settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkSettingsPatch'
        description: The network settings to be updated.
        required: true
  ? /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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Device Security settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The device Security settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecuritySettingsPatch'
        description: The security settings properties to be patched.
        required: true
  ? /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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: The time settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      parameters:
      - $ref: '#/components/parameters/deviceNameParameter'
      - $ref: '#/components/parameters/subscriptionIdParameter'
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/managerNameParameter'
      - $ref: '#/components/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the time settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeSettings'
        description: The time settings to be added or updated.
        required: true
components:
  schemas:
    AlertSettings:
      description: The alert settings.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/AlertNotificationProperties'
          description: The properties of the alert notification settings.
          x-ms-client-flatten: true
    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
    SecuritySettingsProperties:
      description: The properties of security settings of a device.
      required:
      - remoteManagementSettings
      - chapSettings
      type: object
      properties:
        remoteManagementSettings:
          $ref: '#/components/schemas/RemoteManagementSettings'
          description: The settings for remote management of a device.
        chapSettings:
          $ref: '#/components/schemas/ChapSettings'
          description: The Challenge-Handshake Authentication Protocol (CHAP) settings.
    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: '#/components/schemas/NicIPv4'
          description: The IPv4 configuration of the network adapter.
        nicIpv6Settings:
          $ref: '#/components/schemas/NicIPv6'
          description: The IPv6 configuration of the network adapter.
    SecuritySettingsPatchProperties:
      description: The properties of the security settings patch.
      type: object
      properties:
        remoteManagementSettings:
          $ref: '#/components/schemas/RemoteManagementSettingsPatch'
          description: The remote management settings.
        deviceAdminPassword:
          $ref: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The device administrator password.
        snapshotPassword:
          $ref: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The snapshot manager password.
        chapSettings:
          $ref: '#/components/schemas/ChapSettings'
          description: The device CHAP and reverse-CHAP settings.
        cloudApplianceSettings:
          $ref: '#/components/schemas/CloudApplianceSettings'
          description: The cloud appliance settings.
    CloudApplianceSettings:
      description: The cloud appliance settings.
      type: object
      properties:
        serviceDataEncryptionKey:
          $ref: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The service data encryption key (encrypted with DAK).
        channelIntegrityKey:
          $ref: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The channel integrity key (encrypted with DAK).
    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
    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
    TimeSettings:
      description: The time settings of a device.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/TimeSettingsProperties'
          description: The properties of the time settings of a device.
          x-ms-client-flatten: true
    NetworkSettingsProperties:
      description: The properties of the network settings of device.
      required:
      - dnsSettings
      - networkAdapters
      - webproxySettings
      type: object
      properties:
        dnsSettings:
          $ref: '#/components/schemas/DNSSettings'
          description: The DNS (Domain Name System) settings of device.
        networkAdapters:
          $ref: '#/components/schemas/NetworkAdapterList'
          description: The network adapter list of device.
        webproxySettings:
          $ref: '#/components/schemas/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
    NetworkSettings:
      description: Represents the network settings of a device.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/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: '#/components/schemas/NetworkAdapters'
          x-ms-identifiers:
          - interfaceId
    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
    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
    NetworkSettingsPatchProperties:
      description: The properties of the network settings patch.
      type: object
      properties:
        dnsSettings:
          $ref: '#/components/schemas/DNSSettings'
          description: The DNS (Domain Name System) settings of device.
        networkAdapters:
          $ref: '#/components/schemas/NetworkAdapterList'
          description: The network adapter list of device.
    SecuritySettings:
      description: The security settings of a device.
      required:
      - properties
      type: object
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      properties:
        properties:
          $ref: '#/components/schemas/SecuritySettingsProperties'
          description: The properties of the security settings of a device.
          x-ms-client-flatten: true
    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
    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
    SecuritySettingsPatch:
      description: Represents the patch request for the security settings of a device.
      required:
      - properties
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/SecuritySettingsPatchProperties'
          description: The properties of the security settings patch.
          x-ms-client-flatten: true
    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
    NetworkSettingsPatch:
      description: Represents the patch request for the network settings of a device.
      required:
      - properties
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/NetworkSettingsPatchProperties'
          description: The properties of the network settings patch.
          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: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The CHAP initiator secret.
        targetUser:
          description: The CHAP target user.
          type: string
        targetSecret:
          $ref: '#/components/schemas/AsymmetricEncryptedSecret'
          description: The target secret.
    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
  parameters:
    deviceNameParameter:
      name: deviceName
      in: path
      description: The device name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    managerNameParameter:
      name: managerName
      in: path
      description: The manager name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
        maxLength: 50
        minLength: 2
    resourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The resource group name
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    subscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The subscription id
      required: true
      x-ms-skip-url-encoding: true
      schema:
        type: string
    apiVersionParameter:
      name: api-version
      in: query
      description: The api version
      required: true
      x-ms-skip-url-encoding: true
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'