Event Sources - Get

참조

Service:: Time Series Insights

API Version:: 2020-05-15

지정된 환경에서 지정된 이름의 이벤트 원본을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
environmentName	path	True	string	지정된 리소스 그룹과 연결된 Time Series Insights 환경의 이름입니다.
eventSourceName	path	True	string	지정된 환경과 연결된 Time Series Insights 이벤트 원본의 이름입니다.
resourceGroupName	path	True	string	Azure 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Azure 구독 ID입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name	형식	Description
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	이벤트 원본 정의가 성공적으로 검색되었으며 응답에 있습니다.
Other Status Codes	CloudError	HTTP 404(찾을 수 없음): 구독, 리소스 그룹, 환경 또는 이벤트 원본을 찾을 수 없습니다.

보안

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	사용자 계정 가장

예제

GetEventHubEventSource

Sample Request

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

/** Samples for EventSources Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json
     */
    /**
     * Sample code: GetEventHubEventSource.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void getEventHubEventSource(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.eventSources().getWithResponse("rg1", "env1", "es1", 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/EventSourcesGetEventHub.json
func ExampleEventSourcesClient_Get() {
	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().Get(ctx, "rg1", "env1", "es1", 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.EventSourcesClientGetResponse{
	// 	                            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

{
  "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"
    }
  }
}

정의

Name	Description
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.
EventHubEventSourceResource	Azure EventHub에서 해당 데이터를 수신하는 이벤트 원본입니다.
IngressStartAtType	ingressStartAt의 형식으로 , "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime"일 수 있습니다.
IoTHubEventSourceResource	Azure IoTHub에서 해당 데이터를 수신하는 이벤트 원본입니다.
LocalTimestamp	로컬 타임스탬프 속성을 나타내는 개체입니다. 여기에는 사용해야 하는 로컬 타임스탬프 형식과 해당 표준 시간대 오프셋 정보가 포함됩니다. 값이 localTimestamp에 지정되지 않았거나 null이면 로컬 타임스탬프가 이벤트로 수신되지 않습니다.
LocalTimestampFormat	설정해야 하는 로컬 타임스탬프 속성의 형식을 나타내는 열거형입니다.
ProvisioningState	리소스의 프로비전 상태입니다.
TimeZoneOffset	지정된 로컬 타임스탬프 형식의 오프셋 정보를 나타내는 개체입니다. LocalTimestampFormat - Embedded에 대해 지정해서는 안 됩니다.

CloudError

API 오류에 대한 정보를 포함합니다.

Name	형식	Description
error	CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류에 대해 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 더 정확하게 오류 조건을 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상(예: 오류에 있는 속성의 이름)입니다.

EventHubEventSourceResource

Azure EventHub에서 해당 데이터를 수신하는 이벤트 원본입니다.

Name	형식	Description
creationTime	string	리소스를 만든 시간입니다.
eventSourceResourceId	string	Azure Resource Manager 이벤트 원본의 리소스 ID입니다.
id	string	리소스 ID
ingressStartAt.time	string	UTC 날짜/시간을 초 정밀도(밀리초는 선택 사항)로 ISO8601 사용할 이벤트의 시작점이 될 날짜와 시간을 지정합니다.
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	이벤트 허브에 대한 Time Series Insights 서비스 액세스 권한을 부여하는 SAS 키의 이름입니다. 이 키에 대한 공유 액세스 정책은 이벤트 허브에 '수신 대기' 권한을 부여해야 합니다.
properties.serviceBusNamespace	string	이벤트 허브를 포함하는 서비스 버스의 이름입니다.
provisioningState	ProvisioningState	리소스의 프로비전 상태입니다.
tags	object	리소스 태그
timestampPropertyName	string	이벤트 원본의 타임스탬프로 사용될 이벤트 속성입니다. timestampPropertyName에 대한 값을 지정하지 않은 경우 또는 null 또는 빈 문자열을 지정하는 경우 이벤트 생성 시간이 사용됩니다.
type	string	리소스 유형

IngressStartAtType

ingressStartAt의 형식으로 , "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime"일 수 있습니다.

Name	형식	Description
CustomEnqueuedTime	string
EarliestAvailable	string
EventSourceCreationTime	string

IoTHubEventSourceResource

Azure IoTHub에서 해당 데이터를 수신하는 이벤트 원본입니다.

Name	형식	Description
creationTime	string	리소스를 만든 시간입니다.
eventSourceResourceId	string	Azure Resource Manager 이벤트 원본의 리소스 ID입니다.
id	string	리소스 ID
ingressStartAt.time	string	UTC 날짜/시간을 초 정밀도(밀리초는 선택 사항)로 ISO8601 사용할 이벤트의 시작점이 될 날짜와 시간을 지정합니다.
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	Time Series Insights 서비스에 iot 허브에 대한 액세스 권한을 부여하는 공유 액세스 정책 키의 이름입니다. 이 공유 액세스 정책 키는 iot 허브에 '서비스 연결' 권한을 부여해야 합니다.
provisioningState	ProvisioningState	리소스의 프로비전 상태입니다.
tags	object	리소스 태그
timestampPropertyName	string	이벤트 원본의 타임스탬프로 사용될 이벤트 속성입니다. timestampPropertyName에 대한 값을 지정하지 않은 경우 또는 null 또는 빈 문자열을 지정하는 경우 이벤트 생성 시간이 사용됩니다.
type	string	리소스 유형

LocalTimestamp

로컬 타임스탬프 속성을 나타내는 개체입니다. 여기에는 사용해야 하는 로컬 타임스탬프 형식과 해당 표준 시간대 오프셋 정보가 포함됩니다. 값이 localTimestamp에 지정되지 않았거나 null이면 로컬 타임스탬프가 이벤트로 수신되지 않습니다.

Name	형식	Description
format	LocalTimestampFormat	설정해야 하는 로컬 타임스탬프 속성의 형식을 나타내는 열거형입니다.
timeZoneOffset	TimeZoneOffset	지정된 로컬 타임스탬프 형식의 오프셋 정보를 나타내는 개체입니다. LocalTimestampFormat - Embedded에 대해 지정해서는 안 됩니다.

LocalTimestampFormat

설정해야 하는 로컬 타임스탬프 속성의 형식을 나타내는 열거형입니다.

Name	형식	Description
Embedded	string

ProvisioningState

리소스의 프로비전 상태입니다.

Name	형식	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TimeZoneOffset

지정된 로컬 타임스탬프 형식의 오프셋 정보를 나타내는 개체입니다. LocalTimestampFormat - Embedded에 대해 지정해서는 안 됩니다.

Name	형식	Description
propertyName	string	로컬 타임스탬프를 계산하는 오프셋 정보를 포함할 이벤트 속성입니다. LocalTimestampFormat이 Iana인 경우 속성 이름에는 IANA 표준 시간대 이름(예: 미주/로스앤젤레스)이 포함된 열의 이름이 포함됩니다. LocalTimestampFormat이 Timespan인 경우 오프셋을 나타내는 값이 포함된 속성의 이름이 포함됩니다(예: P1D 또는 1.00:00:00).