Merge pull request #7 from jorinmejia/jessicl/swagger-updates-secret-…

…domain Update AFDX Secret APIs to 2021-06-01 version.
ChenglongLiu · Jun 24, 2021 · 7f33725 · 7f33725
2 parents 23c969d + ee99558
commit 7f33725
Show file tree

Hide file tree

Showing 5 changed files with 147 additions and 128 deletions.
diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/afdx.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/afdx.json
@@ -112,7 +112,7 @@
             "description": "Custom domain to be validated.",
             "required": true,
             "schema": {
-              "$ref": "./cdn.json#/definitions/ValidateCustomDomainInput"
+              "$ref": "./cdn.json#/definitions/CheckNameAvailabilityInput"
             }
           },
           {
@@ -126,7 +126,7 @@
           "200": {
             "description": "OK. The request has succeeded.",
             "schema": {
-              "$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput"
+              "$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput"
             }
           },
           "default": {
@@ -2837,7 +2837,7 @@
         "tags": [
           "SecurityPolicies"
         ],
-        "description": "Updates an existing Secret within a profile.",
+        "description": "Updates an existing security policy within a profile.",
         "operationId": "SecurityPolicies_Patch",
         "x-ms-examples": {
           "SecurityPolicies_Patch": {
@@ -2928,7 +2928,7 @@
           {
             "name": "securityPolicyName",
             "in": "path",
-            "description": "Name of the Secret under the profile.",
+            "description": "Name of the security policy under the profile.",
             "required": true,
             "type": "string"
           },
@@ -4007,17 +4007,18 @@
     "Certificate": {
       "description": "Certificate used for https",
       "properties": {
+        "type": {
+          "$ref": "#/definitions/SecretType"
+        },
         "subject": {
           "description": "Subject name in the certificate.",
-          "type": "string"
+          "type": "string",
+          "readOnly": true
         },
         "expirationDate": {
           "description": "Certificate expiration date.",
-          "type": "string"
-        },
-        "thumbprint": {
-          "description": "Certificate thumbprint.",
-          "type": "string"
+          "type": "string",
+          "readOnly": true
         }
       }
     },
@@ -4033,24 +4034,22 @@
       "description": "Customer Certificate used for https",
       "allOf": [
         {
-          "$ref": "#/definitions/Certificate"
+          "$ref": "#/definitions/Certificate",
         }
       ],
-      "required": [
-        "certificateUrl"
-      ],
       "properties": {
-        "version": {
+        "secretSource": {
+          "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}",
+          "$ref": "./cdn.json#/definitions/ResourceReference",
+        },
+        "secretVersion": {
           "description": "Certificate version.",
           "type": "string"
         },
         "certificateAuthority": {
           "description": "Certificate issuing authority.",
-          "type": "string"
-        },
-        "certificateUrl": {
-          "description": "Complete Url to the certificate",
-          "type": "string"
+          "type": "string",
+          "readOnly": true
         },
         "useLatestVersion": {
           "description": "Whether to use the latest version for the certificate",
@@ -4060,8 +4059,14 @@
           "description": "The list of SANs.",
           "type": "array",
           "items": {
-            "type": "string"
+            "type": "string",
+            "readOnly": true
           }
+        },
+        "thumbprint": {
+          "description": "Certificate thumbprint.",
+          "type": "string",
+          "readOnly": true
         }
       }
     },
@@ -4073,22 +4078,17 @@
         "secretType"
       ],
       "properties": {
+        "secretType": {
+          "description": "The secret type.",
+          "$ref": "#/definitions/SecretType"
+        },
         "secretSource": {
-          "description": "The secret source.",
+          "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}",
           "$ref": "./cdn.json#/definitions/ResourceReference"
         },
-        "secretType": {
-          "description": "The secret type.",
-          "enum": [
-            "UrlSigningKey",
-            "ManagedCertificate",
-            "CustomerCertificate"
-          ],
-          "type": "string",
-          "x-ms-enum": {
-            "name": "ValidateSecretType",
-            "modelAsString": true
-          }
+        "secretVersion": {
+          "description": "Secret version, if customer is using a specific version.",
+          "type": "string"
         }
       }
     },
@@ -4554,20 +4554,23 @@
       "type": "object",
       "properties": {
         "type": {
-          "description": "The type of the Secret to create.",
-          "enum": [
-            "UrlSigningKey",
-            "CustomerCertificate",
-            "ManagedCertificate"
-          ],
-          "type": "string",
-          "x-ms-enum": {
-            "name": "SecretType",
-            "modelAsString": true
-          }
+          "$ref": "#/definitions/SecretType"
         }
       }
     },
+    "SecretType": {
+      "description": "The type of the secret resource.",
+      "enum": [
+        "UrlSigningKey",
+        "CustomerCertificate",
+        "ManagedCertificate"
+      ],
+      "type": "string",
+      "x-ms-enum": {
+        "name": "SecretType",
+        "modelAsString": true
+      }
+    },
     "UrlSigningKeyParameters": {
       "description": "Url signing key parameters",
       "x-ms-discriminator-value": "UrlSigningKey",
@@ -4587,7 +4590,7 @@
           "type": "string"
         },
         "secretSource": {
-          "description": "Resource reference to the KV secret",
+          "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}",
           "type": "object",
           "$ref": "./cdn.json#/definitions/ResourceReference"
         },
@@ -4621,28 +4624,17 @@
       ],
       "properties": {
         "secretSource": {
-          "description": "Resource reference to the KV secret",
+          "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}",
           "type": "object",
           "$ref": "./cdn.json#/definitions/ResourceReference"
         },
         "secretVersion": {
           "description": "Version of the secret to be used",
           "type": "string"
         },
-        "certificateAuthority": {
-          "description": "Certificate issuing authority.",
-          "type": "string"
-        },
         "useLatestVersion": {
           "description": "Whether to use the latest version for the certificate",
           "type": "boolean"
-        },
-        "subjectAlternativeNames": {
-          "description": "The list of SANs.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
         }
       }
     },

