Event Sources - List By Environment

參考

服務:: Time Series Insights

API 版本:: 2020-05-15

清單與訂用帳戶相關聯的所有可用事件來源，以及在指定的資源群組和環境內。

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

URI 參數

名稱	位於	必要	類型	Description
environmentName	path	True	string	與指定資源群組相關聯的時間序列深入解析環境名稱。
resourceGroupName	path	True	string	Azure 資源群組的名稱。
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

名稱	類型	Description
200 OK	EventSourceListResponse	成功傳回的環境。
Other Status Codes	CloudError	找不到 HTTP 404 () ：找不到訂用帳戶、資源群組或環境。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ListEventSourcesByEnvironment

範例要求

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

範例回覆

狀態碼:: 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"
        }
      }
    }
  ]
}

定義

名稱	Description
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
EventHubEventSourceResource	從 Azure EventHub 接收其數據的事件來源。
EventSourceListResponse	List EventSources 作業的回應。
IngressStartAtType	ingressStartAt 的類型，它可以是 “EarliestAvailable”、“EventSourceCreationTime”、“CustomEnqueuedTime”。
IoTHubEventSourceResource	從 Azure IoTHub 接收其數據的事件來源。
LocalTimestamp	物件，表示本機時間戳屬性。它包含需要使用的本機時間戳格式，以及對應的時區位移資訊。如果未為localTimestamp指定值，或如果為 null，則不會使用事件輸入本機時間戳。
LocalTimestampFormat	列舉，表示需要設定之本機時間戳屬性的格式。
ProvisioningState	資源的布建狀態。
TimeZoneOffset	物件，表示指定之本機時間戳格式的位移資訊。不應該針對 LocalTimestampFormat - Embedded 指定。

CloudError

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。

CloudErrorBody

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	描述錯誤狀況的錯誤碼，比 HTTP 狀態代碼更精確。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	例如，特定錯誤的目標 (，錯誤) 中的屬性名稱。

EventHubEventSourceResource

從 Azure EventHub 接收其數據的事件來源。

名稱	類型	Description
creationTime	string	資源建立的時間。
eventSourceResourceId	string	Azure Resource Manager 中事件來源的資源標識符。
id	string	資源標識碼
ingressStartAt.time	string	ISO8601具有秒有效位數的 UTC 日期時間 (毫秒是選擇性) ，指定要耗用事件的日期和時間。
ingressStartAt.type	IngressStartAtType	ingressStartAt 的類型，它可以是 “EarliestAvailable”、“EventSourceCreationTime”、“CustomEnqueuedTime”。
kind	string: Microsoft.EventHub	事件來源的類型。
localTimestamp	LocalTimestamp	物件，表示本機時間戳屬性。它包含需要使用的本機時間戳格式，以及對應的時區位移資訊。如果未為localTimestamp指定值，或如果為 null，則不會使用事件輸入本機時間戳。
location	string	資源位置
name	string	資源名稱
properties.consumerGroupName	string	事件中樞取用者群組的名稱，該群組會保存要從中讀取事件的分割區。
properties.eventHubName	string	事件中樞的名稱。
properties.keyName	string	授與事件中樞時間序列深入解析服務存取權的SAS 金鑰名稱。此金鑰的共用存取原則必須將「接聽」許可權授與事件中樞。
properties.serviceBusNamespace	string	包含事件中樞的服務總線名稱。
provisioningState	ProvisioningState	資源的布建狀態。
tags	object	資源標籤
timestampPropertyName	string	將用來作為事件來源時間戳記的事件屬性。如果沒有為 timestampPropertyName 指定值，或如果指定的是空值或空字串，將會使用事件建立時間。
type	string	資源類型

EventSourceListResponse

List EventSources 作業的回應。

名稱	類型	Description
value	EventSourceResource[]: EventHubEventSourceResource[] IoTHubEventSourceResource[]	列出 EventSources 作業的結果。

IngressStartAtType

ingressStartAt 的類型，它可以是 “EarliestAvailable”、“EventSourceCreationTime”、“CustomEnqueuedTime”。

名稱	類型	Description
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

從 Azure IoTHub 接收其數據的事件來源。

名稱	類型	Description
creationTime	string	資源建立的時間。
eventSourceResourceId	string	Azure Resource Manager 中事件來源的資源標識符。
id	string	資源標識碼
ingressStartAt.time	string	ISO8601具有秒有效位數的 UTC 日期時間 (毫秒是選擇性) ，指定要耗用事件的日期和時間。
ingressStartAt.type	IngressStartAtType	ingressStartAt 的類型，它可以是 “EarliestAvailable”、“EventSourceCreationTime”、“CustomEnqueuedTime”。
kind	string: Microsoft.IoTHub	事件來源的類型。
localTimestamp	LocalTimestamp	物件，表示本機時間戳屬性。它包含需要使用的本機時間戳格式，以及對應的時區位移資訊。如果未為localTimestamp指定值，或如果為 null，則不會使用事件輸入本機時間戳。
location	string	資源位置
name	string	資源名稱
properties.consumerGroupName	string	iot 中樞取用者群組的名稱，該群組會保存要從中讀取事件的分割區。
properties.iotHubName	string	iot 中樞的名稱。
properties.keyName	string	授與 iot 中樞之時間序列深入解析服務存取權的共用存取原則密鑰名稱。此共用存取原則密鑰必須將「服務連線」許可權授與 iot 中樞。
provisioningState	ProvisioningState	資源的布建狀態。
tags	object	資源標籤
timestampPropertyName	string	將用來作為事件來源時間戳記的事件屬性。如果沒有為 timestampPropertyName 指定值，或如果指定的是空值或空字串，將會使用事件建立時間。
type	string	資源類型

LocalTimestamp

物件，表示本機時間戳屬性。它包含需要使用的本機時間戳格式，以及對應的時區位移資訊。如果未為localTimestamp指定值，或如果為 null，則不會使用事件輸入本機時間戳。

名稱	類型	Description
format	LocalTimestampFormat	列舉，表示需要設定之本機時間戳屬性的格式。
timeZoneOffset	TimeZoneOffset	物件，表示指定之本機時間戳格式的位移資訊。不應該針對 LocalTimestampFormat - Embedded 指定。

LocalTimestampFormat

列舉，表示需要設定之本機時間戳屬性的格式。

名稱	類型	Description
Embedded	string

ProvisioningState

資源的布建狀態。

名稱	類型	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

物件，表示指定之本機時間戳格式的位移資訊。不應該針對 LocalTimestampFormat - Embedded 指定。

名稱	類型	Description
propertyName	string	將包含要計算本機時間戳之位移資訊的事件屬性。當 LocalTimestampFormat 為 Iana 時，屬性名稱將包含 IANA 時區名稱的資料行名稱 (，例如：Americas/Los Angeles) 。當 LocalTimestampFormat 為 Timespan 時，它包含屬性的名稱，其中包含代表位移的值 (，例如 P1D 或 1.00：00：00)

共用方式為