Origin Groups - List By Endpoint

Service:: CDN

Version d'API:: 2025-04-15

Répertorie tous les groupes d’origine existants au sein d’un point de terminaison.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpointName	path	True	string	Nom du point de terminaison sous le profil qui est unique globalement.
profileName	path	True	string	Nom du profil CDN qui est unique dans le groupe de ressources.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	OriginGroupListResult	D’ACCORD. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur CDN décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

OriginsGroups_ListByEndpoint

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups?api-version=2025-04-15

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/OriginGroups_ListByEndpoint.json
// this example is just showing the usage of "CdnOriginGroups_ListByEndpoint" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// get the collection of this CdnOriginGroupResource
CdnOriginGroupCollection collection = cdnEndpoint.GetCdnOriginGroups();

// invoke the operation and iterate over the result
await foreach (CdnOriginGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CdnOriginGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Exemple de réponse

Code d’état:: 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
        }
      }
    }
  ]
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HealthProbeParameters	Objet JSON qui contient les propriétés permettant d’envoyer des sondes d’intégrité à l’origine.
HealthProbeRequestType	Type de demande de sonde d’intégrité effectuée.
HttpErrorRangeParameters	Objet JSON qui représente la plage pour les codes d’état HTTP
OriginGroup	Le groupe d’origines comprenant des origines est utilisé pour l’équilibrage de charge aux origines lorsque le contenu ne peut pas être servi à partir du CDN.
OriginGroupListResult	Résultat de la requête pour répertorier les groupes d’origines. Il contient une liste d’objets de groupes d’origines et un lien d’URL pour obtenir le jeu de résultats suivant.
OriginGroupProvisioningState	État d’approvisionnement du groupe d’origine.
OriginGroupResourceState	État de la ressource du groupe d’origine.
ProbeProtocol	Protocole à utiliser pour la sonde d’intégrité.
ResourceReference	Référence à une autre ressource.
ResponseBasedDetectedErrorTypes	Type d’erreurs de réponse pour les demandes d’utilisateur réelles pour lesquelles l’origine sera considérée comme non saine
ResponseBasedOriginErrorDetectionParameters	Objet JSON qui contient les propriétés pour déterminer l’intégrité de l’origine à l’aide de requêtes/réponses réelles.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

HealthProbeParameters

Object

Objet JSON qui contient les propriétés permettant d’envoyer des sondes d’intégrité à l’origine.

Nom	Type	Description
probeIntervalInSeconds	integer (int32) minimum: 1 maximum: 255	Nombre de secondes entre les sondes d’intégrité. La valeur par défaut est 240sec.
probePath	string	Chemin relatif à l’origine utilisée pour déterminer l’intégrité de l’origine.
probeProtocol	ProbeProtocol	Protocole à utiliser pour la sonde d’intégrité.
probeRequestType	HealthProbeRequestType	Type de demande de sonde d’intégrité effectuée.

HealthProbeRequestType

Énumération

Type de demande de sonde d’intégrité effectuée.

Valeur	Description
GET
HEAD
NotSet

HttpErrorRangeParameters

Object

Objet JSON qui représente la plage pour les codes d’état HTTP

Nom	Type	Description
begin	integer (int32) minimum: 100 maximum: 999	Début inclusif de la plage de codes d’état http.
end	integer (int32) minimum: 100 maximum: 999	Fin inclusive de la plage de codes d’état HTTP.

OriginGroup

Object

Le groupe d’origines comprenant des origines est utilisé pour l’équilibrage de charge aux origines lorsque le contenu ne peut pas être servi à partir du CDN.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.healthProbeSettings	HealthProbeParameters	Paramètres de la sonde d’intégrité à l’origine utilisée pour déterminer l’intégrité de l’origine.
properties.origins	ResourceReference[]	Source du contenu remis via CDN dans un groupe d’origine donné.
properties.provisioningState	OriginGroupProvisioningState	État d’approvisionnement du groupe d’origine.
properties.resourceState	OriginGroupResourceState	État de la ressource du groupe d’origine.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	Objet JSON qui contient les propriétés pour déterminer l’intégrité de l’origine à l’aide de requêtes/réponses réelles. Cette propriété n’est actuellement pas prise en charge.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	Temps en minutes pour déplacer le trafic vers le point de terminaison progressivement lorsqu’un point de terminaison non sain est sain ou qu’un nouveau point de terminaison est ajouté. La valeur par défaut est de 10 minutes. Cette propriété n’est actuellement pas prise en charge.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OriginGroupListResult

Object

Résultat de la requête pour répertorier les groupes d’origines. Il contient une liste d’objets de groupes d’origines et un lien d’URL pour obtenir le jeu de résultats suivant.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir le jeu d’objets d’origine suivant s’il y en a un.
value	OriginGroup[]	Liste des groupes d’origine CDN au sein d’un point de terminaison

OriginGroupProvisioningState

Énumération

État d’approvisionnement du groupe d’origine.

Valeur	Description
Creating
Deleting
Failed
Succeeded
Updating

OriginGroupResourceState

Énumération

État de la ressource du groupe d’origine.

Valeur	Description
Active
Creating
Deleting

ProbeProtocol

Énumération

Protocole à utiliser pour la sonde d’intégrité.

Valeur	Description
Http
Https
NotSet

ResourceReference

Object

Référence à une autre ressource.

Nom	Type	Description
id	string	ID de ressource.

ResponseBasedDetectedErrorTypes

Énumération

Type d’erreurs de réponse pour les demandes d’utilisateur réelles pour lesquelles l’origine sera considérée comme non saine

Valeur	Description
None
TcpAndHttpErrors
TcpErrorsOnly

ResponseBasedOriginErrorDetectionParameters

Object

Objet JSON qui contient les propriétés pour déterminer l’intégrité de l’origine à l’aide de requêtes/réponses réelles.

Nom	Type	Description
httpErrorRanges	HttpErrorRangeParameters[]	Liste des plages de codes d’état Http considérées comme des erreurs de serveur pour l’origine et marquées comme non saines.
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	Type d’erreurs de réponse pour les demandes d’utilisateur réelles pour lesquelles l’origine sera considérée comme non saine
responseBasedFailoverThresholdPercentage	integer (int32) minimum: 0 maximum: 100	Pourcentage de demandes ayant échoué dans l’exemple où le basculement doit se déclencher.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Origin Groups - List By Endpoint

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

OriginsGroups_ListByEndpoint

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HealthProbeParameters

HealthProbeRequestType

HttpErrorRangeParameters

OriginGroup

OriginGroupListResult

OriginGroupProvisioningState

OriginGroupResourceState

ProbeProtocol

ResourceReference

ResponseBasedDetectedErrorTypes

ResponseBasedOriginErrorDetectionParameters

systemData