Origin Groups - Update

Reference

Service:: CDN

API Version:: 2023-05-01

Updates an existing origin group within an endpoint.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}?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.
originGroupName	path	True	string	Name of the origin group which 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	Type	Description
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.origins	ResourceReference[]	The source of the content being delivered via CDN within given origin group.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.

Responses

Name	Type	Description
200 OK	OriginGroup	OK. The request has succeeded.
202 Accepted	OriginGroup	Accepted and the operation will complete asynchronously. Headers location: string
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

Name

Type

Description

200 OK

OriginGroup

OK. The request has succeeded.

202 Accepted

OriginGroup

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

OriginGroups_Update

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1?api-version=2023-05-01

{
  "properties": {
    "healthProbeSettings": {
      "probePath": "/health.aspx",
      "probeRequestType": "GET",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 120
    },
    "origins": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
      }
    ]
  }
}


import com.azure.resourcemanager.cdn.models.HealthProbeParameters;
import com.azure.resourcemanager.cdn.models.HealthProbeRequestType;
import com.azure.resourcemanager.cdn.models.OriginGroupUpdateParameters;
import com.azure.resourcemanager.cdn.models.ProbeProtocol;
import com.azure.resourcemanager.cdn.models.ResourceReference;
import java.util.Arrays;

/** Samples for OriginGroups Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_Update.json
     */
    /**
     * Sample code: OriginGroups_Update.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void originGroupsUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getOriginGroups().update("RG", "profile1", "endpoint1",
            "originGroup1",
            new OriginGroupUpdateParameters()
                .withHealthProbeSettings(new HealthProbeParameters().withProbePath("/health.aspx")
                    .withProbeRequestType(HealthProbeRequestType.GET).withProbeProtocol(ProbeProtocol.HTTP)
                    .withProbeIntervalInSeconds(120))
                .withOrigins(Arrays.asList(new ResourceReference().withId(
                    "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"))),
            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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python origin_groups_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.origin_groups.begin_update(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        origin_group_name="originGroup1",
        origin_group_update_properties={
            "properties": {
                "healthProbeSettings": {
                    "probeIntervalInSeconds": 120,
                    "probePath": "/health.aspx",
                    "probeProtocol": "Http",
                    "probeRequestType": "GET",
                },
                "origins": [
                    {
                        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_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

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/OriginGroups_Update.json
func ExampleOriginGroupsClient_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.NewOriginGroupsClient().BeginUpdate(ctx, "RG", "profile1", "endpoint1", "originGroup1", armcdn.OriginGroupUpdateParameters{
		Properties: &armcdn.OriginGroupUpdatePropertiesParameters{
			HealthProbeSettings: &armcdn.HealthProbeParameters{
				ProbeIntervalInSeconds: to.Ptr[int32](120),
				ProbePath:              to.Ptr("/health.aspx"),
				ProbeProtocol:          to.Ptr(armcdn.ProbeProtocolHTTP),
				ProbeRequestType:       to.Ptr(armcdn.HealthProbeRequestTypeGET),
			},
			Origins: []*armcdn.ResourceReference{
				{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"),
				}},
		},
	}, 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.OriginGroup = armcdn.OriginGroup{
	// 	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.OriginGroupProperties{
	// 		HealthProbeSettings: &armcdn.HealthProbeParameters{
	// 			ProbeIntervalInSeconds: to.Ptr[int32](120),
	// 			ProbePath: to.Ptr("/health.aspx"),
	// 			ProbeProtocol: to.Ptr(armcdn.ProbeProtocolHTTP),
	// 			ProbeRequestType: to.Ptr(armcdn.HealthProbeRequestTypeGET),
	// 		},
	// 		Origins: []*armcdn.ResourceReference{
	// 			{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"),
	// 		}},
	// 		ProvisioningState: to.Ptr(armcdn.OriginGroupProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.OriginGroupResourceStateActive),
	// 	},
	// }
}

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 Updates an existing origin group within an endpoint.
 *
 * @summary Updates an existing origin group within an endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_Update.json
 */
