Origins - Create

Referenz

Service:: CDN

API Version:: 2024-02-01

Erstellt einen neuen Ursprung innerhalb des angegebenen Endpunkts.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpointName	path	True	string	Name des Endpunkts unter dem Profil, der global eindeutig ist.
originName	path	True	string	Name des Ursprungs, der innerhalb des Endpunkts eindeutig ist.
profileName	path	True	string	Name des CDN-Profils, das innerhalb der Ressourcengruppe eindeutig ist.
resourceGroupName	path	True	string	Name der Ressourcengruppe innerhalb des Azure-Abonnements. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-02-01.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.hostName	True	string	Die Adresse des Ursprungs. Domänennamen, IPv4-Adressen und IPv6-Adressen werden unterstützt. Dies sollte für alle Ursprünge in einem Endpunkt eindeutig sein.
properties.enabled		boolean	Der Ursprung ist für den Lastenausgleich aktiviert oder nicht.
properties.httpPort		integer	Der Wert des HTTP-Ports. Der Wert muss zwischen 1 und 65535 liegen.
properties.httpsPort		integer	Der Wert des HTTPS-Ports. Der Wert muss zwischen 1 und 65535 liegen.
properties.originHostHeader		string	Der Hostheaderwert, der mit jeder Anforderung an den Ursprung gesendet wird. Wenn Sie diesen Wert leer lassen, bestimmt der Anforderungshostname diesen Wert. Azure CDN-Ursprünge wie Web-Apps, Blob Storage und Cloud Services erfordern, dass dieser Hostheaderwert standardmäßig mit dem Ursprungshostnamen übereinstimmt. Dadurch wird der am Endpunkt definierte Hostheader überschrieben.
properties.priority		integer	Ursprungspriorität in der angegebenen Ursprungsgruppe für den Lastenausgleich. Höhere Prioritäten werden nicht für den Lastenausgleich verwendet, wenn ein Ursprung mit niedrigerer Priorität fehlerfrei ist. Muss zwischen 1 und 5 sein
properties.privateLinkAlias		string	Der Alias der Private Link Ressource. Das Auffüllen dieses optionalen Felds weist darauf hin, dass dieser Ursprung "Privat" ist.
properties.privateLinkApprovalMessage		string	Eine benutzerdefinierte Nachricht, die in die Genehmigungsanforderung aufgenommen werden soll, um eine Verbindung mit dem Private Link herzustellen.
properties.privateLinkLocation		string	Der Speicherort der Private Link Ressource. Nur erforderlich, wenn "privateLinkResourceId" aufgefüllt ist
properties.privateLinkResourceId		string	Die Ressourcen-ID der Private Link Ressource. Das Auffüllen dieses optionalen Felds weist darauf hin, dass dieses Back-End "Privat" ist.
properties.weight		integer	Die Gewichtung des Ursprungs in der angegebenen Ursprungsgruppe für den Lastenausgleich. Muss zwischen 1 und 1000 sein

Antworten

Name	Typ	Beschreibung
200 OK	Origin	OK. Die Anforderung wurde erfolgreich durchgeführt.
201 Created	Origin	Erstellt. Die Anforderung wurde erfüllt, und ein neuer Ursprung wurde erstellt.
202 Accepted	Origin	Wird akzeptiert, und der Vorgang wird asynchron abgeschlossen. Headers location: string
Other Status Codes	ErrorResponse	CDN-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Origins_Create

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net?api-version=2024-02-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"
  }
}


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/2024-02-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

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/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-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

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/2024-02-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=2024-02-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"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityType	Der Identitätstyp, der Ressourcen erstellt/ändert
Origin	Der CDN-Ursprung ist die Quelle des Inhalts, der über CDN übermittelt wird. Wenn die durch einen Endpunkt dargestellten Edgeknoten den angeforderten Inhalt nicht zwischengespeichert haben, versuchen sie, sie aus einem oder mehreren konfigurierten Ursprüngen abzurufen.
OriginProvisioningState	Bereitstellung status des Ursprungs.
OriginResourceState	Ressourcen status des Ursprungs.
PrivateEndpointStatus	Die genehmigungs status für die Verbindung mit dem Private Link
SystemData	Schreibgeschützte Systemdaten

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityType

