Origins - Update

Service:

CDN

API Version:

2023-05-01

Novedades un origen existente dentro de un punto de conexión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpointName	path	True	string	Nombre del punto de conexión en el perfil que es único globalmente.
originName	path	True	string	Nombre del origen que es único dentro del punto de conexión.
profileName	path	True	string	Nombre del perfil de cdn que es único dentro del grupo de recursos.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificador de suscripción de Azure
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2023-05-01.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.enabled	boolean	El origen está habilitado para el equilibrio de carga o no
properties.hostName	string	Dirección del origen. Se admiten nombres de dominio, direcciones IPv4 e direcciones IPv6. Debe ser único en todos los orígenes de un punto de conexión.
properties.httpPort	integer	Valor del puerto HTTP. Debe estar entre 1 y 65535.
properties.httpsPort	integer	Valor del puerto HTTPS. Debe estar entre 1 y 65535.
properties.originHostHeader	string	Valor del encabezado de host enviado al origen con cada solicitud. Si deja este valor en blanco, el nombre de host de la solicitud determina este valor. Los orígenes de Azure CDN, como Web Apps, Blob Storage y Cloud Services requieren que este valor de encabezado host coincida con el nombre de host de origen de forma predeterminada. Esto invalida el encabezado de host definido en el punto de conexión.
properties.priority	integer	Prioridad del origen en un grupo de origen determinado para el equilibrio de carga. Las prioridades más altas no se usarán para el equilibrio de carga si algún origen de prioridad inferior es correcto. Debe estar entre 1 y 5
properties.privateLinkAlias	string	Alias del recurso Private Link. Rellenar este campo opcional indica que este origen es "Privado".
properties.privateLinkApprovalMessage	string	Mensaje personalizado que se incluirá en la solicitud de aprobación para conectarse al Private Link.
properties.privateLinkLocation	string	Ubicación del recurso Private Link. Solo se requiere si se rellena "privateLinkResourceId"
properties.privateLinkResourceId	string	Identificador de recurso del recurso Private Link. Rellenar este campo opcional indica que este back-end es "Privado".
properties.weight	integer	Peso del origen en un grupo de orígenes determinado para el equilibrio de carga. Debe estar entre 1 y 1000

Respuestas

Nombre	Tipo	Description
200 OK	Origin	Aceptar. La solicitud se ha realizado correctamente.
202 Accepted	Origin	Aceptado y la operación se completará de forma asincrónica. Headers location: string
Other Status Codes	ErrorResponse	Respuesta de error de la red CDN que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Origins_Update

Sample Request

HTTP

PATCH 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": {
    "httpPort": 42,
    "httpsPort": 43,
    "originHostHeader": "www.someDomain2.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
  }
}

Java

import com.azure.resourcemanager.cdn.models.OriginUpdateParameters;

/** Samples for Origins Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Update.json
     */
    /**
     * Sample code: Origins_Update.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void originsUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getOrigins().update("RG", "profile1", "endpoint1",
            "www-someDomain-net",
            new OriginUpdateParameters().withHttpPort(42).withHttpsPort(43).withOriginHostHeader("www.someDomain2.net")
                .withPriority(1).withWeight(50).withEnabled(true).withPrivateLinkAlias(
                    "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"),
            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_update.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_update(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        origin_name="www-someDomain-net",
        origin_update_properties={
            "properties": {
                "enabled": True,
                "httpPort": 42,
                "httpsPort": 43,
                "originHostHeader": "www.someDomain2.net",
                "priority": 1,
                "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice",
                "weight": 50,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Update.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_Update.json
func ExampleOriginsClient_BeginUpdate() {
	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().BeginUpdate(ctx, "RG", "profile1", "endpoint1", "www-someDomain-net", armcdn.OriginUpdateParameters{
		Properties: &armcdn.OriginUpdatePropertiesParameters{
			Enabled:          to.Ptr(true),
			HTTPPort:         to.Ptr[int32](42),
			HTTPSPort:        to.Ptr[int32](43),
			OriginHostHeader: to.Ptr("www.someDomain2.net"),
			Priority:         to.Ptr[int32](1),
			PrivateLinkAlias: to.Ptr("APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"),
			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](42),
	// 		HTTPSPort: to.Ptr[int32](43),
	// 		OriginHostHeader: to.Ptr("www.someDomain2.net"),
	// 		Priority: to.Ptr[int32](1),
	// 		PrivateLinkAlias: to.Ptr("APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"),
	// 		PrivateLinkApprovalMessage: to.Ptr("Please approve the connection request for this Private Link"),
	// 		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 Updates an existing origin within an endpoint.
 *
 * @summary Updates an existing origin within an endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Origins_Update.json
 */
async function originsUpdate() {
  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 originUpdateProperties = {
    enabled: true,
    httpPort: 42,
    httpsPort: 43,
    originHostHeader: "www.someDomain2.net",
    priority: 1,
    privateLinkAlias:
      "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice",
    weight: 50,
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.origins.beginUpdateAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    originName,
    originUpdateProperties
  );
  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": 42,
    "httpsPort": 43,
    "originHostHeader": "www.someDomain2.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateEndpointStatus": "Pending",
    "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
    "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
  }
}

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": 42,
    "httpsPort": 43,
    "originHostHeader": "www.someDomain2.net",
    "priority": 1,
    "weight": 50,
    "enabled": true,
    "privateEndpointStatus": "Pending",
    "privateLinkApprovalMessage": "Please approve the connection request for this Private Link",
    "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IdentityType	Tipo de identidad que crea o modifica recursos.
