Origin Groups - List By Endpoint

Service:

CDN

API Version:

2023-05-01

Mencantumkan semua grup asal yang ada dalam titik akhir.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpointName	path	True	string	Nama titik akhir di bawah profil yang unik secara global.
profileName	path	True	string	Nama profil CDN yang unik dalam grup sumber daya.
resourceGroupName	path	True	string	Nama grup Sumber Daya dalam langganan Azure. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID Langganan Azure.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2023-05-01.

Respons

Nama	Jenis	Deskripsi
200 OK	OriginGroupListResult	OK. Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan CDN yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

OriginsGroups_ListByEndpoint

Sample Request

HTTP

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

Java

/** Samples for OriginGroups ListByEndpoint. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_ListByEndpoint.json
     */
    /**
     * Sample code: OriginsGroups_ListByEndpoint.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void originsGroupsListByEndpoint(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getOriginGroups().listByEndpoint("RG", "profile1", "endpoint1",
            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 origin_groups_list_by_endpoint.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.list_by_endpoint(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_ListByEndpoint.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/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_ListByEndpoint.json
func ExampleOriginGroupsClient_NewListByEndpointPager() {
	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)
	}
	pager := clientFactory.NewOriginGroupsClient().NewListByEndpointPager("RG", "profile1", "endpoint1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OriginGroupListResult = armcdn.OriginGroupListResult{
		// 	Value: []*armcdn.OriginGroup{
		// 		{
		// 			Name: to.Ptr("origingroup1"),
		// 			Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/origingroups"),
		// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"),
		// 			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/origin1"),
		// 				}},
		// 				ResponseBasedOriginErrorDetectionSettings: &armcdn.ResponseBasedOriginErrorDetectionParameters{
		// 					ResponseBasedDetectedErrorTypes: to.Ptr(armcdn.ResponseBasedDetectedErrorTypesTCPErrorsOnly),
		// 					ResponseBasedFailoverThresholdPercentage: to.Ptr[int32](10),
		// 				},
		// 				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

JavaScript

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

/**
 * This sample demonstrates how to Lists all of the existing origin groups within an endpoint.
 *
 * @summary Lists all of the existing origin groups within an endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/OriginGroups_ListByEndpoint.json
 */