async function originGroupsUpdate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const originGroupName = "originGroup1";
  const originGroupUpdateProperties = {
    healthProbeSettings: {
      probeIntervalInSeconds: 120,
      probePath: "/health.aspx",
      probeProtocol: "Http",
      probeRequestType: "GET",
    },
    origins: [
      {
        id: "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.originGroups.beginUpdateAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    originGroupName,
    originGroupUpdateProperties
  );
  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",
    "healthProbeSettings": {
      "probePath": "/health.aspx",
      "probeRequestType": "GET",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 120
    },
    "origins": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
      }
    ]
  }
}

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",
    "healthProbeSettings": {
      "probePath": "/health.aspx",
      "probeRequestType": "GET",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 120
    },
    "origins": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
      }
    ]
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HealthProbeParameters	The JSON object that contains the properties to send health probes to origin.
HealthProbeRequestType	The type of health probe request that is made.
HttpErrorRangeParameters	The JSON object that represents the range for http status codes
IdentityType	The type of identity that creates/modifies resources
OriginGroup	Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.
OriginGroupProvisioningState	Provisioning status of the origin group.
OriginGroupResourceState	Resource status of the origin group.
OriginGroupUpdateParameters	Origin group properties needed for origin group creation or update.
ProbeProtocol	Protocol to use for health probe.
ResourceReference	Reference to another resource.
ResponseBasedDetectedErrorTypes	Type of response errors for real user requests for which origin will be deemed unhealthy
ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses.
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.

HealthProbeParameters

The JSON object that contains the properties to send health probes to origin.

Name	Type	Description
probeIntervalInSeconds	integer	The number of seconds between health probes.Default is 240sec.
probePath	string	The path relative to the origin that is used to determine the health of the origin.
probeProtocol	ProbeProtocol	Protocol to use for health probe.
probeRequestType	HealthProbeRequestType	The type of health probe request that is made.

HealthProbeRequestType

The type of health probe request that is made.

Name	Type	Description
GET	string
HEAD	string
NotSet	string

HttpErrorRangeParameters

The JSON object that represents the range for http status codes

Name	Type	Description
begin	integer	The inclusive start of the http status code range.
end	integer	The inclusive end of the http status code range.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

OriginGroup

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.origins	ResourceReference[]	The source of the content being delivered via CDN within given origin group.
properties.provisioningState	OriginGroupProvisioningState	Provisioning status of the origin group.
properties.resourceState	OriginGroupResourceState	Resource status of the origin group.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
systemData	SystemData	Read only system data
type	string	Resource type.

OriginGroupProvisioningState

Provisioning status of the origin group.

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

OriginGroupResourceState

Resource status of the origin group.

Name	Type	Description
Active	string
Creating	string
Deleting	string

OriginGroupUpdateParameters

Origin group properties needed for origin group creation or update.

Name	Type	Description
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.origins	ResourceReference[]	The source of the content being delivered via CDN within given origin group.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.

ProbeProtocol

Protocol to use for health probe.

Name	Type	Description
Http	string
Https	string
NotSet	string

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

ResponseBasedDetectedErrorTypes

Type of response errors for real user requests for which origin will be deemed unhealthy

Name	Type	Description
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses.

Name	Type	Description
httpErrorRanges	HttpErrorRangeParameters[]	The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	Type of response errors for real user requests for which origin will be deemed unhealthy
responseBasedFailoverThresholdPercentage	integer	The percentage of failed requests in the sample where failover should trigger.

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

Origin Groups - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

OriginGroups_Update

Sample Request

Sample Response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HealthProbeParameters

HealthProbeRequestType

HttpErrorRangeParameters

IdentityType

OriginGroup

OriginGroupProvisioningState

OriginGroupResourceState

OriginGroupUpdateParameters

ProbeProtocol

ResourceReference

ResponseBasedDetectedErrorTypes

ResponseBasedOriginErrorDetectionParameters

SystemData

Sumber Daya Tambahan: