Secrets - List By Profile

Lists existing AzureFrontDoor secrets.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets?api-version=2020-09-01

URI Parameters

Name In Required Type Description
profileName
path True
  • string

Name of the CDN profile which is unique within the resource group.

resourceGroupName
path True
  • string

Name of the Resource group within the Azure subscription.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Azure Subscription ID.

api-version
query True
  • string

Version of the API to be used with the client request. Current version is 2020-09-01.

Responses

Name Type Description
200 OK

OK

Other Status Codes

CDN error response describing why the operation failed.

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

Secrets_ListByProfile

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets?api-version=2020-09-01

Sample Response

{
  "value": [
    {
      "name": "secret1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
      "type": "Microsoft.Cdn/profiles/secrets",
      "properties": {
        "parameters": {
          "type": "CustomerCertificate",
          "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"
      }
    }
  ]
}

Definitions

AfdErrorResponse

Error response

AfdProvisioningState

Provisioning status

CustomerCertificateParameters

Customer Certificate used for https

DeploymentStatus
ErrorResponse

Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

IdentityType

The type of identity that creates/modifies resources

ManagedCertificateParameters

Managed Certificate used for https

ResourceReference

Reference to another resource.

Secret

Friendly Secret name mapping to the any Secret or secret related information.

SecretListResult

Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.

SystemData

Read only system data

UrlSigningKeyParameters

Url signing key parameters

AfdErrorResponse

Error response

Name Type Description
error

The error object.

AfdProvisioningState

Provisioning status

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

CustomerCertificateParameters

Customer Certificate used for https

Name Type Description
certificateAuthority
  • string

Certificate issuing authority.

secretSource

Resource reference to the KV secret

secretVersion
  • string

Version of the secret to be used

subjectAlternativeNames
  • string[]

The list of SANs.

type string:
  • CustomerCertificate

The type of the Secret to create.

useLatestVersion
  • boolean

Whether to use the latest version for the certificate

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

ErrorResponse

Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

IdentityType

The type of identity that creates/modifies resources

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

ManagedCertificateParameters

Managed Certificate used for https

Name Type Description
type string:
  • ManagedCertificate

The type of the Secret to create.

ResourceReference

Reference to another resource.

Name Type Description
id
  • string

Resource ID.

Secret

Friendly Secret name mapping to the any Secret or secret related information.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.deploymentStatus
properties.parameters SecretParameters:

object which contains secret parameters

properties.provisioningState

Provisioning status

systemData

Read only system data

type
  • string

Resource type.

SecretListResult

Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.

Name Type Description
nextLink
  • string

URL to get the next set of Secret objects if there are any.

value

List of AzureFrontDoor secrets within a profile.

SystemData

Read only system data

Name Type Description
createdAt
  • string

The timestamp of resource creation (UTC)

createdBy
  • string

An identifier for the identity that created the resource

createdByType

The type of identity that created the resource

lastModifiedAt
  • string

The timestamp of resource last modification (UTC)

lastModifiedBy
  • string

An identifier for the identity that last modified the resource

lastModifiedByType

The type of identity that last modified the resource

UrlSigningKeyParameters

Url signing key parameters

Name Type Description
keyId
  • string

Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.

secretSource

Resource reference to the KV secret

secretVersion
  • string

Version of the secret to be used

type string:
  • UrlSigningKey

The type of the Secret to create.