Origins - Create

Service:

CDN

API Version:

2023-05-01

Creates a new origin within the specified endpoint.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Name of the endpoint under the profile which is unique globally.
originName	path	True	string	Name of the origin that is unique within the endpoint.
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 2023-05-01.

Request Body

Name	Required	Type	Description
properties.hostName	True	string	The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
properties.enabled		boolean	Origin is enabled for load balancing or not
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.originHostHeader		string	The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
properties.priority		integer	Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
properties.privateLinkAlias		string	The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
properties.privateLinkApprovalMessage		string	A custom message to be included in the approval request to connect to the Private Link.
properties.privateLinkLocation		string	The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
properties.privateLinkResourceId		string	The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
properties.weight		integer	Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

Responses

Name	Type	Description
200 OK	Origin	OK. The request has succeeded.
201 Created	Origin	Created. The request has been fulfilled and a new origin has been created.
202 Accepted	Origin	Accepted and the operation will complete asynchronously. Headers location: string
Other Status Codes	ErrorResponse	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_Create

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net?api-version=2023-05-01

{
  "properties": {
    "hostName": "www.someDomain.net",
    "httpPort": 80,
    "httpsPort": 443,
    "originHostHeader": "www.someDomain.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
    "privateLinkLocation": "eastus",
    "privateLinkApprovalMessage": "Please approve the connection request for this Private Link"
  }
}

Java

import com.azure.resourcemanager.cdn.fluent.models.OriginInner;

/** Samples for Origins Create. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Create.json
     */
    /**
     * Sample code: Origins_Create.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void originsCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getOrigins().create("RG", "profile1", "endpoint1",
            "www-someDomain-net",
            new OriginInner().withHostname("www.someDomain.net").withHttpPort(80).withHttpsPort(443)
                .withOriginHostHeader("www.someDomain.net").withPriority(1).withWeight(50).withEnabled(true)
                .withPrivateLinkResourceId(
                    "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1")
                .withPrivateLinkLocation("eastus").withPrivateLinkApprovalMessage(
                    "Please approve the connection request for this Private Link"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python origins_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.origins.begin_create(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        origin_name="www-someDomain-net",
        origin={
            "properties": {
                "enabled": True,
                "hostName": "www.someDomain.net",
                "httpPort": 80,
                "httpsPort": 443,
                "originHostHeader": "www.someDomain.net",
                "priority": 1,
                "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
                "privateLinkLocation": "eastus",
                "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
                "weight": 50,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Create.json
func ExampleOriginsClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewOriginsClient().BeginCreate(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", armcdn.Origin{
		Properties: &armcdn.OriginProperties{
			Enabled:                    to.Ptr(true),
			HostName:                   to.Ptr("www.someDomain.net"),
			HTTPPort:                   to.Ptr[int32](80),
			HTTPSPort:                  to.Ptr[int32](443),
			OriginHostHeader:           to.Ptr("www.someDomain.net"),
			Priority:                   to.Ptr[int32](1),
			PrivateLinkApprovalMessage: to.Ptr("Please approve the connection request for this Private Link"),
			PrivateLinkLocation:        to.Ptr("eastus"),
			PrivateLinkResourceID:      to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1"),
			Weight:                     to.Ptr[int32](50),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Origin = armcdn.Origin{
	// 	Name: to.Ptr("www-someDomain-net"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/origins"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net"),
	// 	Properties: &armcdn.OriginProperties{
	// 		Enabled: to.Ptr(true),
	// 		HostName: to.Ptr("www.someDomain.net"),
	// 		HTTPPort: to.Ptr[int32](80),
	// 		HTTPSPort: to.Ptr[int32](443),
	// 		OriginHostHeader: to.Ptr("www.someDomain.net"),
	// 		Priority: to.Ptr[int32](1),
	// 		PrivateLinkApprovalMessage: to.Ptr("Please approve the connection request for this Private Link"),
	// 		PrivateLinkLocation: to.Ptr("eastus"),
	// 		PrivateLinkResourceID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1"),
	// 		Weight: to.Ptr[int32](50),
	// 		PrivateEndpointStatus: to.Ptr(armcdn.PrivateEndpointStatusPending),
	// 		ProvisioningState: to.Ptr(armcdn.OriginProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.OriginResourceStateActive),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a new origin within the specified endpoint.
 *
 * @summary Creates a new origin within the specified endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Create.json
 */
async function originsCreate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const originName = "www-someDomain-net";
  const origin = {
    enabled: true,
    hostName: "www.someDomain.net",
    httpPort: 80,
    httpsPort: 443,
    originHostHeader: "www.someDomain.net",
    priority: 1,
    privateLinkApprovalMessage: "Please approve the connection request for this Private Link",
    privateLinkLocation: "eastus",
    privateLinkResourceId:
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
    weight: 50,
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.origins.beginCreateAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    originName,
    origin
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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": 80,
    "httpsPort": 443,
    "originHostHeader": "www.someDomain.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateEndpointStatus": "Pending",
    "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
    "privateLinkLocation": "eastus",
    "privateLinkApprovalMessage": "Please approve the connection request for this Private Link"
  }
}

Status code:

201

{
  "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": 80,
    "httpsPort": 443,
    "originHostHeader": "www.someDomain.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateEndpointStatus": "Pending",
    "privateLinkApprovalMessage": "",
    "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
    "privateLinkLocation": "eastus"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2023-05-01

Response Body

{
  "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": 80,
    "httpsPort": 443,
    "originHostHeader": "www.someDomain.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateEndpointStatus": "Pending",
    "privateLinkApprovalMessage": "",
    "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
    "privateLinkLocation": "eastus"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityType	The type of identity that creates/modifies resources
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.
OriginProvisioningState	Provisioning status of the origin.
OriginResourceState	Resource status of the origin.
PrivateEndpointStatus	The approval status for the connection to the Private Link
SystemData	Read only system data

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

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.
name	string	Resource name.
properties.enabled	boolean	Origin is enabled for load balancing or not
properties.hostName	string	The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
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.originHostHeader	string	The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
properties.priority	integer	Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
properties.privateEndpointStatus	PrivateEndpointStatus	The approval status for the connection to the Private Link
properties.privateLinkAlias	string	The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
properties.privateLinkApprovalMessage	string	A custom message to be included in the approval request to connect to the Private Link.
properties.privateLinkLocation	string	The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
properties.privateLinkResourceId	string	The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
properties.provisioningState	OriginProvisioningState	Provisioning status of the origin.
properties.resourceState	OriginResourceState	Resource status of the origin.
properties.weight	integer	Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
systemData	SystemData	Read only system data
type	string	Resource type.

OriginProvisioningState

Provisioning status of the origin.

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

OriginResourceState

Resource status of the origin.

Name	Type	Description
Active	string
Creating	string
Deleting	string

PrivateEndpointStatus

The approval status for the connection to the Private Link

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

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	IdentityType	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	IdentityType	The type of identity that last modified the resource