Device Settings - Update Security Settings

Patch Security properties of the specified device name.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/securitySettings/default?api-version=2017-06-01

URI Parameters

Name In Required Type Description
deviceName
path True
  • string

The device name

managerName
path True
  • string

The manager name

resourceGroupName
path True
  • string

The resource group name

subscriptionId
path True
  • string

The subscription id

api-version
query True
  • string

The api version

Request Body

Name Type Description
properties.chapSettings

The device CHAP and reverse-CHAP settings.

properties.cloudApplianceSettings

The cloud appliance settings.

properties.deviceAdminPassword

The device administrator password.

properties.remoteManagementSettings

The remote management settings.

properties.snapshotPassword

The snapshot manager password.

Responses

Name Type Description
200 OK

The device Security settings.

202 Accepted

Accepted the request to update device security settings.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DeviceSettingsUpdateSecuritySettings

Sample Request

PATCH https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/securitySettings/default?api-version=2017-06-01
{
  "properties": {
    "remoteManagementSettings": {
      "remoteManagementMode": "HttpsAndHttpEnabled"
    },
    "deviceAdminPassword": {
      "value": "<value>",
      "encryptionCertThumbprint": "A872A2DF196AC7682EE24791E7DE2E2A360F5926",
      "encryptionAlgorithm": "RSAES_PKCS1_v_1_5"
    },
    "snapshotPassword": {
      "value": "<value>",
      "encryptionCertThumbprint": "A872A2DF196AC7682EE24791E7DE2E2A360F5926",
      "encryptionAlgorithm": "RSAES_PKCS1_v_1_5"
    },
    "chapSettings": {
      "initiatorUser": "test-initiator-user",
      "initiatorSecret": {
        "value": "V/uVfWk5OcXfMC0HvUV89o9+cmF636jBnqhFM1pD/zHhmh8Z1KB5/LhVV3T53uGjIlKL3wjhwg+9NIQrIbYuKhl/r8jSftSSH+WqUnQHTRDWazjPAeMu6ozrL5RYzP1h5mgw7XtidZPaaV9ae/uF1KQPkK6TIARaOTdr8I/BLWUg7WdDrfARNYHnW6ezXek1M9Qhv1sL9fZY+JrGB58LF6D2aC2Xjed4K4Jk6v2T1ieneNV27uIdnt21TajuM7w90UlRiVZJZtq/KdEUfqI28C7VoUdcXluAwzR95Ho8hmyIJDqeW3/Wxymdjv+Rctwqtmcka9i2G85Hj8SVV3g4kA==",
        "encryptionCertThumbprint": "A872A2DF196AC7682EE24791E7DE2E2A360F5926",
        "encryptionAlgorithm": "RSAES_PKCS1_v_1_5"
      },
      "targetUser": "test-target-user",
      "targetSecret": {
        "value": "OTR4uwVpy+pf0zthnCIAUXurC8NdSh8RpRG5GWL9TSv4WtkVmpeU/U2A4vjkrchfQOzI1x+uooWikWW9txwwQOM+/N3NG44+/dlHoaEe7AxjmItCKhNj8K2RM6D1mb45wicbF/M4uanuXnGXuT+JmZ+1Lcy2k1GXsk67ejplz2K08h37B+oIW85qMUHLdKuuQlAA/fFS+q6qMti3j2Q8Fr+Sh4U76/2AZVkKRtFeqPB1QhC12dFx6TFoZJkMFzdQz4WNvWVelIK2McKNnOiH0/Z5lAXC7164uzReAoTEfqoNU7qqqRrHhsdwWPu6jbeUn8BQnr7A/X6NWvgeax+HGA==",
        "encryptionCertThumbprint": "A872A2DF196AC7682EE24791E7DE2E2A360F5926",
        "encryptionAlgorithm": "RSAES_PKCS1_v_1_5"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "remoteManagementSettings": {
      "remoteManagementMode": "HttpsAndHttpEnabled",
      "remoteManagementCertificate": ""
    },
    "chapSettings": {
      "initiatorUser": "test-initiator-user",
      "targetUser": "test-target-user"
    }
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/securitySettings/default",
  "name": "default",
  "type": "Microsoft.StorSimple/managers/devices/securitySettings",
  "kind": "Series8000"
}

Definitions

AsymmetricEncryptedSecret

Represent the secrets intended for encryption with asymmetric key pair.

ChapSettings

The Challenge-Handshake Authentication Protocol (CHAP) settings.

CloudApplianceSettings

The cloud appliance settings.

EncryptionAlgorithm

The algorithm used to encrypt "Value".

Kind

The Kind of the object. Currently only Series8000 is supported

RemoteManagementModeConfiguration

The remote management mode.

RemoteManagementSettings

The settings for remote management of a device.

RemoteManagementSettingsPatch

The settings for updating remote management mode of the device.

SecuritySettings

The security settings of a device.

SecuritySettingsPatch

Represents the patch request for the security settings of a device.

AsymmetricEncryptedSecret

Represent the secrets intended for encryption with asymmetric key pair.

Name Type Description
encryptionAlgorithm

The algorithm used to encrypt "Value".

encryptionCertThumbprint
  • string

Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null.

value
  • string

The value of the secret.

ChapSettings

The Challenge-Handshake Authentication Protocol (CHAP) settings.

Name Type Description
initiatorSecret

The CHAP initiator secret.

initiatorUser
  • string

The CHAP initiator user.

targetSecret

The target secret.

targetUser
  • string

The CHAP target user.

CloudApplianceSettings

The cloud appliance settings.

Name Type Description
channelIntegrityKey

The channel integrity key (encrypted with DAK).

serviceDataEncryptionKey

The service data encryption key (encrypted with DAK).

EncryptionAlgorithm

The algorithm used to encrypt "Value".

Name Type Description
AES256
  • string
None
  • string
RSAES_PKCS1_v_1_5
  • string

Kind

The Kind of the object. Currently only Series8000 is supported

Name Type Description
Series8000
  • string

RemoteManagementModeConfiguration

The remote management mode.

Name Type Description
Disabled
  • string
HttpsAndHttpEnabled
  • string
HttpsEnabled
  • string
Unknown
  • string

RemoteManagementSettings

The settings for remote management of a device.

Name Type Description
remoteManagementCertificate
  • string

The remote management certificates.

remoteManagementMode

The remote management mode.

RemoteManagementSettingsPatch

The settings for updating remote management mode of the device.

Name Type Description
remoteManagementMode

The remote management mode.

SecuritySettings

The security settings of a device.

Name Type Description
id
  • string

The path ID that uniquely identifies the object.

kind

The Kind of the object. Currently only Series8000 is supported

name
  • string

The name of the object.

properties.chapSettings

The Challenge-Handshake Authentication Protocol (CHAP) settings.

properties.remoteManagementSettings

The settings for remote management of a device.

type
  • string

The hierarchical type of the object.

SecuritySettingsPatch

Represents the patch request for the security settings of a device.

Name Type Description
properties.chapSettings

The device CHAP and reverse-CHAP settings.

properties.cloudApplianceSettings

The cloud appliance settings.

properties.deviceAdminPassword

The device administrator password.

properties.remoteManagementSettings

The remote management settings.

properties.snapshotPassword

The snapshot manager password.