Inputs - Get

リファレンス

サービス:: Stream Analytics

API バージョン:: 2020-03-01

指定した入力に関する詳細を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}?api-version=2020-03-01

URI パラメーター

名前	/	必須	型	説明
inputName	path	True	string	入力の名前。
jobName	path	True	string	ストリーミングジョブの名前。
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。正規表現パターン: `^[-\w\._]+$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Input	指定した入力を正常に取得しました。ヘッダー ETag: string
Other Status Codes	Error	エラー。

名前

型

説明

200 OK

Input

指定した入力を正常に取得しました。

ヘッダー

ETag: string

Other Status Codes

Error

エラー。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Get a reference blob input with CSV serialization

Get a stream blob input with CSV serialization

Get a stream Event Hub input with JSON serialization

Get a stream IoT Hub input with Avro serialization

Get a reference blob input with CSV serialization

要求のサンプル

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225?api-version=2020-03-01

import com.azure.core.util.Context;

/** Samples for Inputs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json
     */
    /**
     * Sample code: Get a reference blob input with CSV serialization.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void getAReferenceBlobInputWithCSVSerialization(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().getWithResponse("sjrg8440", "sj9597", "input7225", 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 armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json
func ExampleInputsClient_Get_getAReferenceBlobInputWithCsvSerialization() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInputsClient().Get(ctx, "sjrg8440", "sj9597", "input7225", 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.Input = armstreamanalytics.Input{
	// 	Name: to.Ptr("input7225"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225"),
	// 	Properties: &armstreamanalytics.ReferenceInputProperties{
	// 		Type: to.Ptr("Reference"),
	// 		Serialization: &armstreamanalytics.CSVSerialization{
	// 			Type: to.Ptr(armstreamanalytics.EventSerializationTypeCSV),
	// 			Properties: &armstreamanalytics.CSVSerializationProperties{
	// 				Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
	// 				FieldDelimiter: to.Ptr(","),
	// 			},
	// 		},
	// 		Datasource: &armstreamanalytics.BlobReferenceInputDataSource{
	// 			Type: to.Ptr("Microsoft.Storage/Blob"),
	// 			Properties: &armstreamanalytics.BlobReferenceInputDataSourceProperties{
	// 				Container: to.Ptr("state"),
	// 				DateFormat: to.Ptr("yyyy/MM/dd"),
	// 				PathPattern: to.Ptr("{date}/{time}"),
	// 				StorageAccounts: []*armstreamanalytics.StorageAccount{
	// 					{
	// 						AccountName: to.Ptr("someAccountName"),
	// 				}},
	// 				TimeFormat: to.Ptr("HH"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets details about the specified input.
 *
 * @summary Gets details about the specified input.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json
 */
async function getAReferenceBlobInputWithCsvSerialization() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg8440";
  const jobName = "sj9597";
  const inputName = "input7225";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.inputs.get(resourceGroupName, jobName, inputName);
  console.log(result);
}

getAReferenceBlobInputWithCsvSerialization().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

ETag: c987701d-4039-47aa-a115-ad84f67d07c5

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225",
  "name": "input7225",
  "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
  "properties": {
    "type": "Reference",
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "storageAccounts": [
          {
            "accountName": "someAccountName"
          }
        ],
        "container": "state",
        "pathPattern": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}

Get a stream blob input with CSV serialization

要求のサンプル

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899?api-version=2020-03-01

import com.azure.core.util.Context;

/** Samples for Inputs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json
     */
    /**
     * Sample code: Get a stream blob input with CSV serialization.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void getAStreamBlobInputWithCSVSerialization(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().getWithResponse("sjrg8161", "sj6695", "input8899", 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 armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json
func ExampleInputsClient_Get_getAStreamBlobInputWithCsvSerialization() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInputsClient().Get(ctx, "sjrg8161", "sj6695", "input8899", 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.Input = armstreamanalytics.Input{
	// 	Name: to.Ptr("input8899"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899"),
	// 	Properties: &armstreamanalytics.StreamInputProperties{
	// 		Type: to.Ptr("Stream"),
	// 		Serialization: &armstreamanalytics.CSVSerialization{
	// 			Type: to.Ptr(armstreamanalytics.EventSerializationTypeCSV),
	// 			Properties: &armstreamanalytics.CSVSerializationProperties{
	// 				Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
	// 				FieldDelimiter: to.Ptr(","),
	// 			},
	// 		},
	// 		Datasource: &armstreamanalytics.BlobStreamInputDataSource{
	// 			Type: to.Ptr("Microsoft.Storage/Blob"),
	// 			Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
	// 				Container: to.Ptr("state"),
	// 				DateFormat: to.Ptr("yyyy/MM/dd"),
	// 				PathPattern: to.Ptr("{date}/{time}"),
	// 				StorageAccounts: []*armstreamanalytics.StorageAccount{
	// 					{
	// 						AccountName: to.Ptr("someAccountName"),
	// 				}},
	// 				TimeFormat: to.Ptr("HH"),
	// 				SourcePartitionCount: to.Ptr[int32](16),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets details about the specified input.
 *
 * @summary Gets details about the specified input.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json
 */
async function getAStreamBlobInputWithCsvSerialization() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg8161";
  const jobName = "sj6695";
  const inputName = "input8899";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.inputs.get(resourceGroupName, jobName, inputName);
  console.log(result);
}

getAStreamBlobInputWithCsvSerialization().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

ETag: 475074b8-c957-4b1f-a219-12b8399c3d4c

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899",
  "name": "input8899",
  "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
  "properties": {
    "type": "Stream",
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "sourcePartitionCount": 16,
        "storageAccounts": [
          {
            "accountName": "someAccountName"
          }
        ],
        "container": "state",
        "pathPattern": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}

Get a stream Event Hub input with JSON serialization

要求のサンプル

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425?api-version=2020-03-01

import com.azure.core.util.Context;

/** Samples for Inputs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json
     */
    /**
     * Sample code: Get a stream Event Hub input with JSON serialization.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void getAStreamEventHubInputWithJSONSerialization(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().getWithResponse("sjrg3139", "sj197", "input7425", 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 armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json
func ExampleInputsClient_Get_getAStreamEventHubInputWithJsonSerialization() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInputsClient().Get(ctx, "sjrg3139", "sj197", "input7425", 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.Input = armstreamanalytics.Input{
	// 	Name: to.Ptr("input7425"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425"),
	// 	Properties: &armstreamanalytics.StreamInputProperties{
	// 		Type: to.Ptr("Stream"),
	// 		Serialization: &armstreamanalytics.JSONSerialization{
	// 			Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
	// 			Properties: &armstreamanalytics.JSONSerializationProperties{
	// 				Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
	// 			},
	// 		},
	// 		Datasource: &armstreamanalytics.EventHubStreamInputDataSource{
	// 			Type: to.Ptr("Microsoft.ServiceBus/EventHub"),
	// 			Properties: &armstreamanalytics.EventHubStreamInputDataSourceProperties{
	// 				ServiceBusNamespace: to.Ptr("sdktest"),
	// 				SharedAccessPolicyName: to.Ptr("RootManageSharedAccessKey"),
	// 				EventHubName: to.Ptr("sdkeventhub"),
	// 				ConsumerGroupName: to.Ptr("sdkconsumergroup"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets details about the specified input.
 *
 * @summary Gets details about the specified input.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json
 */
async function getAStreamEventHubInputWithJsonSerialization() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg3139";
  const jobName = "sj197";
  const inputName = "input7425";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.inputs.get(resourceGroupName, jobName, inputName);
  console.log(result);
}

getAStreamEventHubInputWithJsonSerialization().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

ETag: afd0d184-37e9-4370-9e55-32501bc4de3a

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425",
  "name": "input7425",
  "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
  "properties": {
    "type": "Stream",
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "eventHubName": "sdkeventhub",
        "consumerGroupName": "sdkconsumergroup",
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8"
      }
    }
  }
}

Get a stream IoT Hub input with Avro serialization

要求のサンプル

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970?api-version=2020-03-01

import com.azure.core.util.Context;

/** Samples for Inputs Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json
     */
    /**
     * Sample code: Get a stream IoT Hub input with Avro serialization.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void getAStreamIoTHubInputWithAvroSerialization(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().getWithResponse("sjrg3467", "sj9742", "input7970", 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 armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json
func ExampleInputsClient_Get_getAStreamIoTHubInputWithAvroSerialization() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInputsClient().Get(ctx, "sjrg3467", "sj9742", "input7970", 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.Input = armstreamanalytics.Input{
	// 	Name: to.Ptr("input7970"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970"),
	// 	Properties: &armstreamanalytics.StreamInputProperties{
	// 		Type: to.Ptr("Stream"),
	// 		Serialization: &armstreamanalytics.AvroSerialization{
	// 			Type: to.Ptr(armstreamanalytics.EventSerializationTypeAvro),
	// 			Properties: map[string]any{
	// 			},
	// 		},
	// 		Datasource: &armstreamanalytics.IoTHubStreamInputDataSource{
	// 			Type: to.Ptr("Microsoft.Devices/IotHubs"),
	// 			Properties: &armstreamanalytics.IoTHubStreamInputDataSourceProperties{
	// 				ConsumerGroupName: to.Ptr("sdkconsumergroup"),
	// 				Endpoint: to.Ptr("messages/events"),
	// 				IotHubNamespace: to.Ptr("iothub"),
	// 				SharedAccessPolicyName: to.Ptr("owner"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets details about the specified input.
 *
 * @summary Gets details about the specified input.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json
 */
async function getAStreamIoTHubInputWithAvroSerialization() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg3467";
  const jobName = "sj9742";
  const inputName = "input7970";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.inputs.get(resourceGroupName, jobName, inputName);
  console.log(result);
}

getAStreamIoTHubInputWithAvroSerialization().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

ETag: bd8009b3-8165-4bd3-aad2-29a2b378dd14

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970",
  "name": "input7970",
  "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
  "properties": {
    "type": "Stream",
    "datasource": {
      "type": "Microsoft.Devices/IotHubs",
      "properties": {
        "iotHubNamespace": "iothub",
        "sharedAccessPolicyName": "owner",
        "endpoint": "messages/events",
        "consumerGroupName": "sdkconsumergroup"
      }
    },
    "serialization": {
      "type": "Avro",
      "properties": {}
    }
  }
}

定義

名前	説明
AuthenticationMode	認証モード。有効なモードは、 `ConnectionString`、 `Msi` および 'UserToken' です。
AvroSerialization	入力からのデータをシリアル化する方法、または Avro 形式で出力に書き込むときにデータをシリアル化する方法について説明します。
AzureSqlReferenceInputDataSource	Azure SQL データベース参照入力データソースについて説明します。
BlobReferenceInputDataSource	参照データを含む BLOB 入力データソースについて説明します。
BlobStreamInputDataSource	ストリームデータを含む BLOB 入力データソースについて説明します。
Compression	入力データの圧縮方法について説明します
CompressionType	入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必要です。
CsvSerialization	入力からのデータをシリアル化する方法、または CSV 形式で出力に書き込むときにデータをシリアル化する方法について説明します。
DiagnosticCondition	顧客の注意を必要とするリソースまたはジョブ全体に適用される条件。
Diagnostics	入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。
Encoding	入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。
Error	一般的なエラー表現。
EventHubStreamInputDataSource	ストリームデータを含む Event Hub 入力データソースについて説明します。
EventHubV2StreamInputDataSource	ストリームデータを含む Event Hub 入力データソースについて説明します。
EventSerializationType	入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。
FileReferenceInputDataSource	参照データを含むファイル入力データソースについて説明します。
GatewayMessageBusStreamInputDataSource	ストリームデータを含む BLOB 入力データソースについて説明します。
Input	名前付き入力に関連付けられているすべての情報を格納する入力オブジェクト。すべての入力はストリーミングジョブの下に含まれます。
IoTHubStreamInputDataSource	ストリームデータを含むIoT Hub入力データソースについて説明します。
JsonOutputSerializationFormat	出力が書き込まれる JSON の形式を指定します。現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトを使用して書式設定されることを示す 'lineSeparated' と、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' です。
JsonSerialization	入力からのデータをシリアル化する方法、または JSON 形式で出力に書き込むときにデータをシリアル化する方法について説明します。
ParquetSerialization	入力からのデータをシリアル化する方法、または Parquet 形式で出力に書き込むときにデータをシリアル化する方法について説明します。
ReferenceInputProperties	参照データを含む入力に関連付けられているプロパティ。
RefreshType	データ更新オプションの種類を示します。
StorageAccount	Azure Storage アカウントに関連付けられているプロパティ
StreamInputProperties	ストリームデータを含む入力に関連付けられているプロパティ。

AuthenticationMode

認証モード。有効なモードは、 ConnectionString、 Msi および 'UserToken' です。

名前	型	説明
ConnectionString	string
Msi	string
UserToken	string

AvroSerialization

入力からのデータをシリアル化する方法、または Avro 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前	型	説明
type	string: Avro	入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

AzureSqlReferenceInputDataSource

Azure SQL データベース参照入力データソースについて説明します。

名前	型	説明
properties.database	string	この要素は [データソース] 要素に関連付けられています。これは出力が書き込まれるデータベースの名前です。
properties.deltaSnapshotQuery	string	この要素は [データソース] 要素に関連付けられています。このクエリは、SQL データベースから増分変更をフェッチするために使用されます。このオプションを使用するには、Azure SQL Database でテンポラルテーブルを使用することをお勧めします。
properties.fullSnapshotQuery	string	この要素は [データソース] 要素に関連付けられています。このクエリは、SQL データベースからデータをフェッチするために使用されます。
properties.password	string	この要素は [データソース] 要素に関連付けられています。これは SQL データベースインスタンスに接続するために使用されるパスワードです。
properties.refreshRate	string	この要素は [データソース] 要素に関連付けられています。これは、データベースからデータをフェッチする頻度を示します。 DateTime 形式です。
properties.refreshType	RefreshType	データ更新オプションの種類を示します。
properties.server	string	この要素は [データソース] 要素に関連付けられています。これは書き込み先のデータベース含むサーバーの名前です。
properties.table	string	この要素は [データソース] 要素に関連付けられています。 Azure SQL データベース内のテーブルの名前。
properties.user	string	この要素は [データソース] 要素に関連付けられています。これは SQL データベースインスタンスに接続するために使用されるユーザー名です。
type	string: Microsoft.Sql/Server/Database	参照データを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

BlobReferenceInputDataSource

参照データを含む BLOB 入力データソースについて説明します。

名前	型	規定値	説明
properties.authenticationMode	AuthenticationMode	ConnectionString	認証モード。
properties.container	string		関連付けられたストレージアカウント内のコンテナーの名前。このコンテナーには、読み取りまたは書き込み対象の BLOB が含まれています。 PUT (CreateOrReplace) 要求で必要です。
properties.dateFormat	string		日付の形式。 {date} が pathPattern に表示される場合は、このプロパティの値が代わりに日付形式として使用されます。
properties.pathPattern	string		BLOB パスパターン。正規表現ではありません。これは、BLOB 名を照合して、ジョブへの入力または出力として含めるかどうかを判断するパターンを表します。詳細な説明と例については、または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-inputしてください。
properties.storageAccounts	StorageAccount[]		1 つ以上の Azure Storage アカウントの一覧。 PUT (CreateOrReplace) 要求で必要です。
properties.timeFormat	string		時刻の形式。 {time} が pathPattern に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。
type	string: Microsoft.Storage/Blob		参照データを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

BlobStreamInputDataSource

ストリームデータを含む BLOB 入力データソースについて説明します。

名前	型	規定値	説明
properties.authenticationMode	AuthenticationMode	ConnectionString	認証モード。
properties.container	string		関連付けられているストレージアカウント内のコンテナーの名前。このコンテナーには、読み取り元または書き込み元の BLOB のいずれかが含まれます。 PUT (CreateOrReplace) 要求で必須。
properties.dateFormat	string		日付の形式。 pathPattern に {date} が表示される場所では、代わりにこのプロパティの値が日付形式として使用されます。
properties.pathPattern	string		BLOB パスパターン。正規表現ではありません。これは、BLOB 名がジョブへの入力または出力として含める必要があるかどうかを判断するために照合されるパターンを表します。詳細な説明と例については https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 、または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してください。
properties.sourcePartitionCount	integer		BLOB 入力データソースのパーティション数。範囲 1 ~ 1024。
properties.storageAccounts	StorageAccount[]		1 つ以上の Azure Storage アカウントの一覧。 PUT (CreateOrReplace) 要求で必須。
properties.timeFormat	string		時刻の形式。 {time} が pathPattern に表示される場合は、このプロパティの値が代わりに時刻形式として使用されます。
type	string: Microsoft.Storage/Blob		ストリームデータを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

Compression

入力データの圧縮方法について説明します

名前	型	規定値	説明
type	CompressionType	None	入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必須。

CompressionType

入力で使用される圧縮の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

名前	型	説明
Deflate	string
GZip	string
None	string

CsvSerialization

入力からのデータをシリアル化する方法、または CSV 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前	型	説明
properties.encoding	Encoding	入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。 PUT (CreateOrReplace) 要求で必要です。
properties.fieldDelimiter	string	コンマ区切り値 (CSV) レコードを区切るために使用する区切り記号を指定します。サポートされている値の一覧については、または https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output を参照してくださいhttps://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input。 PUT (CreateOrReplace) 要求で必要です。
type	string: Csv	入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

DiagnosticCondition

顧客の注意を必要とするリソースまたはジョブ全体に適用される条件。

名前	型	説明
code	string	不透明な診断コード。
message	string	条件を詳しく説明する人間が判読できるメッセージ。クライアント要求の Accept-Language にローカライズされます。
since	string	条件が開始されたときの UTC タイムスタンプ。この時点で、お客様は ops ログで対応するイベントを見つけることができます。

Diagnostics

入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。

名前	型	説明
conditions	DiagnosticCondition[]	リソースまたはジョブ全体に適用できる、顧客の注意を必要とする 0 個以上の条件のコレクション。

Encoding

入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。

名前	型	説明
UTF8	string

Error

一般的なエラー表現。

名前	型	説明
error	Error	エラー定義のプロパティ。

EventHubStreamInputDataSource

ストリームデータを含む Event Hub 入力データソースについて説明します。

名前	型	規定値	説明
authenticationMode	AuthenticationMode	ConnectionString	認証モード。
properties.consumerGroupName	string		イベントハブからイベントを読み取るために使用する必要がある Event Hub コンシューマーグループの名前。複数の入力に個別のコンシューマーグループ名を指定すると、それらの各入力がイベントハブから同じイベントを受信できます。指定しない場合、入力では Event Hub の既定のコンシューマーグループが使用されます。
properties.eventHubName	string		イベントハブの名前。 PUT (CreateOrReplace) 要求で必須。
serviceBusNamespace	string		目的のイベントハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。
sharedAccessPolicyKey	string		指定した共有アクセスポリシーの共有アクセスポリシーキー。 PUT (CreateOrReplace) 要求で必須。
sharedAccessPolicyName	string		イベントハブ、Service Bus キュー、Service Bus トピックなどの共有アクセスポリシー名。PUT (CreateOrReplace) 要求で必須。
type	string: Microsoft.ServiceBus/EventHub		ストリームデータを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventHubV2StreamInputDataSource

ストリームデータを含む Event Hub 入力データソースについて説明します。

名前	型	規定値	説明
authenticationMode	AuthenticationMode	ConnectionString	認証モード。
properties.consumerGroupName	string		イベントハブからイベントを読み取るために使用する必要がある Event Hub コンシューマーグループの名前。複数の入力に個別のコンシューマーグループ名を指定すると、それらの各入力がイベントハブから同じイベントを受信できます。指定しない場合、入力では Event Hub の既定のコンシューマーグループが使用されます。
properties.eventHubName	string		イベントハブの名前。 PUT (CreateOrReplace) 要求で必須。
serviceBusNamespace	string		目的のイベントハブ、Service Bus キュー、Service Bus トピックなどに関連付けられている名前空間。PUT (CreateOrReplace) 要求で必須。
sharedAccessPolicyKey	string		指定した共有アクセスポリシーの共有アクセスポリシーキー。 PUT (CreateOrReplace) 要求で必須。
sharedAccessPolicyName	string		イベントハブ、Service Bus キュー、Service Bus トピックなどの共有アクセスポリシー名。PUT (CreateOrReplace) 要求で必須。
type	string: Microsoft.EventHub/EventHub		ストリームデータを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必須。

EventSerializationType

入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

名前	型	説明
Avro	string
Csv	string
Json	string
Parquet	string

FileReferenceInputDataSource

参照データを含むファイル入力データソースについて説明します。

名前	型	説明
properties.path	string	ファイルのパス。
type	string: File	参照データを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

GatewayMessageBusStreamInputDataSource

ストリームデータを含む BLOB 入力データソースについて説明します。

名前	型	説明
properties.topic	string	Service Bus トピックの名前。
type	string: GatewayMessageBus	ストリームデータを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

Input

名前付き入力に関連付けられているすべての情報を格納する入力オブジェクト。すべての入力はストリーミングジョブの下に含まれます。

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties	InputProperties: ReferenceInputProperties StreamInputProperties	入力に関連付けられているプロパティ。 PUT (CreateOrReplace) 要求で必須。
type	string	リソースの種類

IoTHubStreamInputDataSource

ストリームデータを含むIoT Hub入力データソースについて説明します。

名前	型	説明
properties.consumerGroupName	string	IoT Hubからイベントを読み取るために使用する必要があるIoT Hub コンシューマーグループの名前。指定しない場合、入力では Iot Hub の既定のコンシューマーグループが使用されます。
properties.endpoint	string	接続するIoT Hubエンドポイント (つまり、messages/events、messages/operationsMonitoringEvents など)。
properties.iotHubNamespace	string	IoT Hubの名前または URI。 PUT (CreateOrReplace) 要求で必須。
properties.sharedAccessPolicyKey	string	指定した共有アクセスポリシーの共有アクセスポリシーキー。 PUT (CreateOrReplace) 要求で必須。
properties.sharedAccessPolicyName	string	IoT Hubの共有アクセスポリシー名。このポリシーには、少なくともサービス接続アクセス許可が含まれている必要があります。 PUT (CreateOrReplace) 要求で必須。
type	string: Microsoft.Devices/IotHubs	ストリームデータを含む入力データソースの種類を示します。 PUT (CreateOrReplace) 要求で必要です。

JsonOutputSerializationFormat

出力が書き込まれる JSON の形式を指定します。現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトを使用して書式設定されることを示す 'lineSeparated' と、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' です。

名前	型	説明
Array	string
LineSeparated	string

JsonSerialization

入力からのデータをシリアル化する方法、または JSON 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前	型	説明
properties.encoding	Encoding	入力の場合の受信データのエンコードと、出力の場合の送信データのエンコードを指定します。 PUT (CreateOrReplace) 要求で必要です。
properties.format	JsonOutputSerializationFormat	このプロパティは、出力の JSON シリアル化にのみ適用されます。入力には適用されません。このプロパティは、出力が書き込まれる JSON の形式を指定します。現在サポートされている値は、出力が新しい行で区切られた各 JSON オブジェクトを使用して書式設定されることを示す 'lineSeparated' と、出力が JSON オブジェクトの配列として書式設定されることを示す 'array' です。左 null の場合、既定値は 'lineSeparated' です。
type	string: Json	入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

ParquetSerialization

入力からのデータをシリアル化する方法、または Parquet 形式で出力に書き込むときにデータをシリアル化する方法について説明します。

名前	型	説明
type	string: Parquet	入力または出力で使用されるシリアル化の種類を示します。 PUT (CreateOrReplace) 要求で必要です。

ReferenceInputProperties

参照データを含む入力に関連付けられているプロパティ。

名前	型	説明
compression	Compression	入力データの圧縮方法について説明します
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	参照データを含む入力データソースについて説明します。 PUT (CreateOrReplace) 要求で必須。
diagnostics	Diagnostics	入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。
etag	string	入力の現在のエンティティタグ。これは不透明な文字列です。これを使用して、要求間でリソースが変更されたかどうかを検出できます。また、オプティミスティックコンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。
partitionKey	string	partitionKey 入力データのパーティション分割に使用される入力データ内のキーについて説明します
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	入力のデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必須。
type	string: Reference	入力が参照データのソースかストリームデータかを示します。 PUT (CreateOrReplace) 要求で必須。

RefreshType

データ更新オプションの種類を示します。

名前	型	説明
RefreshPeriodicallyWithDelta	string
RefreshPeriodicallyWithFull	string
Static	string

StorageAccount

Azure Storage アカウントに関連付けられているプロパティ

名前	型	説明
accountKey	string	Azure Storage アカウントのアカウントキー。 PUT (CreateOrReplace) 要求で必要です。
accountName	string	Azure ストレージアカウントの名前。 PUT (CreateOrReplace) 要求で必要です。

StreamInputProperties

ストリームデータを含む入力に関連付けられているプロパティ。

名前	型	説明
compression	Compression	入力データの圧縮方法について説明します
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	ストリームデータを含む入力データソースについて説明します。 PUT (CreateOrReplace) 要求で必須。
diagnostics	Diagnostics	入力、出力、またはジョブ全体に適用される、顧客の注意を必要とする条件について説明します。
etag	string	入力の現在のエンティティタグ。これは不透明な文字列です。これを使用して、要求間でリソースが変更されたかどうかを検出できます。また、オプティミスティックコンカレンシーの書き込み操作に対して、If-Match ヘッダーまたは If-None-Match ヘッダーで使用することもできます。
partitionKey	string	partitionKey 入力データのパーティション分割に使用される入力データ内のキーについて説明します
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	入力のデータをシリアル化する方法、または出力に書き込むときにデータをシリアル化する方法について説明します。 PUT (CreateOrReplace) 要求で必須。
type	string: Stream	入力が参照データのソースかストリームデータかを示します。 PUT (CreateOrReplace) 要求で必須。

次の方法で共有

Inputs - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Get a reference blob input with CSV serialization

要求のサンプル

応答のサンプル

Get a stream blob input with CSV serialization

要求のサンプル

応答のサンプル

Get a stream Event Hub input with JSON serialization

要求のサンプル

応答のサンプル

Get a stream IoT Hub input with Avro serialization

要求のサンプル

応答のサンプル

定義

AuthenticationMode

AvroSerialization

AzureSqlReferenceInputDataSource

BlobReferenceInputDataSource

BlobStreamInputDataSource

Compression

CompressionType

CsvSerialization

DiagnosticCondition

Diagnostics

Encoding

Error

EventHubStreamInputDataSource

EventHubV2StreamInputDataSource

EventSerializationType

FileReferenceInputDataSource

GatewayMessageBusStreamInputDataSource

Input

IoTHubStreamInputDataSource

JsonOutputSerializationFormat

JsonSerialization

ParquetSerialization

ReferenceInputProperties

RefreshType

StorageAccount

StreamInputProperties

その他のリソース