proper secrets definition for datastores

a-santamaria · Apr 13, 2021 · 28509f7 · 28509f7
1 parent a1cba95
commit 28509f7
Show file tree

Hide file tree

Showing 3 changed files with 134 additions and 49 deletions.
diff --git a/...MachineLearningServices/preview/2021-03-01-preview/examples/Datastore/createOrUpdate.json b/...MachineLearningServices/preview/2021-03-01-preview/examples/Datastore/createOrUpdate.json
@@ -10,7 +10,11 @@
         "contents": {
           "contentsType": "AzureBlob",
           "credentials": {
-            "credentialsType": "AccountKey"
+            "credentialsType": "AccountKey",
+            "secrets": {
+              "secretsType": "AccountKey",
+              "key": "string"
+            }
           },
           "accountName": "string",
           "containerName": "string",

diff --git a/...ft.MachineLearningServices/preview/2021-03-01-preview/examples/Datastore/listSecrets.json b/...ft.MachineLearningServices/preview/2021-03-01-preview/examples/Datastore/listSecrets.json
@@ -9,7 +9,8 @@
   "responses": {
     "200": {
       "body": {
-        "credentialsType": "AccountKey"
+        "secretsType": "AccountKey",
+        "key": "string"
       }
     }
   }

diff --git a/...es/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json b/...es/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json
@@ -1707,7 +1707,7 @@
           "200": {
             "description": "Success",
             "schema": {
-              "$ref": "#/definitions/DatastoreCredentials"
+              "$ref": "#/definitions/DatastoreSecrets"
             }
           }
         },
@@ -5726,38 +5726,156 @@
       },
       "additionalProperties": false
     },
-    "DatastoreCredentials": {
+    "SecretsType": {
+      "enum": [
+        "AccountKey",
+        "Certificate",
+        "None",
+        "Sas",
+        "ServicePrincipal",
+        "SqlAdmin"
+      ],
+      "type": "string",
+      "x-ms-enum": {
+        "name": "SecretsType",
+        "modelAsString": true
+      },
+      "additionalProperties": false
+    },
+    "DatastoreSecrets": {
       "required": [
-        "credentialsType"
+        "secretsType"
       ],
       "type": "object",
       "properties": {
-        "credentialsType": {
+        "secretsType": {
           "description": "Credential type used to authentication with storage.",
-          "$ref": "#/definitions/CredentialsType"
+          "$ref": "#/definitions/SecretsType"
         }
       },
-      "discriminator": "credentialsType",
+      "discriminator": "secretsType",
       "additionalProperties": false
     },
-    "AccountKeyDatastoreCredentials": {
+    "AccountKeyDatastoreSecrets": {
       "type": "object",
       "allOf": [
         {
-          "$ref": "#/definitions/DatastoreCredentials"
+          "$ref": "#/definitions/DatastoreSecrets"
         }
       ],
       "properties": {
         "key": {
           "description": "Storage account key.",
-          "type": "string",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "AccountKey",
+      "additionalProperties": false
+    },
+    "CertificateDatastoreSecrets": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreSecrets"
+        }
+      ],
+      "properties": {
+        "certificate": {
+          "description": "Service principal certificate.",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "Certificate",
+      "additionalProperties": false
+    },
+    "NoneDatastoreSecrets": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreSecrets"
+        }
+      ],
+      "x-ms-discriminator-value": "None",
+      "additionalProperties": false
+    },
+    "SasDatastoreSecrets": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreSecrets"
+        }
+      ],
+      "properties": {
+        "sasToken": {
+          "description": "Storage container SAS token.",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "Sas",
+      "additionalProperties": false
+    },
+    "ServicePrincipalDatastoreSecrets": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreSecrets"
+        }
+      ],
+      "properties": {
+        "clientSecret": {
+          "description": "Service principal secret.",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "ServicePrincipal",
+      "additionalProperties": false
+    },
+    "SqlAdminDatastoreSecrets": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreSecrets"
+        }
+      ],
+      "properties": {
+        "password": {
+          "description": "SQL database password.",
+          "type": "string"
+        }
+      },
+      "x-ms-discriminator-value": "SqlAdmin",
+      "additionalProperties": false
+    },
+    "DatastoreCredentials": {
+      "required": [
+        "credentialsType"
+      ],
+      "type": "object",
+      "properties": {
+        "credentialsType": {
+          "description": "Credential type used to authentication with storage.",
+          "$ref": "#/definitions/CredentialsType"
+        },
+        "secrets": {
+          "description": "Credential secrets",
+          "$ref": "#/definitions/DatastoreSecrets",
           "x-ms-mutability": [
             "create",
             "update"
           ],
           "x-ms-secret": true
         }
       },
+      "discriminator": "credentialsType",
+      "additionalProperties": false
+    },
+    "AccountKeyDatastoreCredentials": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/DatastoreCredentials"
+        }
+      ],
       "x-ms-discriminator-value": "AccountKey",
       "additionalProperties": false
     },
@@ -5792,15 +5910,6 @@
           "description": "Service principal client ID.",
           "type": "string"
         },
-        "certificate": {
-          "description": "Service principal certificate.",
-          "type": "string",
-          "x-ms-mutability": [
-            "create",
-            "update"
-          ],
-          "x-ms-secret": true
-        },
         "thumbprint": {
           "description": "Thumbprint of the certificate used for authentication.",
           "pattern": "[a-zA-Z0-9_]",
@@ -5827,17 +5936,6 @@
           "$ref": "#/definitions/DatastoreCredentials"
         }
       ],
-      "properties": {
-        "sasToken": {
-          "description": "Storage container SAS token.",
-          "type": "string",
-          "x-ms-mutability": [
-            "create",
-            "update"
-          ],
-          "x-ms-secret": true
-        }
-      },
       "x-ms-discriminator-value": "Sas",
       "additionalProperties": false
     },
@@ -5870,15 +5968,6 @@
           "format": "uuid",
           "description": "Service principal client ID.",
           "type": "string"
-        },
-        "clientSecret": {
-          "description": "Service principal secret.",
-          "type": "string",
-          "x-ms-mutability": [
-            "create",
-            "update"
-          ],
-          "x-ms-secret": true
         }
       },
       "x-ms-discriminator-value": "ServicePrincipal",
@@ -5899,15 +5988,6 @@
           "description": "SQL database user name.",
           "pattern": "[a-zA-Z0-9_]",
           "type": "string"
-        },
-        "password": {
-          "description": "SQL database password.",
-          "type": "string",
-          "x-ms-mutability": [
-            "create",
-            "update"
-          ],
-          "x-ms-secret": true
         }
       },
       "x-ms-discriminator-value": "SqlAdmin",