Update Microsoft.Sql ARM API with "format: arm-id" where appropriate …

…and x-ms-secret where appropriate (#22677) * SQL ARM IDs * Secrets * Examples fix * Fix examples
Azure · Mar 15, 2023 · c72a972 · c72a972
1 parent 4ede5fd
commit c72a972
Show file tree

Hide file tree

Showing 27 changed files with 133 additions and 28 deletions.
diff --git a/...ion/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseExtensions.json b/...ion/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseExtensions.json
@@ -399,13 +399,15 @@
         "storageAccountResourceId": {
           "description": "The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "sqlServerResourceId": {
           "description": "The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]

diff --git a/...ource-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseSecurityAlertPolicies.json b/...ource-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseSecurityAlertPolicies.json
@@ -298,6 +298,7 @@
         },
         "storageAccountAccessKey": {
           "description": "Specifies the identifier key of the Threat Detection audit storage account.",
+          "x-ms-secret": true,
           "type": "string"
         },
         "retentionDays": {

diff --git a/...ce-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseVulnerabilityAssessments.json b/...ce-manager/Microsoft.Sql/preview/2022-08-01-preview/DatabaseVulnerabilityAssessments.json
@@ -311,6 +311,7 @@
         "storageContainerSasKey": {
           "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall",
           "type": "string",
+          "x-ms-secret": true,
           "x-ms-mutability": [
             "create",
             "update"
@@ -319,6 +320,7 @@
         "storageAccountAccessKey": {
           "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall",
           "type": "string",
+          "x-ms-secret": true,
           "x-ms-mutability": [
             "create",
             "update"

diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/Databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/Databases.json
@@ -1029,11 +1029,20 @@
         },
         "elasticPoolId": {
           "description": "The resource identifier of the elastic pool containing this database.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.Sql/servers/elasticPools"
+              }
+            ]
+          }
         },
         "sourceDatabaseId": {
           "description": "The resource identifier of the source database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1124,27 +1133,38 @@
         "recoveryServicesRecoveryPointId": {
           "description": "The resource identifier of the recovery point associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "longTermRetentionBackupResourceId": {
           "description": "The resource identifier of the long term retention backup associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.Sql/locations/longTermRetentionBackups"
+              }
+            ]
+          },
           "x-ms-mutability": [
             "create"
           ]
         },
         "recoverableDatabaseId": {
           "description": "The resource identifier of the recoverable database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "restorableDroppedDatabaseId": {
           "description": "The resource identifier of the restorable dropped database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1327,6 +1347,7 @@
         "sourceResourceId": {
           "description": "The resource identifier of the source associated with the create operation of this database.\r\n\r\nThis property is only supported for DataWarehouse edition and allows to restore across subscriptions.\r\n\r\nWhen sourceResourceId is specified, sourceDatabaseId, recoverableDatabaseId, restorableDroppedDatabaseId and sourceDatabaseDeletionDate must not be specified and CreateMode must be PointInTimeRestore, Restore or Recover.\r\n\r\nWhen createMode is PointInTimeRestore, sourceResourceId must be the resource ID of the existing database or existing sql pool, and restorePointInTime must be specified.\r\n\r\nWhen createMode is Restore, sourceResourceId must be the resource ID of restorable dropped database or restorable dropped sql pool.\r\n\r\nWhen createMode is Recover, sourceResourceId must be the resource ID of recoverable database or recoverable sql pool.\r\n\r\nWhen source subscription belongs to a different tenant than target subscription, “x-ms-authorization-auxiliary” header must contain authentication token for the source tenant. For more details about “x-ms-authorization-auxiliary” header see https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant ",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1439,11 +1460,20 @@
         },
         "elasticPoolId": {
           "description": "The resource identifier of the elastic pool containing this database.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.Sql/servers/elasticPools"
+              }
+            ]
+          }
         },
         "sourceDatabaseId": {
           "description": "The resource identifier of the source database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1534,13 +1564,22 @@
         "recoveryServicesRecoveryPointId": {
           "description": "The resource identifier of the recovery point associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "longTermRetentionBackupResourceId": {
           "description": "The resource identifier of the long term retention backup associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.Sql/locations/longTermRetentionBackups"
+              }
+            ]
+          },
           "x-ms-mutability": [
             "create"
           ]
@@ -1555,6 +1594,7 @@
         "restorableDroppedDatabaseId": {
           "description": "The resource identifier of the restorable dropped database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1987,13 +2027,15 @@
         "storageAccountResourceId": {
           "description": "The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "sqlServerResourceId": {
           "description": "The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]

diff --git a/...ication/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/FailoverGroups.json b/...ication/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/FailoverGroups.json
@@ -498,7 +498,15 @@
           "description": "List of databases in the failover group.",
           "type": "array",
           "items": {
-            "type": "string"
+            "type": "string",
+            "format": "arm-id",
+            "x-ms-arm-id-details": {
+              "allowedResources": [
+                {
+                  "type": "Microsoft.Sql/servers/databases"
+                }
+              ]
+            }
           }
         }
       }
