Event Sources - Update

Başvuru

Service:: Time Series Insights

API Version:: 2020-05-15

Olay kaynağını belirtilen abonelikte, kaynak grubunda ve ortamda belirtilen adla Güncelleştirmeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
environmentName	path	True	string	Belirtilen kaynak grubuyla ilişkili Time Series Insights ortamının adı.
eventSourceName	path	True	string	Belirtilen ortamla ilişkili Time Series Insights olay kaynağının adı.
resourceGroupName	path	True	string	Azure Kaynak grubunun adı.
subscriptionId	path	True	string	Azure Abonelik Kimliği.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü.

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name	Description
EventHubEventSourceUpdateParameters	EventHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.
IoTHubEventSourceUpdateParameters	Bir IoTHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.

EventHubEventSourceUpdateParameters

EventHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.

Name	Gerekli	Tür	Description
kind	True	string: Microsoft.EventHub	Olay kaynağının türü.
properties.sharedAccessKey		string	Time Series Insights hizmetine olay hub'ına okuma erişimi veren paylaşılan erişim anahtarının değeri. Bu özellik olay kaynağı yanıtlarında gösterilmez.
properties.timestampPropertyName		string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
tags		object	Olay kaynağı için ek özelliklerin anahtar-değer çiftleri.

IoTHubEventSourceUpdateParameters

Bir IoTHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.

Name	Gerekli	Tür	Description
kind	True	string: Microsoft.IoTHub	Olay kaynağının türü.
properties.sharedAccessKey		string	Time Series Insights hizmetine iot hub'ına okuma erişimi veren paylaşılan erişim anahtarının değeri. Bu özellik olay kaynağı yanıtlarında gösterilmez.
properties.timestampPropertyName		string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
tags		object	Olay kaynağı için ek özelliklerin anahtar-değer çiftleri.

Yanıtlar

Name	Tür	Description
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	Olay kaynağı tanımı başarıyla güncelleştirildi ve yanıtta.
Other Status Codes	CloudError	HTTP 404 (Bulunamadı): Abonelik, kaynak grubu, ortam veya olay kaynağı bulunamadı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

UpdateEventSource

Sample Request

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

Sample Response

Status code:: 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"
    }
  }
}

Tanımlar

Name	Description
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
EventHubEventSourceResource	Azure EventHub'dan verilerini alan bir olay kaynağı.
EventHubEventSourceUpdateParameters	EventHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.
IngressStartAtType	ingressStartAt türü, "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" olabilir.
IoTHubEventSourceResource	Azure IoTHub'dan verilerini alan olay kaynağı.
IoTHubEventSourceUpdateParameters	Bir IoTHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.
LocalTimestamp	Yerel zaman damgası özelliğini temsil eden bir nesne. Kullanılması gereken yerel zaman damgasının biçimini ve buna karşılık gelen saat dilimi uzaklığı bilgilerini içerir. localTimestamp için bir değer belirtilmezse veya null ise, yerel zaman damgası olaylarla girilmez.
LocalTimestampFormat	Ayarlanması gereken yerel zaman damgası özelliğinin biçimini temsil eden bir sabit listesi.
ProvisioningState	Kaynağın sağlama durumu.
TimeZoneOffset	Belirtilen yerel zaman damgası biçimi için uzaklık bilgilerini temsil eden bir nesne. LocalTimestampFormat - Embedded için belirtilmemelidir.

CloudError

API hatası hakkında bilgi içerir.

Name	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

CloudErrorBody

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Name	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).

EventHubEventSourceResource

Azure EventHub'dan verilerini alan bir olay kaynağı.

Name	Tür	Description
creationTime	string	Kaynağın oluşturulduğu saat.
eventSourceResourceId	string	Azure Resource Manager olay kaynağının kaynak kimliği.
id	string	Kaynak Kimliği
ingressStartAt.time	string	Utc tarih saatine saniye duyarlığıyla ISO8601 (milisaniyeler isteğe bağlıdır), olayların tüketileceği başlangıç noktası olacak tarih ve saati belirtin.
ingressStartAt.type	IngressStartAtType	ingressStartAt türü, "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" olabilir.
kind	string: Microsoft.EventHub	Olay kaynağının türü.
localTimestamp	LocalTimestamp	Yerel zaman damgası özelliğini temsil eden bir nesne. Kullanılması gereken yerel zaman damgasının biçimini ve buna karşılık gelen saat dilimi uzaklığı bilgilerini içerir. localTimestamp için bir değer belirtilmezse veya null ise, yerel zaman damgası olaylarla girilmez.
location	string	Kaynak konumu
name	string	Kaynak adı
properties.consumerGroupName	string	Olayların okunacağı bölümleri tutan olay hub'ının tüketici grubunun adı.
properties.eventHubName	string	Olay hub'ının adı.
properties.keyName	string	Olay hub'ına Time Series Insights hizmeti erişimi veren SAS anahtarının adı. Bu anahtarın paylaşılan erişim ilkeleri olay hub'ına 'Dinleme' izinleri vermelidir.
properties.serviceBusNamespace	string	Olay hub'ını içeren hizmet veri yolunun adı.
provisioningState	ProvisioningState	Kaynağın sağlama durumu.
tags	object	Kaynak etiketleri
timestampPropertyName	string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
type	string	Kaynak türü

EventHubEventSourceUpdateParameters

EventHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.