diff --git a/...ication/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Create.json b/...ication/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Create.json
@@ -9,14 +9,9 @@
       "properties": {
         "parameters": {
           "type": "CustomerCertificate",
-          "subjectAlternativeNames": [
-            "foo.contoso.com",
-            "www3.foo.contoso.com"
-          ],
-          "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-          "certificateAuthority": "Symantec",
+          "secretVersion": "abcdef1234578900abcdef1234567890",
           "secretSource": {
-            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
+            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename"
           },
           "useLatestVersion": false
         }
@@ -32,16 +27,19 @@
         "properties": {
           "parameters": {
             "type": "CustomerCertificate",
+            "subject": "*.contoso.com",
+            "certificateAuthority": "Symantec",
+            "expirationDate": "2025-01-01T00:00:00-00:00",
+            "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
+            "secretSource": {
+              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
+          },
+          "secretVersion": "abcdef1234578900abcdef1234567890",
+          "useLatestVersion": true,
             "subjectAlternativeNames": [
               "foo.contoso.com",
               "www3.foo.contoso.com"
-            ],
-            "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-            "certificateAuthority": "Symantec",
-            "secretSource": {
-              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
-            },
-            "useLatestVersion": false
+            ]
           },
           "provisioningState": "Succeeded",
           "deploymentStatus": "NotStarted"
@@ -56,16 +54,19 @@
         "properties": {
           "parameters": {
             "type": "CustomerCertificate",
+            "subject": "*.contoso.com",
+            "certificateAuthority": "Symantec",
+            "expirationDate": "2025-01-01T00:00:00-00:00",
+            "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
+            "secretSource": {
+              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
+          },
+          "secretVersion": "abcdef1234578900abcdef1234567890",
+          "useLatestVersion": true,
             "subjectAlternativeNames": [
               "foo.contoso.com",
               "www3.foo.contoso.com"
-            ],
-            "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-            "certificateAuthority": "Symantec",
-            "secretSource": {
-              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
-            },
-            "useLatestVersion": false
+            ]
           },
           "provisioningState": "Succeeded",
           "deploymentStatus": "NotStarted"
@@ -80,16 +81,19 @@
         "properties": {
           "parameters": {
             "type": "CustomerCertificate",
+            "subject": "*.contoso.com",
+            "certificateAuthority": "Symantec",
+            "expirationDate": "2025-01-01T00:00:00-00:00",
+            "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
+            "secretSource": {
+              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
+          },
+          "secretVersion": "abcdef1234578900abcdef1234567890",
+          "useLatestVersion": true,
             "subjectAlternativeNames": [
               "foo.contoso.com",
               "www3.foo.contoso.com"
-            ],
-            "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-            "certificateAuthority": "Symantec",
-            "secretSource": {
-              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
-            },
-            "useLatestVersion": false
+            ]
           },
           "provisioningState": "Succeeded",
           "deploymentStatus": "NotStarted"

diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Get.json
@@ -15,21 +15,24 @@
         "properties": {
           "parameters": {
             "type": "CustomerCertificate",
+            "subject": "*.contoso.com",
+            "certificateAuthority": "Symantec",
+            "expirationDate": "2025-01-01T00:00:00-00:00",
+            "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
+            "secretSource": {
+              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
+          },
+          "secretVersion": "abcdef1234578900abcdef1234567890",
+          "useLatestVersion": true,
             "subjectAlternativeNames": [
               "foo.contoso.com",
               "www3.foo.contoso.com"
-            ],
-            "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-            "certificateAuthority": "Symantec",
-            "secretSource": {
-              "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
-            },
-            "useLatestVersion": false
+            ]
           },
           "provisioningState": "Succeeded",
           "deploymentStatus": "NotStarted"
         }
       }
     }
   }
-}
+}
diff --git a/.../cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_ListByProfile.json b/.../cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_ListByProfile.json
@@ -16,20 +16,37 @@
             "properties": {
               "parameters": {
                 "type": "CustomerCertificate",
+                "subject": "*.contoso.com",
+                "certificateAuthority": "Symantec",
+                "expirationDate": "2025-01-01T00:00:00-00:00",
+                "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
+                "secretSource": {
+                  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
+              },
+              "secretVersion": "abcdef1234578900abcdef1234567890",
+              "useLatestVersion": true,
                 "subjectAlternativeNames": [
                   "foo.contoso.com",
                   "www3.foo.contoso.com"
-                ],
-                "secretVersion": "67c452f83c804aed80aa3a21e523c226",
-                "certificateAuthority": "Symantec",
-                "secretSource": {
-                  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
-                },
-                "useLatestVersion": false
+                ]
               },
               "provisioningState": "Succeeded",
               "deploymentStatus": "NotStarted"
             }
+          },
+          {
+            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name",
+            "type": "Microsoft.Cdn/profiles/secrets",
+            "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz",
+            "properties": {
+                "parameters": {
+                    "type": "ManagedCertificate",
+                    "subject": "bar.contoso.com",
+                    "expirationDate": "2025-01-01T00:00:00-00:00"
+                },
+                "provisioningState": "Succeeded",
+                "deploymentStatus": "InProgress"
+            }
           }
         ]
       }