Origin	El origen de la red CDN es el origen del contenido que se entrega a través de la red CDN. Cuando los nodos perimetrales representados por un punto de conexión no tienen el contenido solicitado almacenado en caché, intentan capturarlo de uno o varios de los orígenes configurados.
OriginProvisioningState	Estado de aprovisionamiento del origen.
OriginResourceState	Estado del recurso del origen.
OriginUpdateParameters	Propiedades de origen necesarias para la actualización de origen.
PrivateEndpointStatus	Estado de aprobación de la conexión a la Private Link
SystemData	Datos del sistema de solo lectura

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IdentityType

Tipo de identidad que crea o modifica recursos.

Nombre	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

Origin

El origen de la red CDN es el origen del contenido que se entrega a través de la red CDN. Cuando los nodos perimetrales representados por un punto de conexión no tienen el contenido solicitado almacenado en caché, intentan capturarlo de uno o varios de los orígenes configurados.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.enabled	boolean	El origen está habilitado para el equilibrio de carga o no
properties.hostName	string	Dirección del origen. Se admiten nombres de dominio, direcciones IPv4 e direcciones IPv6. Debe ser único en todos los orígenes de un punto de conexión.
properties.httpPort	integer	Valor del puerto HTTP. Debe estar entre 1 y 65535.
properties.httpsPort	integer	Valor del puerto HTTPS. Debe estar entre 1 y 65535.
properties.originHostHeader	string	Valor del encabezado de host enviado al origen con cada solicitud. Si deja este valor en blanco, el nombre de host de la solicitud determina este valor. Los orígenes de Azure CDN, como Web Apps, Blob Storage y Cloud Services requieren que este valor de encabezado host coincida con el nombre de host de origen de forma predeterminada. Esto invalida el encabezado de host definido en el punto de conexión.
properties.priority	integer	Prioridad del origen en un grupo de origen determinado para el equilibrio de carga. Las prioridades más altas no se usarán para el equilibrio de carga si algún origen de prioridad inferior es correcto. Debe estar entre 1 y 5
properties.privateEndpointStatus	PrivateEndpointStatus	Estado de aprobación de la conexión a la Private Link
properties.privateLinkAlias	string	Alias del recurso Private Link. Rellenar este campo opcional indica que este origen es "Privado".
properties.privateLinkApprovalMessage	string	Mensaje personalizado que se incluirá en la solicitud de aprobación para conectarse al Private Link.
properties.privateLinkLocation	string	Ubicación del recurso Private Link. Solo se requiere si se rellena "privateLinkResourceId"
properties.privateLinkResourceId	string	Identificador de recurso del recurso Private Link. Rellenar este campo opcional indica que este back-end es "Privado".
properties.provisioningState	OriginProvisioningState	Estado de aprovisionamiento del origen.
properties.resourceState	OriginResourceState	Estado del recurso del origen.
properties.weight	integer	Peso del origen en un grupo de orígenes determinado para el equilibrio de carga. Debe estar entre 1 y 1000
systemData	SystemData	Datos del sistema de solo lectura
type	string	Tipo de recurso.

OriginProvisioningState

Estado de aprovisionamiento del origen.

Nombre	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

OriginResourceState

Estado del recurso del origen.

Nombre	Tipo	Description
Active	string
Creating	string
Deleting	string

OriginUpdateParameters

Propiedades de origen necesarias para la actualización de origen.

Nombre	Tipo	Description
properties.enabled	boolean	El origen está habilitado para el equilibrio de carga o no
properties.hostName	string	Dirección del origen. Se admiten nombres de dominio, direcciones IPv4 e direcciones IPv6. Debe ser único en todos los orígenes de un punto de conexión.
properties.httpPort	integer	Valor del puerto HTTP. Debe estar entre 1 y 65535.
properties.httpsPort	integer	Valor del puerto HTTPS. Debe estar entre 1 y 65535.
properties.originHostHeader	string	Valor del encabezado de host enviado al origen con cada solicitud. Si deja este valor en blanco, el nombre de host de la solicitud determina este valor. Los orígenes de Azure CDN, como Web Apps, Blob Storage y Cloud Services requieren que este valor de encabezado host coincida con el nombre de host de origen de forma predeterminada. Esto invalida el encabezado de host definido en el punto de conexión.
properties.priority	integer	Prioridad del origen en un grupo de origen determinado para el equilibrio de carga. Las prioridades más altas no se usarán para el equilibrio de carga si algún origen de prioridad inferior es correcto. Debe estar entre 1 y 5
properties.privateLinkAlias	string	Alias del recurso Private Link. Rellenar este campo opcional indica que este origen es "Privado".
properties.privateLinkApprovalMessage	string	Mensaje personalizado que se incluirá en la solicitud de aprobación para conectarse al Private Link.
properties.privateLinkLocation	string	Ubicación del recurso Private Link. Solo se requiere si se rellena "privateLinkResourceId"
properties.privateLinkResourceId	string	Identificador de recurso del recurso Private Link. Rellenar este campo opcional indica que este back-end es "Privado".
properties.weight	integer	Peso del origen en un grupo de orígenes determinado para el equilibrio de carga. Debe estar entre 1 y 1000

PrivateEndpointStatus

Estado de aprobación de la conexión a la Private Link

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

SystemData

Datos del sistema de solo lectura

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC)
createdBy	string	Identificador de la identidad que creó el recurso.
createdByType	IdentityType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identificador de la identidad que modificó el recurso por última vez.
lastModifiedByType	IdentityType	Tipo de identidad que modificó por última vez el recurso.