Event Sources - Update

Reference

Služba:: Time Series Insights

Verze rozhraní API:: 2020-05-15

Aktualizace zdroj události se zadaným názvem v zadaném předplatném, skupině prostředků a prostředí.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
environmentName	path	True	string	Název prostředí Time Series Insights přidruženého k zadané skupině prostředků.
eventSourceName	path	True	string	Název zdroje událostí Time Series Insights přidruženého k zadanému prostředí.
resourceGroupName	path	True	string	Název skupiny prostředků Azure.
subscriptionId	path	True	string	ID předplatného Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Text žádosti může tvořit:

Name	Description
EventHubEventSourceUpdateParameters	Parametry zadané operaci Update Event Source (Aktualizovat zdroj událostí) za účelem aktualizace zdroje událostí EventHubu
IoTHubEventSourceUpdateParameters	Parametry zadané do operace Aktualizace zdroje událostí za účelem aktualizace zdroje událostí IoTHubu

EventHubEventSourceUpdateParameters

Parametry zadané operaci Update Event Source (Aktualizovat zdroj událostí) za účelem aktualizace zdroje událostí EventHubu

Name	Vyžadováno	Typ	Description
kind	True	string: Microsoft.EventHub	Druh zdroje událostí.
properties.sharedAccessKey		string	Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k centru událostí. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.
properties.timestampPropertyName		string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
tags		object	Páry klíč-hodnota dalších vlastností zdroje událostí.

IoTHubEventSourceUpdateParameters

Parametry zadané do operace Aktualizace zdroje událostí za účelem aktualizace zdroje událostí IoTHubu

Name	Vyžadováno	Typ	Description
kind	True	string: Microsoft.IoTHub	Druh zdroje událostí.
properties.sharedAccessKey		string	Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k ioT Hubu. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.
properties.timestampPropertyName		string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
tags		object	Páry klíč-hodnota dalších vlastností zdroje událostí.

Odpovědi

Name	Typ	Description
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	Definice zdroje událostí se úspěšně aktualizovala a je v odpovědi.
Other Status Codes	CloudError	HTTP 404 (Nenalezena): Nepodařilo se najít předplatné, skupinu prostředků, prostředí nebo zdroj událostí.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

UpdateEventSource

Ukázkový požadavek

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

{
  "tags": {
    "someKey": "someValue"
  }
}

import com.azure.resourcemanager.timeseriesinsights.models.EventSourceUpdateParameters;
import java.util.HashMap;
import java.util.Map;