Name	Tür	Description
kind	string: Microsoft.EventHub	Olay kaynağının türü.
properties.sharedAccessKey	string	Time Series Insights hizmetine olay hub'ına okuma erişimi veren paylaşılan erişim anahtarının değeri. Bu özellik olay kaynağı yanıtlarında gösterilmez.
properties.timestampPropertyName	string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
tags	object	Olay kaynağı için ek özelliklerin anahtar-değer çiftleri.

IngressStartAtType

ingressStartAt türü, "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" olabilir.

Name	Tür	Description
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Azure IoTHub'dan verilerini alan olay kaynağı.

Name	Tür	Description
creationTime	string	Kaynağın oluşturulduğu saat.
eventSourceResourceId	string	Azure Resource Manager olay kaynağının kaynak kimliği.
id	string	Kaynak Kimliği
ingressStartAt.time	string	Utc tarih saatine saniye duyarlığıyla ISO8601 (milisaniyeler isteğe bağlıdır), olayların tüketileceği başlangıç noktası olacak tarih ve saati belirtin.
ingressStartAt.type	IngressStartAtType	ingressStartAt türü, "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime" olabilir.
kind	string: Microsoft.IoTHub	Olay kaynağının türü.
localTimestamp	LocalTimestamp	Yerel zaman damgası özelliğini temsil eden bir nesne. Kullanılması gereken yerel zaman damgasının biçimini ve buna karşılık gelen saat dilimi uzaklığı bilgilerini içerir. localTimestamp için bir değer belirtilmezse veya null ise, yerel zaman damgası olaylarla girilmez.
location	string	Kaynak konumu
name	string	Kaynak adı
properties.consumerGroupName	string	Olayların okunacağı bölümleri tutan iot hub'ının tüketici grubunun adı.
properties.iotHubName	string	IoT hub'ının adı.
properties.keyName	string	Time Series Insights hizmetine iot hub'ına erişim veren Paylaşılan Erişim İlkesi anahtarının adı. Bu paylaşılan erişim ilkesi anahtarı, iot hub'ına 'hizmet bağlantısı' izinleri vermelidir.
provisioningState	ProvisioningState	Kaynağın sağlama durumu.
tags	object	Kaynak etiketleri
timestampPropertyName	string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
type	string	Kaynak türü

IoTHubEventSourceUpdateParameters

Bir IoTHub olay kaynağını güncelleştirmek için Olay Kaynağını Güncelleştir işlemine sağlanan parametreler.

Name	Tür	Description
kind	string: Microsoft.IoTHub	Olay kaynağının türü.
properties.sharedAccessKey	string	Time Series Insights hizmetine iot hub'ına okuma erişimi veren paylaşılan erişim anahtarının değeri. Bu özellik olay kaynağı yanıtlarında gösterilmez.
properties.timestampPropertyName	string	Olay kaynağının zaman damgası olarak kullanılacak olay özelliği. timestampPropertyName için bir değer belirtilmezse veya null veya empty-string belirtilirse, olay oluşturma zamanı kullanılır.
tags	object	Olay kaynağı için ek özelliklerin anahtar-değer çiftleri.

LocalTimestamp

Yerel zaman damgası özelliğini temsil eden bir nesne. Kullanılması gereken yerel zaman damgasının biçimini ve buna karşılık gelen saat dilimi uzaklığı bilgilerini içerir. localTimestamp için bir değer belirtilmezse veya null ise, yerel zaman damgası olaylarla girilmez.

Name	Tür	Description
format	LocalTimestampFormat	Ayarlanması gereken yerel zaman damgası özelliğinin biçimini temsil eden bir sabit listesi.
timeZoneOffset	TimeZoneOffset	Belirtilen yerel zaman damgası biçimi için uzaklık bilgilerini temsil eden bir nesne. LocalTimestampFormat - Embedded için belirtilmemelidir.

LocalTimestampFormat

Ayarlanması gereken yerel zaman damgası özelliğinin biçimini temsil eden bir sabit listesi.

Name	Tür	Description
Embedded	string

ProvisioningState

Kaynağın sağlama durumu.

Name	Tür	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

Belirtilen yerel zaman damgası biçimi için uzaklık bilgilerini temsil eden bir nesne. LocalTimestampFormat - Embedded için belirtilmemelidir.

Name	Tür	Description
propertyName	string	Yerel zaman damgasını hesaplamak için uzaklık bilgilerini içerecek olay özelliği. LocalTimestampFormat Iana olduğunda, özellik adı IANA Saat Dilimi Adı 'nı içeren sütunun adını içerir (örneğin: Americas/Los Angeles). LocalTimestampFormat Timespan olduğunda, uzaklığı temsil eden değerleri içeren özelliğin adını içerir (örneğin: P1D veya 1.00:00:00)

Aracılığıyla paylaş

Event Sources - Update

URI Parametreleri

İstek Gövdesi

EventHubEventSourceUpdateParameters

IoTHubEventSourceUpdateParameters

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

UpdateEventSource

Sample Request

Sample Response

Tanımlar

CloudError

CloudErrorBody

EventHubEventSourceResource

EventHubEventSourceUpdateParameters

IngressStartAtType

IoTHubEventSourceResource

IoTHubEventSourceUpdateParameters

LocalTimestamp

LocalTimestampFormat

ProvisioningState

TimeZoneOffset

Ek kaynaklar