@@ -595,7 +603,8 @@
       "properties": {
         "id": {
           "description": "Resource identifier of the partner server.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id"
         },
         "location": {
           "description": "Geo location of the partner server.",

diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/JobAgents.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/JobAgents.json
@@ -326,6 +326,7 @@
         "databaseId": {
           "description": "Resource ID of the database to store job metadata in.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "read",
             "create"

diff --git a/...ation/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json b/...ation/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/ManagedDatabases.json
@@ -598,7 +598,8 @@
       "properties": {
         "destinationManagedDatabaseId": {
           "description": "The destination managed database ID",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id"
         }
       }
     },
@@ -706,27 +707,31 @@
         "sourceDatabaseId": {
           "description": "The resource identifier of the source database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "crossSubscriptionSourceDatabaseId": {
           "description": "The resource identifier of the cross-subscription source database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "restorableDroppedDatabaseId": {
           "description": "The restorable dropped database resource id to restore when creating this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "crossSubscriptionRestorableDroppedDatabaseId": {
           "description": "The restorable cross-subscription dropped database resource id to restore when creating this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -753,13 +758,15 @@
         "recoverableDatabaseId": {
           "description": "The resource identifier of the recoverable database associated with create operation of this database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "longTermRetentionBackupResourceId": {
           "description": "The name of the Long Term Retention backup to be used for restore of this managed database.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -804,7 +811,8 @@
       "properties": {
         "destinationManagedDatabaseId": {
           "description": "The destination managed database ID",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id"
         },
         "operationMode": {
           "description": "The move operation mode.",

diff --git a/...ation/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json b/...ation/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/ManagedInstances.json
@@ -943,7 +943,15 @@
         },
         "subnetId": {
           "description": "Subnet resource ID for the managed instance.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.Network/virtualNetworks/subnets"
+              }
+            ]
+          }
         },
         "state": {
           "description": "The state of the managed instance.",
@@ -988,6 +996,7 @@
         "dnsZonePartner": {
           "description": "The resource id of another managed instance whose DNS zone this managed instance will share after creation.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -999,6 +1008,7 @@
         "sourceManagedInstanceId": {
           "description": "The resource identifier of the source managed instance associated with create operation of this instance.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1091,7 +1101,15 @@
         },
         "primaryUserAssignedIdentityId": {
           "description": "The resource id of a user assigned identity to be used by default.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
+              }
+            ]
+          }
         },
         "keyId": {
           "description": "A CMK URI of the key to use for encryption.",

diff --git a/...esource-manager/Microsoft.Sql/preview/2022-08-01-preview/ServerSecurityAlertPolicies.json b/...esource-manager/Microsoft.Sql/preview/2022-08-01-preview/ServerSecurityAlertPolicies.json
@@ -242,6 +242,7 @@
         },
         "storageAccountAccessKey": {
           "description": "Specifies the identifier key of the Threat Detection audit storage account.",
+          "x-ms-secret": true,
           "type": "string"
         },
         "retentionDays": {

diff --git a/...urce-manager/Microsoft.Sql/preview/2022-08-01-preview/ServerVulnerabilityAssessments.json b/...urce-manager/Microsoft.Sql/preview/2022-08-01-preview/ServerVulnerabilityAssessments.json
@@ -298,6 +298,7 @@
         "storageContainerSasKey": {
           "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall",
           "type": "string",
+          "x-ms-secret": true,
           "x-ms-mutability": [
             "create",
             "update"
@@ -306,6 +307,7 @@
         "storageAccountAccessKey": {
           "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required. Applies only if the storage account is not behind a Vnet or a firewall",
           "type": "string",
+          "x-ms-secret": true,
           "x-ms-mutability": [
             "create",
             "update"

diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/Servers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/Servers.json
@@ -697,13 +697,15 @@
         "storageAccountResourceId": {
           "description": "The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
         },
         "sqlServerResourceId": {
           "description": "The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.",
           "type": "string",
+          "format": "arm-id",
           "x-ms-mutability": [
             "create"
           ]
@@ -1057,7 +1059,15 @@
         },
         "primaryUserAssignedIdentityId": {
           "description": "The resource id of a user assigned identity to be used by default.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id",
+          "x-ms-arm-id-details": {
+            "allowedResources": [
+              {
+                "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
+              }
+            ]
+          }
         },
         "federatedClientId": {
           "format": "uuid",

diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/SyncAgents.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2022-08-01-preview/SyncAgents.json
@@ -475,7 +475,8 @@
         },
         "syncDatabaseId": {
           "description": "ARM resource id of the sync database in the sync agent.",
-          "type": "string"
+          "type": "string",
+          "format": "arm-id"
         },
         "lastAliveTime": {
           "format": "date-time",