Custom Domains - Get

Gets an existing custom domain within an endpoint.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}?api-version=2017-10-12

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Azure Subscription ID.

resourceGroupName
path True
  • string

Name of the Resource group within the Azure subscription.

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

profileName
path True
  • string

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

endpointName
path True
  • string

Name of the endpoint under the profile which is unique globally.

customDomainName
path True
  • string

Name of the custom domain within an endpoint.

api-version
query True
  • string

Version of the API to be used with the client request. Current version is 2017-04-02.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

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

CustomDomains_Get

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customDomains/www-someDomain-net?api-version=2017-10-12

Sample Response

{
  "name": "www-someDomain-net",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
  "type": "Microsoft.Cdn/profiles/endpoints/customdomains",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Active",
    "hostName": "www.someDomain.net",
    "customHttpsProvisioningState": "Disabled",
    "customHttpsProvisioningSubstate": "None",
    "validationData": null
  }
}

Definitions

CustomDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

CustomDomainResourceState

Resource status of the custom domain.

CustomHttpsProvisioningState

Provisioning status of Custom Https of the custom domain.

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

ErrorResponse

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

CustomDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.customHttpsProvisioningState

Provisioning status of Custom Https of the custom domain.

properties.customHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

properties.hostName
  • string

The host name of the custom domain. Must be a domain name.

properties.provisioningState
  • string

Provisioning status of the custom domain.

properties.resourceState

Resource status of the custom domain.

properties.validationData
  • string

Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

type
  • string

Resource type.

CustomDomainResourceState

Resource status of the custom domain.

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string

CustomHttpsProvisioningState

Provisioning status of Custom Https of the custom domain.

Name Type Description
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string
Failed
  • string

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

Name Type Description
CertificateDeleted
  • string
CertificateDeployed
  • string
DeletingCertificate
  • string
DeployingCertificate
  • string
DomainControlValidationRequestApproved
  • string
DomainControlValidationRequestRejected
  • string
DomainControlValidationRequestTimedOut
  • string
IssuingCertificate
  • string
PendingDomainControlValidationREquestApproval
  • string
SubmittingDomainControlValidationRequest
  • 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.