Origins - List By Endpoint

Lists all of the existing origins within an endpoint.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins?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.

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

Origins_ListByEndpoint

Sample Request

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

Sample Response

{
  "value": [
    {
      "name": "www-someDomain-net",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net",
      "type": "Microsoft.Cdn/profiles/endpoints/origins",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceState": "Active",
        "hostName": "www.someDomain.net",
        "httpPort": null,
        "httpsPort": null
      }
    }
  ]
}

Definitions

ErrorResponse

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

Origin

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

OriginListResult

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

OriginResourceState

Resource status of the origin.

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.

Origin

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Name Type Description
id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.hostName
  • string

The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.

properties.httpPort
  • integer

The value of the HTTP port. Must be between 1 and 65535.

properties.httpsPort
  • integer

The value of the https port. Must be between 1 and 65535.

properties.provisioningState
  • string

Provisioning status of the origin.

properties.resourceState

Resource status of the origin.

tags
  • object

Resource tags.

type
  • string

Resource type.

OriginListResult

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

Name Type Description
nextLink
  • string

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

value

List of CDN origins within an endpoint

OriginResourceState

Resource status of the origin.

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