Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update AFDX Secret APIs #7

Merged
merged 9 commits into from
Jun 24, 2021
Merged

Update AFDX Secret APIs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
76caff4
Correct input and output types of checkHostNameAvailability API
jessicl-ms Jun 3, 2021
a3c1497
Set CA and SAN to readonly
jessicl-ms Jun 4, 2021
8858728
Update ValidateSecretInput to include SecretVersion
jessicl-ms Jun 8, 2021
0bce9ef
Nit fix grammar
jessicl-ms Jun 9, 2021
c46f241
Remove redundant fields and mark certificate properties readonly
jessicl-ms Jun 21, 2021
99b8da4
Reoganize parameters and update descriptions
jessicl-ms Jun 22, 2021
22252b8
Update examples
jessicl-ms Jun 22, 2021
2a114f6
Fix typos and expand abbhreviations
jessicl-ms Jun 24, 2021
ee99558
Fix more typo
jessicl-ms Jun 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 50 additions & 58 deletions specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/afdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
"description": "Custom domain to be validated.",
"required": true,
"schema": {
"$ref": "./cdn.json#/definitions/ValidateCustomDomainInput"
"$ref": "./cdn.json#/definitions/CheckNameAvailabilityInput"
}
},
{
Expand All @@ -126,7 +126,7 @@
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput"
"$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput"
}
},
"default": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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
}
}
},
Expand All @@ -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",
Expand All @@ -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
}
}
},
Expand All @@ -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"
}
}
},
Expand Down Expand Up @@ -4561,20 +4561,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",
Expand All @@ -4594,7 +4597,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"
},
Expand Down Expand Up @@ -4628,28 +4631,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"
}
}
}
},
Expand Down
60 changes: 32 additions & 28 deletions ...ication/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down
19 changes: 11 additions & 8 deletions specification/cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
}
}
}
31 changes: 24 additions & 7 deletions .../cdn/resource-manager/Microsoft.Cdn/stable/2021-06-01/examples/Secrets_ListByProfile.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
]
}
Expand Down
Loading