Event Sources - List By Environment

Référence

Service:: Time Series Insights

API Version:: 2020-05-15

Listes toutes les sources d’événements disponibles associées à l’abonnement et au sein du groupe de ressources et de l’environnement spécifiés.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources?api-version=2020-05-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentName	path	True	string	Nom de l’environnement Time Series Insights associé au groupe de ressources spécifié.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure.
subscriptionId	path	True	string	ID d’abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.

Réponses

Nom	Type	Description
200 OK	EventSourceListResponse	Les environnements retournés avec succès.
Other Status Codes	CloudError	HTTP 404 (introuvable) : l’abonnement, le groupe de ressources ou l’environnement est introuvable.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Exemples

ListEventSourcesByEnvironment

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/eventSources?api-version=2020-05-15

/** Samples for EventSources ListByEnvironment. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json
     */
    /**
     * Sample code: ListEventSourcesByEnvironment.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void listEventSourcesByEnvironment(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.eventSources().listByEnvironmentWithResponse("rg1", "env1", 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 armtimeseriesinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json
func ExampleEventSourcesClient_ListByEnvironment() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEventSourcesClient().ListByEnvironment(ctx, "rg1", "env1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.EventSourceListResponse = armtimeseriesinsights.EventSourceListResponse{
	// 	Value: []armtimeseriesinsights.EventSourceResourceClassification{
	// 		&armtimeseriesinsights.EventHubEventSourceResource{
	// 			Name: to.Ptr("es1"),
	// 			Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/EventSources"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1"),
	// 			Location: to.Ptr("West US"),
	// 			Tags: map[string]*string{
	// 			},
	// 			Kind: to.Ptr(armtimeseriesinsights.EventSourceResourceKindMicrosoftEventHub),
	// 			Properties: &armtimeseriesinsights.EventHubEventSourceResourceProperties{
	// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-18T19:20:33.228Z"); return t}()),
	// 				ProvisioningState: to.Ptr(armtimeseriesinsights.ProvisioningStateSucceeded),
	// 				IngressStartAt: &armtimeseriesinsights.IngressStartAtProperties{
	// 					Type: to.Ptr(armtimeseriesinsights.IngressStartAtTypeEarliestAvailable),
	// 				},
	// 				LocalTimestamp: &armtimeseriesinsights.LocalTimestamp{
	// 					Format: to.Ptr(armtimeseriesinsights.LocalTimestampFormat("TimeSpan")),
	// 					TimeZoneOffset: &armtimeseriesinsights.LocalTimestampTimeZoneOffset{
	// 						PropertyName: to.Ptr("someEventPropertyName"),
	// 					},
	// 				},
	// 				EventSourceResourceID: to.Ptr("somePathInArm"),
	// 				ConsumerGroupName: to.Ptr("cgn"),
	// 				EventHubName: to.Ptr("ehn"),
	// 				KeyName: to.Ptr("managementKey"),
	// 				ServiceBusNamespace: to.Ptr("sbn"),
	// 			},
	// 	}},
	// }
}

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": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1",
      "location": "West US",
      "name": "es1",
      "type": "Microsoft.TimeSeriesInsights/Environments/EventSources",
      "tags": {},
      "kind": "Microsoft.EventHub",
      "properties": {
        "eventSourceResourceId": "somePathInArm",
        "serviceBusNamespace": "sbn",
        "consumerGroupName": "cgn",
        "eventHubName": "ehn",
        "keyName": "managementKey",
        "provisioningState": "Succeeded",
        "creationTime": "2017-04-18T19:20:33.2288820Z",
        "localTimestamp": {
          "format": "TimeSpan",
          "timeZoneOffset": {
            "propertyName": "someEventPropertyName"
          }
        },
        "ingressStartAt": {
          "type": "EarliestAvailable"
        }
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
EventHubEventSourceResource	Source d’événement qui reçoit ses données d’un EventHub Azure.
EventSourceListResponse	Réponse de l’opération List EventSources.
IngressStartAtType	Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ».
IoTHubEventSourceResource	Source d’événement qui reçoit ses données d’un Azure IoTHub.
LocalTimestamp	Objet qui représente la propriété timestamp locale. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si aucune valeur n’est spécifiée pour localTimestamp, ou si la valeur est null, l’horodatage local n’est pas entré avec les événements.
LocalTimestampFormat	Enum qui représente le format de la propriété timestamp locale qui doit être définie.
ProvisioningState	État d’approvisionnement de la ressource.
TimeZoneOffset	Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded.

CloudError

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code status HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit l’erreur en détail et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

EventHubEventSourceResource

Source d’événement qui reçoit ses données d’un EventHub Azure.

Nom	Type	Description
creationTime	string	Heure à laquelle la ressource a été créée.
eventSourceResourceId	string	ID de ressource de la source d’événement dans Azure Resource Manager.
id	string	ID de ressource
ingressStartAt.time	string	ISO8601 datetime UTC avec une précision en secondes (les millisecondes sont facultatives), en spécifiant la date et l’heure qui seront le point de départ des événements à consommer.
ingressStartAt.type	IngressStartAtType	Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ».
kind	string: Microsoft.EventHub	Type de la source de l’événement.
localTimestamp	LocalTimestamp	Objet qui représente la propriété timestamp locale. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si aucune valeur n’est spécifiée pour localTimestamp, ou si la valeur est null, l’horodatage local n’est pas entré avec les événements.
location	string	Emplacement de la ressource
name	string	Nom de la ressource
properties.consumerGroupName	string	Nom du groupe de consommateurs du hub d’événements qui contient les partitions à partir desquelles les événements seront lus.
properties.eventHubName	string	Nom du hub d’événements.
properties.keyName	string	Nom de la clé SAS qui accorde au service Time Series Insights l’accès au hub d’événements. Les stratégies d’accès partagé pour cette clé doivent accorder des autorisations « Écouter » au hub d’événements.
properties.serviceBusNamespace	string	Nom du service bus qui contient le hub d’événements.
provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
tags	object	Balises de ressource
timestampPropertyName	string	Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée.
type	string	Type de ressource

EventSourceListResponse

Réponse de l’opération List EventSources.

Nom	Type	Description
value	EventSourceResource[]: EventHubEventSourceResource[] IoTHubEventSourceResource[]	Résultat de l’opération List EventSources.

IngressStartAtType

Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ».

Nom	Type	Description
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Source d’événement qui reçoit ses données d’un Azure IoTHub.

Nom	Type	Description
creationTime	string	Heure à laquelle la ressource a été créée.
eventSourceResourceId	string	ID de ressource de la source d’événement dans Azure Resource Manager.
id	string	ID de ressource
ingressStartAt.time	string	ISO8601 datetime UTC avec une précision en secondes (les millisecondes sont facultatives), en spécifiant la date et l’heure qui seront le point de départ des événements à consommer.
ingressStartAt.type	IngressStartAtType	Type de l’ingressStartAt, Il peut être « EarliestAvailable », « EventSourceCreationTime », « CustomEnqueuedTime ».
kind	string: Microsoft.IoTHub	Type de la source de l’événement.
localTimestamp	LocalTimestamp	Objet qui représente la propriété timestamp locale. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si aucune valeur n’est spécifiée pour localTimestamp, ou si la valeur est null, l’horodatage local n’est pas entré avec les événements.
location	string	Emplacement de la ressource
name	string	Nom de la ressource
properties.consumerGroupName	string	Nom du groupe de consommateurs du hub iot qui contient les partitions à partir desquelles les événements seront lus.
properties.iotHubName	string	Nom du hub iot.
properties.keyName	string	Nom de la clé de stratégie d’accès partagé qui accorde au service Time Series Insights l’accès au hub iot. Cette clé de stratégie d’accès partagé doit accorder des autorisations de connexion de service au hub iot.
provisioningState	ProvisioningState	État d’approvisionnement de la ressource.
tags	object	Balises de ressource
timestampPropertyName	string	Propriété de l’événement qui sera utilisée comme horodateur de la source de l’événement. Si aucune valeur n’est spécifiée pour timestampPropertyName, ou si la valeur Null ou une chaîne vide est spécifiée, l’heure de création de l’événement sera utilisée.
type	string	Type de ressource

LocalTimestamp

Objet qui représente la propriété timestamp locale. Il contient le format de l’horodatage local qui doit être utilisé et les informations de décalage de fuseau horaire correspondantes. Si aucune valeur n’est spécifiée pour localTimestamp, ou si la valeur est null, l’horodatage local n’est pas entré avec les événements.

Nom	Type	Description
format	LocalTimestampFormat	Enum qui représente le format de la propriété timestamp locale qui doit être définie.
timeZoneOffset	TimeZoneOffset	Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded.

LocalTimestampFormat

Enum qui représente le format de la propriété timestamp locale qui doit être définie.

Nom	Type	Description
Embedded	string

ProvisioningState

État d’approvisionnement de la ressource.

Nom	Type	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

Objet qui représente les informations de décalage pour le format d’horodatage local spécifié. Ne doit pas être spécifié pour LocalTimestampFormat - Embedded.

Nom	Type	Description
propertyName	string	Propriété d’événement qui contiendra les informations de décalage pour calculer l’horodatage local. Lorsque localTimestampFormat est Iana, le nom de la propriété contient le nom de la colonne qui contient le nom du fuseau horaire IANA (par exemple, Americas/Los Angeles). Lorsque LocalTimestampFormat est Timespan, il contient le nom de la propriété qui contient des valeurs représentant le décalage (par exemple : P1D ou 1.00 :00 :00)

Partager via