async function originsGroupsListByEndpoint() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.originGroups.listByEndpoint(
    resourceGroupName,
    profileName,
    endpointName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "name": "origingroup1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
      "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
      "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/origin1"
          }
        ],
        "responseBasedOriginErrorDetectionSettings": {
          "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
          "responseBasedFailoverThresholdPercentage": 10
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
HealthProbeParameters	Objek JSON yang berisi properti untuk mengirim pemeriksaan kesehatan ke asal.
HealthProbeRequestType	Jenis permintaan pemeriksaan kesehatan yang dibuat.
HttpErrorRangeParameters	Objek JSON yang mewakili rentang untuk kode status http
IdentityType	Jenis identitas yang membuat/memodifikasi sumber daya
OriginGroup	Grup asal yang terdiri dari asal digunakan untuk penyeimbangan beban ke asal ketika konten tidak dapat dilayani dari CDN.
OriginGroupListResult	Hasil permintaan untuk mencantumkan grup asal. Ini berisi daftar objek grup asal dan tautan URL untuk mendapatkan serangkaian hasil berikutnya.
OriginGroupProvisioningState	Status provisi grup asal.
OriginGroupResourceState	Status sumber daya grup asal.
ProbeProtocol	Protokol yang digunakan untuk pemeriksaan kesehatan.
ResourceReference	Referensi ke sumber daya lain.
ResponseBasedDetectedErrorTypes	Jenis kesalahan respons untuk permintaan pengguna nyata yang asalnya akan dianggap tidak sehat
ResponseBasedOriginErrorDetectionParameters	Objek JSON yang berisi properti untuk menentukan kesehatan asal menggunakan permintaan/respons nyata.
SystemData	Membaca hanya data sistem

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

HealthProbeParameters

Objek JSON yang berisi properti untuk mengirim pemeriksaan kesehatan ke asal.

Nama	Jenis	Deskripsi
probeIntervalInSeconds	integer	Jumlah detik antara pemeriksaan kesehatan. Defaultnya adalah 240 detik.
probePath	string	Jalur relatif terhadap asal yang digunakan untuk menentukan kesehatan asal.
probeProtocol	ProbeProtocol	Protokol yang digunakan untuk pemeriksaan kesehatan.
probeRequestType	HealthProbeRequestType	Jenis permintaan pemeriksaan kesehatan yang dibuat.

HealthProbeRequestType

Jenis permintaan pemeriksaan kesehatan yang dibuat.

Nama	Jenis	Deskripsi
GET	string
HEAD	string
NotSet	string

HttpErrorRangeParameters

Objek JSON yang mewakili rentang untuk kode status http

Nama	Jenis	Deskripsi
begin	integer	Awal inklusif dari rentang kode status http.
end	integer	Akhir inklusif dari rentang kode status http.

IdentityType

Jenis identitas yang membuat/memodifikasi sumber daya

Nama	Jenis	Deskripsi
application	string
key	string
managedIdentity	string
user	string

OriginGroup

Grup asal yang terdiri dari asal digunakan untuk penyeimbangan beban ke asal ketika konten tidak dapat dilayani dari CDN.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.healthProbeSettings	HealthProbeParameters	Pengaturan pemeriksaan kesehatan ke asal yang digunakan untuk menentukan kesehatan asal.
properties.origins	ResourceReference[]	Sumber konten yang dikirimkan melalui CDN dalam grup asal tertentu.
properties.provisioningState	OriginGroupProvisioningState	Status provisi grup asal.
properties.resourceState	OriginGroupResourceState	Status sumber daya grup asal.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	Objek JSON yang berisi properti untuk menentukan kesehatan asal menggunakan permintaan/respons nyata. Properti ini saat ini tidak didukung.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	Waktu dalam menit untuk mengalihkan lalu lintas ke titik akhir secara bertahap ketika titik akhir yang tidak sehat menjadi sehat atau titik akhir baru ditambahkan. Defaultnya adalah 10 menit. Properti ini saat ini tidak didukung.
systemData	SystemData	Membaca hanya data sistem
type	string	Jenis sumber daya

OriginGroupListResult

Hasil permintaan untuk mencantumkan grup asal. Ini berisi daftar objek grup asal dan tautan URL untuk mendapatkan serangkaian hasil berikutnya.

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan set objek asal berikutnya jika ada.
value	OriginGroup[]	Daftar grup asal CDN dalam titik akhir

OriginGroupProvisioningState

Status provisi grup asal.

Nama	Jenis	Deskripsi
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

OriginGroupResourceState

Status sumber daya grup asal.

Nama	Jenis	Deskripsi
Active	string
Creating	string
Deleting	string

ProbeProtocol

Protokol yang digunakan untuk pemeriksaan kesehatan.

Nama	Jenis	Deskripsi
Http	string
Https	string
NotSet	string

ResourceReference

Referensi ke sumber daya lain.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.

ResponseBasedDetectedErrorTypes

Jenis kesalahan respons untuk permintaan pengguna nyata yang asalnya akan dianggap tidak sehat

Nama	Jenis	Deskripsi
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

Objek JSON yang berisi properti untuk menentukan kesehatan asal menggunakan permintaan/respons nyata.

Nama	Jenis	Deskripsi
httpErrorRanges	HttpErrorRangeParameters[]	Daftar rentang kode status Http yang dianggap sebagai kesalahan server untuk asal dan ditandai sebagai tidak sehat.
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	Jenis kesalahan respons untuk permintaan pengguna nyata yang asalnya akan dianggap tidak sehat
responseBasedFailoverThresholdPercentage	integer	Persentase permintaan yang gagal dalam sampel di mana failover harus dipicu.

SystemData

Membaca hanya data sistem

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC)
createdBy	string	Pengidentifikasi untuk identitas yang membuat sumber daya
createdByType	IdentityType	Jenis identitas yang membuat sumber daya
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Pengidentifikasi untuk identitas yang terakhir memodifikasi sumber daya
lastModifiedByType	IdentityType	Jenis identitas yang terakhir mengubah sumber daya