/** Samples for EventSources Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json
     */
    /**
     * Sample code: UpdateEventSource.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void updateEventSource(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager
            .eventSources()
            .updateWithResponse(
                "rg1",
                "env1",
                "es1",
                new EventSourceUpdateParameters().withTags(mapOf("someKey", "someValue")),
                com.azure.core.util.Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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/azcore/to"
	"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/EventSourcesPatchTags.json
func ExampleEventSourcesClient_Update() {
	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().Update(ctx, "rg1", "env1", "es1", &armtimeseriesinsights.EventSourceUpdateParameters{
		Tags: map[string]*string{
			"someKey": to.Ptr("someValue"),
		},
	}, 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 = armtimeseriesinsights.EventSourcesClientUpdateResponse{
	// 	                            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{
	// 			"someKey": to.Ptr("someValue"),
	// 		},
	// 		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"),
	// 				},
	// 			},
	// 			TimestampPropertyName: to.Ptr("someOtherTimestampProperty"),
	// 			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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
EventHubEventSourceResource	Zdroj událostí, který přijímá data z Azure EventHubu.
EventHubEventSourceUpdateParameters	Parametry zadané operaci Update Event Source (Aktualizovat zdroj událostí) za účelem aktualizace zdroje událostí EventHubu
IngressStartAtType	Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
IoTHubEventSourceResource	Zdroj událostí, který přijímá data z Azure IoTHubu.
IoTHubEventSourceUpdateParameters	Parametry zadané do operace Aktualizace zdroje událostí za účelem aktualizace zdroje událostí IoTHubu
LocalTimestamp	Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.
LocalTimestampFormat	Výčet, který představuje formát vlastnosti místního časového razítka, která je třeba nastavit.
ProvisioningState	Stav zřizování prostředku.
TimeZoneOffset	Objekt, který představuje informace o posunu pro zadaný formát místního časového razítka. Parametr LocalTimestampFormat – Embedded by neměl být zadán.

CloudError

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

EventHubEventSourceResource

Zdroj událostí, který přijímá data z Azure EventHubu.

Name	Typ	Description
creationTime	string	Čas vytvoření prostředku.
eventSourceResourceId	string	ID prostředku zdroje události v Azure Resource Manager.
id	string	ID prostředku
ingressStartAt.time	string	ISO8601 datum a čas UTC s přesností na sekundy (milisekundy jsou volitelné) a zadejte datum a čas, které budou výchozím bodem pro příjem událostí.
ingressStartAt.type	IngressStartAtType	Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.EventHub	Druh zdroje událostí.
localTimestamp	LocalTimestamp	Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.
location	string	Umístění prostředku
name	string	Název prostředku
properties.consumerGroupName	string	Název skupiny příjemců centra událostí, která obsahuje oddíly, ze kterých se budou události číst.
properties.eventHubName	string	Název centra událostí.
properties.keyName	string	Název klíče SAS, který uděluje službě Time Series Insights přístup k centru událostí. Zásady sdíleného přístupu pro tento klíč musí centru událostí udělit oprávnění Naslouchat.
properties.serviceBusNamespace	string	Název služby Service Bus, která obsahuje centrum událostí.
provisioningState	ProvisioningState	Stav zřizování prostředku.
tags	object	Značky prostředků
timestampPropertyName	string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
type	string	Typ prostředku

EventHubEventSourceUpdateParameters

Parametry zadané operaci Update Event Source (Aktualizovat zdroj událostí) za účelem aktualizace zdroje událostí EventHubu

Name	Typ	Description
kind	string: Microsoft.EventHub	Druh zdroje událostí.
properties.sharedAccessKey	string	Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k centru událostí. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.
properties.timestampPropertyName	string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
tags	object	Páry klíč-hodnota dalších vlastností zdroje událostí.

IngressStartAtType

Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".

Name	Typ	Description
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Zdroj událostí, který přijímá data z Azure IoTHubu.

Name	Typ	Description
creationTime	string	Čas vytvoření prostředku.
eventSourceResourceId	string	ID prostředku zdroje události v Azure Resource Manager.
id	string	ID prostředku
ingressStartAt.time	string	ISO8601 datum a čas UTC s přesností na sekundy (milisekundy jsou volitelné) a zadejte datum a čas, které budou výchozím bodem pro příjem událostí.
ingressStartAt.type	IngressStartAtType	Typ ingressStartAt, může to být "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".
kind	string: Microsoft.IoTHub	Druh zdroje událostí.
localTimestamp	LocalTimestamp	Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.
location	string	Umístění prostředku
name	string	Název prostředku
properties.consumerGroupName	string	Název skupiny uživatelů ioT Hubu, která obsahuje oddíly, ze kterých se budou číst události.
properties.iotHubName	string	Název ioT Hubu.
properties.keyName	string	Název klíče zásad sdíleného přístupu, který uděluje službě Time Series Insights přístup k ioT Hubu. Tento klíč zásad sdíleného přístupu musí službě ioT Hub udělit oprávnění service connect.
provisioningState	ProvisioningState	Stav zřizování prostředku.
tags	object	Značky prostředků
timestampPropertyName	string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
type	string	Typ prostředku

IoTHubEventSourceUpdateParameters

Parametry zadané do operace Aktualizace zdroje událostí za účelem aktualizace zdroje událostí IoTHubu

Name	Typ	Description
kind	string: Microsoft.IoTHub	Druh zdroje událostí.
properties.sharedAccessKey	string	Hodnota sdíleného přístupového klíče, který uděluje službě Time Series Insights přístup ke čtení k ioT Hubu. Tato vlastnost se nezobrazuje v odpovědích na zdroj událostí.
properties.timestampPropertyName	string	Vlastnost události, která se použije jako časové razítko zdroje události. Pokud není pro timestampPropertyName zadána hodnota nebo pokud je zadána hodnota null nebo prázdný řetězec, použije se čas vytvoření události.
tags	object	Páry klíč-hodnota dalších vlastností zdroje událostí.

LocalTimestamp

Objekt, který představuje místní vlastnost časového razítka. Obsahuje formát místního časového razítka, které je potřeba použít, a odpovídající informace o posunu časového pásma. Pokud hodnota není zadaná pro localTimestamp nebo pokud null, místní časové razítko nebude ingressováno s událostmi.

Name	Typ	Description
format	LocalTimestampFormat	Výčet, který představuje formát vlastnosti místního časového razítka, která je třeba nastavit.
timeZoneOffset	TimeZoneOffset	Objekt, který představuje informace o posunu pro zadaný formát místního časového razítka. Parametr LocalTimestampFormat – Embedded by neměl být zadán.

LocalTimestampFormat

Výčet, který představuje formát vlastnosti místního časového razítka, která je třeba nastavit.

Name	Typ	Description
Embedded	string

ProvisioningState

Stav zřizování prostředku.

Name	Typ	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

Objekt, který představuje informace o posunu pro zadaný formát místního časového razítka. Parametr LocalTimestampFormat – Embedded by neměl být zadán.

Name	Typ	Description
propertyName	string	Vlastnost události, která bude obsahovat informace o posunu pro výpočet místního časového razítka. Pokud je LocalTimestampFormat Iana, bude název vlastnosti obsahovat název sloupce, který obsahuje název IANA Timezone Name (např: Americas/Los Angeles). Když localTimestampFormat je Časový rozsah, obsahuje název vlastnosti, která obsahuje hodnoty představující posun (např. P1D nebo 1.00:00:00).

Sdílet prostřednictvím

Event Sources - Update

Parametry identifikátoru URI

Text požadavku

EventHubEventSourceUpdateParameters

IoTHubEventSourceUpdateParameters

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

UpdateEventSource

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

EventHubEventSourceResource

EventHubEventSourceUpdateParameters

IngressStartAtType

IoTHubEventSourceResource

IoTHubEventSourceUpdateParameters

LocalTimestamp

LocalTimestampFormat

ProvisioningState

TimeZoneOffset

Další materiály