Der Identitätstyp, der Ressourcen erstellt/ändert

Name	Typ	Beschreibung
application	string
key	string
managedIdentity	string
user	string

Origin

Der CDN-Ursprung ist die Quelle des Inhalts, der über CDN übermittelt wird. Wenn die durch einen Endpunkt dargestellten Edgeknoten den angeforderten Inhalt nicht zwischengespeichert haben, versuchen sie, sie aus einem oder mehreren konfigurierten Ursprüngen abzurufen.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.enabled	boolean	Der Ursprung ist für den Lastenausgleich aktiviert oder nicht.
properties.hostName	string	Die Adresse des Ursprungs. Domänennamen, IPv4-Adressen und IPv6-Adressen werden unterstützt. Dies sollte für alle Ursprünge in einem Endpunkt eindeutig sein.
properties.httpPort	integer	Der Wert des HTTP-Ports. Der Wert muss zwischen 1 und 65535 liegen.
properties.httpsPort	integer	Der Wert des HTTPS-Ports. Der Wert muss zwischen 1 und 65535 liegen.
properties.originHostHeader	string	Der Hostheaderwert, der mit jeder Anforderung an den Ursprung gesendet wird. Wenn Sie diesen Wert leer lassen, bestimmt der Anforderungshostname diesen Wert. Azure CDN-Ursprünge wie Web-Apps, Blob Storage und Cloud Services erfordern, dass dieser Hostheaderwert standardmäßig mit dem Ursprungshostnamen übereinstimmt. Dadurch wird der am Endpunkt definierte Hostheader überschrieben.
properties.priority	integer	Ursprungspriorität in der angegebenen Ursprungsgruppe für den Lastenausgleich. Höhere Prioritäten werden nicht für den Lastenausgleich verwendet, wenn ein Ursprung mit niedrigerer Priorität fehlerfrei ist. Muss zwischen 1 und 5 sein
properties.privateEndpointStatus	PrivateEndpointStatus	Die genehmigungs status für die Verbindung mit dem Private Link
properties.privateLinkAlias	string	Der Alias der Private Link Ressource. Das Auffüllen dieses optionalen Felds weist darauf hin, dass dieser Ursprung "Privat" ist.
properties.privateLinkApprovalMessage	string	Eine benutzerdefinierte Nachricht, die in die Genehmigungsanforderung aufgenommen werden soll, um eine Verbindung mit dem Private Link herzustellen.
properties.privateLinkLocation	string	Der Speicherort der Private Link Ressource. Nur erforderlich, wenn "privateLinkResourceId" aufgefüllt ist
properties.privateLinkResourceId	string	Die Ressourcen-ID der Private Link Ressource. Das Auffüllen dieses optionalen Felds weist darauf hin, dass dieses Back-End "Privat" ist.
properties.provisioningState	OriginProvisioningState	Bereitstellung status des Ursprungs.
properties.resourceState	OriginResourceState	Ressourcen status des Ursprungs.
properties.weight	integer	Die Gewichtung des Ursprungs in der angegebenen Ursprungsgruppe für den Lastenausgleich. Muss zwischen 1 und 1000 sein
systemData	SystemData	Schreibgeschützte Systemdaten
type	string	Der Ressourcentyp.

OriginProvisioningState

Bereitstellung status des Ursprungs.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

OriginResourceState

Ressourcen status des Ursprungs.

Name	Typ	Beschreibung
Active	string
Creating	string
Deleting	string

PrivateEndpointStatus

Die genehmigungs status für die Verbindung mit dem Private Link

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

SystemData

Schreibgeschützte Systemdaten

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC)
createdBy	string	Ein Bezeichner für die Identität, die die Ressource erstellt hat
createdByType	IdentityType	Der Identitätstyp, der die Ressource erstellt hat
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Ein Bezeichner für die Identität, die die Ressource zuletzt geändert hat
lastModifiedByType	IdentityType	Der Identitätstyp, der die Ressource zuletzt geändert hat

Origins - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Origins_Create

Sample Request

Sample Response

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

Origin

OriginProvisioningState

OriginResourceState

PrivateEndpointStatus

SystemData

Zusätzliche Ressourcen