Inputs - List By Streaming Job

參考

Service:: Stream Analytics

API Version:: 2020-03-01

清單指定串流作業下的所有輸入。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
jobName	path	True	string	串流作業的名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。
$select	query		string	$select OData 查詢參數。這是要包含在回應中的結構化屬性逗號分隔清單，或「以包含所有屬性」。根據預設，除了診斷之外，會傳回所有屬性。目前只接受『' 作為有效值。

回應

名稱	類型	Description
200 OK	InputListResult	成功列出指定串流作業底下的輸入。
Other Status Codes	Error	錯誤。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

List all inputs in a streaming job

List all inputs in a streaming job and include diagnostic information using the $select OData query parameter

List all inputs in a streaming job

Sample Request

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

import com.azure.core.util.Context;

/** Samples for Inputs ListByStreamingJob. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob.json
     */
    /**
     * Sample code: List all inputs in a streaming job.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void listAllInputsInAStreamingJob(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().listByStreamingJob("sjrg8440", "sj9597", null, 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_ListByStreamingJob.json
func ExampleInputsClient_NewListByStreamingJobPager_listAllInputsInAStreamingJob() {
	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)
	}
	pager := clientFactory.NewInputsClient().NewListByStreamingJobPager("sjrg8440", "sj9597", &armstreamanalytics.InputsClientListByStreamingJobOptions{Select: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.InputListResult = armstreamanalytics.InputListResult{
		// 	Value: []*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"),
		// 				Etag: to.Ptr("a4ceb697-1c8f-40c8-b951-fb5ee4757437"),
		// 				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("differentContainer"),
		// 						DateFormat: to.Ptr("yyyy/MM/dd"),
		// 						PathPattern: to.Ptr("{date}/{time}"),
		// 						StorageAccounts: []*armstreamanalytics.StorageAccount{
		// 							{
		// 								AccountName: to.Ptr("someAccountName"),
		// 						}},
		// 						TimeFormat: to.Ptr("HH"),
		// 					},
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("input8899"),
		// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
		// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input8899"),
		// 			Properties: &armstreamanalytics.StreamInputProperties{
		// 				Type: to.Ptr("Stream"),
		// 				Etag: to.Ptr("3b35d57c-02f4-4b41-8e1d-af02a86c2fa1"),
		// 				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](32),
		// 					},
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("input7425"),
		// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
		// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7425"),
		// 			Properties: &armstreamanalytics.StreamInputProperties{
		// 				Type: to.Ptr("Stream"),
		// 				Etag: to.Ptr("7548f259-81b5-4ea7-b896-25c6717d98ba"),
		// 				Serialization: &armstreamanalytics.AvroSerialization{
		// 					Type: to.Ptr(armstreamanalytics.EventSerializationTypeAvro),
		// 					Properties: map[string]any{
		// 					},
		// 				},
		// 				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("differentConsumerGroupName"),
		// 					},
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("input7970"),
		// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
		// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7970"),
		// 			Properties: &armstreamanalytics.StreamInputProperties{
		// 				Type: to.Ptr("Stream"),
		// 				Etag: to.Ptr("e2d847e0-c95b-48ef-9e14-1afc1f2270cb"),
		// 				Serialization: &armstreamanalytics.CSVSerialization{
		// 					Type: to.Ptr(armstreamanalytics.EventSerializationTypeCSV),
		// 					Properties: &armstreamanalytics.CSVSerializationProperties{
		// 						Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
		// 						FieldDelimiter: to.Ptr("|"),
		// 					},
		// 				},
		// 				Datasource: &armstreamanalytics.IoTHubStreamInputDataSource{
		// 					Type: to.Ptr("Microsoft.Devices/IotHubs"),
		// 					Properties: &armstreamanalytics.IoTHubStreamInputDataSourceProperties{
		// 						ConsumerGroupName: to.Ptr("sdkconsumergroup"),
		// 						Endpoint: to.Ptr("messages/operationsMonitoringEvents"),
		// 						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 Lists all of the inputs under the specified streaming job.
 *
 * @summary Lists all of the inputs under the specified streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob.json
 */
async function listAllInputsInAStreamingJob() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg8440";
  const jobName = "sj9597";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.inputs.listByStreamingJob(resourceGroupName, jobName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listAllInputsInAStreamingJob().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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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": "differentContainer",
            "pathPattern": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "a4ceb697-1c8f-40c8-b951-fb5ee4757437"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input8899",
      "name": "input8899",
      "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
      "properties": {
        "type": "Stream",
        "datasource": {
          "type": "Microsoft.Storage/Blob",
          "properties": {
            "sourcePartitionCount": 32,
            "storageAccounts": [
              {
                "accountName": "someAccountName"
              }
            ],
            "container": "state",
            "pathPattern": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "3b35d57c-02f4-4b41-8e1d-af02a86c2fa1"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7425",
      "name": "input7425",
      "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
      "properties": {
        "type": "Stream",
        "datasource": {
          "type": "Microsoft.ServiceBus/EventHub",
          "properties": {
            "eventHubName": "sdkeventhub",
            "consumerGroupName": "differentConsumerGroupName",
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Avro",
          "properties": {}
        },
        "etag": "7548f259-81b5-4ea7-b896-25c6717d98ba"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7970",
      "name": "input7970",
      "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
      "properties": {
        "type": "Stream",
        "datasource": {
          "type": "Microsoft.Devices/IotHubs",
          "properties": {
            "iotHubNamespace": "iothub",
            "sharedAccessPolicyName": "owner",
            "endpoint": "messages/operationsMonitoringEvents",
            "consumerGroupName": "sdkconsumergroup"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "e2d847e0-c95b-48ef-9e14-1afc1f2270cb"
      }
    }
  ]
}

List all inputs in a streaming job and include diagnostic information using the $select OData query parameter

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs?$select=*&api-version=2020-03-01

import com.azure.core.util.Context;

/** Samples for Inputs ListByStreamingJob. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob_Diagnostics.json
     */
    /**
     * Sample code: List all inputs in a streaming job and include diagnostic information using the $select OData query
     * parameter.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void listAllInputsInAStreamingJobAndIncludeDiagnosticInformationUsingTheSelectODataQueryParameter(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().listByStreamingJob("sjrg3276", "sj7804", "*", 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/azcore/to"
	"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_ListByStreamingJob_Diagnostics.json
func ExampleInputsClient_NewListByStreamingJobPager_listAllInputsInAStreamingJobAndIncludeDiagnosticInformationUsingTheSelectODataQueryParameter() {
	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)
	}
	pager := clientFactory.NewInputsClient().NewListByStreamingJobPager("sjrg3276", "sj7804", &armstreamanalytics.InputsClientListByStreamingJobOptions{Select: to.Ptr("*")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.InputListResult = armstreamanalytics.InputListResult{
		// 	Value: []*armstreamanalytics.Input{
		// 		{
		// 			Name: to.Ptr("inputtest"),
		// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
		// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest"),
		// 			Properties: &armstreamanalytics.StreamInputProperties{
		// 				Type: to.Ptr("Stream"),
		// 				Diagnostics: &armstreamanalytics.Diagnostics{
		// 					Conditions: []*armstreamanalytics.DiagnosticCondition{
		// 						{
		// 							Code: to.Ptr("INP-3"),
		// 							Message: to.Ptr("Could not deserialize the input event as Json. Some possible reasons: 1) Malformed events 2) Input source configured with incorrect serialization format"),
		// 							Since: to.Ptr("2017-05-11T04:38:42.4938687Z"),
		// 					}},
		// 				},
		// 				Etag: to.Ptr("ca88f8fa-605b-4c7f-8695-46f5faa60cd0"),
		// 				Serialization: &armstreamanalytics.JSONSerialization{
		// 					Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
		// 					Properties: &armstreamanalytics.JSONSerializationProperties{
		// 						Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
		// 					},
		// 				},
		// 				Datasource: &armstreamanalytics.BlobStreamInputDataSource{
		// 					Type: to.Ptr("Microsoft.Storage/Blob"),
		// 					Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
		// 						Container: to.Ptr("state"),
		// 						PathPattern: to.Ptr(""),
		// 						StorageAccounts: []*armstreamanalytics.StorageAccount{
		// 							{
		// 								AccountName: to.Ptr("someAccountName"),
		// 						}},
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 Lists all of the inputs under the specified streaming job.
 *
 * @summary Lists all of the inputs under the specified streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob_Diagnostics.json
 */
async function listAllInputsInAStreamingJobAndIncludeDiagnosticInformationUsingTheSelectODataQueryParameter() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const select = "*";
  const resourceGroupName = "sjrg3276";
  const jobName = "sj7804";
  const options = { select };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.inputs.listByStreamingJob(resourceGroupName, jobName, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listAllInputsInAStreamingJobAndIncludeDiagnosticInformationUsingTheSelectODataQueryParameter().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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
      "name": "inputtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
      "properties": {
        "type": "Stream",
        "datasource": {
          "type": "Microsoft.Storage/Blob",
          "properties": {
            "storageAccounts": [
              {
                "accountName": "someAccountName"
              }
            ],
            "container": "state",
            "pathPattern": ""
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8"
          }
        },
        "diagnostics": {
          "conditions": [
            {
              "since": "2017-05-11T04:38:42.4938687Z",
              "code": "INP-3",
              "message": "Could not deserialize the input event as Json. Some possible reasons: 1) Malformed events 2) Input source configured with incorrect serialization format"
            }
          ]
        },
        "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
      }
    }
  ]
}

定義

名稱	Description
AuthenticationMode	驗證模式。有效模式為 `ConnectionString`、 `Msi` 和『UserToken』。
AvroSerialization	描述如何串行化來自輸入的數據，或數據在以Avro格式寫入輸出時如何串行化。
AzureSqlReferenceInputDataSource	描述 Azure SQL 資料庫參考輸入數據源。
BlobReferenceInputDataSource	描述包含參考數據的 Blob 輸入數據源。
BlobStreamInputDataSource	描述包含數據流數據的 Blob 輸入數據源。
Compression	描述如何壓縮輸入數據
CompressionType	指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。
CsvSerialization	描述如何串行化來自輸入的數據，或將數據以 CSV 格式寫入輸出時如何串行化。
DiagnosticCondition	適用於需要客戶注意的資源或整體作業的條件。
Diagnostics	描述可讓客戶注意的輸入、輸出或整體作業適用的條件。
Encoding	指定輸入時的傳入數據的編碼方式，以及在輸出的情況下指定傳出數據的編碼方式。
Error	常見的錯誤表示。
EventHubStreamInputDataSource	描述包含數據流數據的事件中樞輸入數據源。
EventHubV2StreamInputDataSource	描述包含數據流數據的事件中樞輸入數據源。
EventSerializationType	指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。
FileReferenceInputDataSource	描述包含參考數據的檔案輸入數據源。
GatewayMessageBusStreamInputDataSource	描述包含數據流數據的 Blob 輸入數據源。
Input	輸入物件，包含與具名輸入相關聯的所有資訊。所有輸入都包含在串流作業下。
InputListResult	物件，其中包含串流作業底下的輸入清單。
IoTHubStreamInputDataSource	描述包含數據流數據的 IoT 中樞輸入數據源。
JsonOutputSerializationFormat	指定輸出將寫入的 JSON 格式。目前支援的值是『lineSeparated』，表示輸出會藉由以新行分隔的每個 JSON 物件格式化，而 'array' 表示輸出會格式化為 JSON 物件的數位。
JsonSerialization	描述如何串行化來自輸入的數據，或將數據以 JSON 格式寫入輸出時如何串行化數據。
ParquetSerialization	描述如何串行化來自輸入的數據，或數據在以 Parquet 格式寫入輸出時如何串行化。
ReferenceInputProperties	與包含參考數據的輸入相關聯的屬性。
RefreshType	指出數據重新整理選項的類型。
StorageAccount	與 Azure 記憶體帳戶相關聯的屬性
StreamInputProperties	與包含數據流數據的輸入相關聯的屬性。

AuthenticationMode

驗證模式。有效模式為 ConnectionString、 Msi 和『UserToken』。

名稱	類型	Description
ConnectionString	string
Msi	string
UserToken	string

AvroSerialization

描述如何串行化來自輸入的數據，或數據在以Avro格式寫入輸出時如何串行化。

名稱	類型	Description
type	string: Avro	指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

AzureSqlReferenceInputDataSource

描述 Azure SQL 資料庫參考輸入數據源。

名稱	類型	Description
properties.database	string	這個元素與 datasource 元素相關聯。這是輸出將寫入的資料庫名稱。
properties.deltaSnapshotQuery	string	這個元素與 datasource 元素相關聯。此查詢可用來從 SQL 資料庫擷取累加變更。若要使用此選項，建議您在 Azure SQL Database 中使用時態表。
properties.fullSnapshotQuery	string	這個元素與 datasource 元素相關聯。此查詢可用來從 sql 資料庫擷取數據。
properties.password	string	這個元素與 datasource 元素相關聯。這是將用來連接到 SQL Database 執行個體的密碼。
properties.refreshRate	string	這個元素與 datasource 元素相關聯。這表示數據從資料庫擷取的頻率。它是 DateTime 格式。
properties.refreshType	RefreshType	指出數據重新整理選項的類型。
properties.server	string	這個元素與 datasource 元素相關聯。這是伺服器的名稱，包含將寫入的資料庫。
properties.table	string	這個元素與 datasource 元素相關聯。 Azure SQL 資料庫中的數據表名稱。
properties.user	string	這個元素與 datasource 元素相關聯。這是將用來連接到 SQL Database 執行個體的使用者名稱。
type	string: Microsoft.Sql/Server/Database	指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

BlobReferenceInputDataSource

描述包含參考數據的 Blob 輸入數據源。

名稱	類型	預設值	Description
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-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。
properties.storageAccounts	StorageAccount[]		一或多個 Azure 記憶體帳戶的清單。 PUT (CreateOrReplace) 要求上的必要專案。
properties.timeFormat	string		時間格式。每當 pathPattern 中出現 {time} 時，這個屬性的值會改用為時間格式。
type	string: Microsoft.Storage/Blob		指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

BlobStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

名稱	類型	預設值	Description
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-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。
properties.sourcePartitionCount	integer		Blob 輸入數據源的數據分割計數。範圍 1 - 1024。
properties.storageAccounts	StorageAccount[]		一或多個 Azure 記憶體帳戶的清單。 PUT (CreateOrReplace) 要求上的必要專案。
properties.timeFormat	string		時間格式。每當 pathPattern 中出現 {time} 時，這個屬性的值會改用為時間格式。
type	string: Microsoft.Storage/Blob		指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

Compression

描述如何壓縮輸入數據

名稱	類型	預設值	Description
type	CompressionType	None	指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。

CompressionType

指出輸入所使用的壓縮類型。 PUT (CreateOrReplace) 要求上的必要專案。

名稱	類型	Description
Deflate	string
GZip	string
None	string

CsvSerialization

描述如何串行化來自輸入的數據，或將數據以 CSV 格式寫入輸出時如何串行化。

名稱	類型	Description
properties.encoding	Encoding	指定輸入時的傳入數據的編碼方式，以及在輸出的情況下指定傳出數據的編碼方式。 PUT (CreateOrReplace) 要求上的必要專案。
properties.fieldDelimiter	string	指定分隔符，這個分隔符將用來分隔逗號分隔值， (CSV) 記錄。如需支援值的清單，請參閱 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 。 PUT (CreateOrReplace) 要求上的必要專案。
type	string: Csv	指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

DiagnosticCondition

適用於需要客戶注意的資源或整體作業的條件。

名稱	類型	Description
code	string	不透明診斷程序代碼。
message	string	描述條件的人類可讀訊息。當地語系化為用戶端要求的 Accept-Language。
since	string	條件啟動時的 UTC 時間戳。客戶此時應該能夠在作業記錄中找到對應的事件。

Diagnostics

描述可讓客戶注意的輸入、輸出或整體作業適用的條件。

名稱	類型	Description
conditions	DiagnosticCondition[]	適用於資源或整體作業的零個或多個條件集合，可讓客戶注意。

Encoding

指定輸入時的傳入數據的編碼方式，以及在輸出的情況下指定傳出數據的編碼方式。

名稱	類型	Description
UTF8	string

Error

常見的錯誤表示。

名稱	類型	Description
error	Error	錯誤定義屬性。

EventHubStreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

名稱	類型	預設值	Description
authenticationMode	AuthenticationMode	ConnectionString	驗證模式。
properties.consumerGroupName	string		事件中樞取用者群組的名稱，該群組應該用來從事件中樞讀取事件。指定多個輸入的相異取用者組名，可讓每個輸入從事件中樞接收相同的事件。如果未指定，輸入會使用事件中樞的預設取用者群組。
properties.eventHubName	string		事件中樞的名稱。 PUT (CreateOrReplace) 要求上的必要專案。
serviceBusNamespace	string		與所需事件中樞、服務總線佇列、服務總線主題等相關聯的命名空間。PUT (CreateOrReplace) 要求上的必要專案。
sharedAccessPolicyKey	string		指定共用存取原則的共用存取原則金鑰。 PUT (CreateOrReplace) 要求上的必要專案。
sharedAccessPolicyName	string		事件中樞、服務總線佇列、服務總線主題等的共用存取原則名稱。PUT (CreateOrReplace) 要求上的必要專案。
type	string: Microsoft.ServiceBus/EventHub		指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventHubV2StreamInputDataSource

描述包含數據流數據的事件中樞輸入數據源。

名稱	類型	預設值	Description
authenticationMode	AuthenticationMode	ConnectionString	驗證模式。
properties.consumerGroupName	string		事件中樞取用者群組的名稱，該群組應該用來從事件中樞讀取事件。指定多個輸入的相異取用者組名，可讓每個輸入從事件中樞接收相同的事件。如果未指定，輸入會使用事件中樞的預設取用者群組。
properties.eventHubName	string		事件中樞的名稱。 PUT (CreateOrReplace) 要求上的必要專案。
serviceBusNamespace	string		與所需事件中樞、服務總線佇列、服務總線主題等相關聯的命名空間。PUT (CreateOrReplace) 要求上的必要專案。
sharedAccessPolicyKey	string		指定共用存取原則的共用存取原則金鑰。 PUT (CreateOrReplace) 要求上的必要專案。
sharedAccessPolicyName	string		事件中樞、服務總線佇列、服務總線主題等的共用存取原則名稱。PUT (CreateOrReplace) 要求上的必要專案。
type	string: Microsoft.EventHub/EventHub		指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

EventSerializationType

指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

名稱	類型	Description
Avro	string
Csv	string
Json	string
Parquet	string

FileReferenceInputDataSource

描述包含參考數據的檔案輸入數據源。

名稱	類型	Description
properties.path	string	檔案的路徑。
type	string: File	指出包含參考數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

GatewayMessageBusStreamInputDataSource

描述包含數據流數據的 Blob 輸入數據源。

名稱	類型	Description
properties.topic	string	服務總線主題的名稱。
type	string: GatewayMessageBus	指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

Input

輸入物件，包含與具名輸入相關聯的所有資訊。所有輸入都包含在串流作業下。

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties	InputProperties: ReferenceInputProperties StreamInputProperties	與輸入相關聯的屬性。 PUT (CreateOrReplace) 要求上的必要專案。
type	string	資源類型

InputListResult

物件，其中包含串流作業底下的輸入清單。

名稱	類型	Description
nextLink	string	連結 (url) 至下一頁的結果。
value	Input[]	串流作業下的輸入清單。由「清單」作業填入。

IoTHubStreamInputDataSource

描述包含數據流數據的 IoT 中樞輸入數據源。

名稱	類型	Description
properties.consumerGroupName	string	IoT 中樞取用者群組的名稱，該群組應該用來從 IoT 中樞讀取事件。如果未指定，輸入會使用Iot 中樞的預設取用者群組。
properties.endpoint	string	要連線到 (的 IoT 中樞端點，亦即訊息/事件、messages/operationsMonitoringEvents 等 ) 。
properties.iotHubNamespace	string	IoT 中樞的名稱或 URI。 PUT (CreateOrReplace) 要求上的必要專案。
properties.sharedAccessPolicyKey	string	指定共用存取原則的共用存取原則金鑰。 PUT (CreateOrReplace) 要求上的必要專案。
properties.sharedAccessPolicyName	string	IoT 中樞的共用存取原則名稱。此原則至少必須包含服務連線許可權。 PUT (CreateOrReplace) 要求上的必要專案。
type	string: Microsoft.Devices/IotHubs	指出包含數據流數據的輸入數據來源類型。 PUT (CreateOrReplace) 要求上的必要專案。

JsonOutputSerializationFormat

指定輸出將寫入的 JSON 格式。目前支援的值是『lineSeparated』，表示輸出會藉由以新行分隔的每個 JSON 物件格式化，而 'array' 表示輸出會格式化為 JSON 物件的數位。

名稱	類型	Description
Array	string
LineSeparated	string

JsonSerialization

描述如何串行化來自輸入的數據，或將數據以 JSON 格式寫入輸出時如何串行化數據。

名稱	類型	Description
properties.encoding	Encoding	指定輸入時的傳入數據的編碼方式，以及在輸出的情況下指定傳出數據的編碼方式。 PUT (CreateOrReplace) 要求上的必要專案。
properties.format	JsonOutputSerializationFormat	此屬性僅適用於輸出的 JSON 串行化。它不適用於輸入。此屬性會指定輸出將寫入的 JSON 格式。目前支援的值是『lineSeparated』，表示輸出會藉由以新行分隔的每個 JSON 物件格式化，而 'array' 表示輸出會格式化為 JSON 物件的數位。如果保留 null，預設值為 'lineSeparated'。
type	string: Json	指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

ParquetSerialization

描述如何串行化來自輸入的數據，或數據在以 Parquet 格式寫入輸出時如何串行化。

名稱	類型	Description
type	string: Parquet	指出輸入或輸出所使用的串行化類型。 PUT (CreateOrReplace) 要求上的必要專案。

ReferenceInputProperties

與包含參考數據的輸入相關聯的屬性。

名稱	類型	Description
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

指出數據重新整理選項的類型。

名稱	類型	Description
RefreshPeriodicallyWithDelta	string
RefreshPeriodicallyWithFull	string
Static	string

StorageAccount

與 Azure 記憶體帳戶相關聯的屬性

名稱	類型	Description
accountKey	string	Azure 記憶體帳戶的帳戶的帳戶金鑰。 PUT (CreateOrReplace) 要求上的必要專案。
accountName	string	Azure 儲存體帳戶的名稱。 PUT (CreateOrReplace) 要求上的必要專案。

StreamInputProperties

與包含數據流數據的輸入相關聯的屬性。

名稱	類型	Description
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) 要求上的必要專案。

Share via

Inputs - List By Streaming Job

URI 參數

回應

安全性

azure_auth

Scopes

範例

List all inputs in a streaming job

Sample Request

Sample Response

List all inputs in a streaming job and include diagnostic information using the $select OData query parameter

Sample Request

Sample Response

定義

AuthenticationMode

AvroSerialization

AzureSqlReferenceInputDataSource

BlobReferenceInputDataSource

BlobStreamInputDataSource

Compression

CompressionType

CsvSerialization

DiagnosticCondition

Diagnostics

Encoding

Error

EventHubStreamInputDataSource

EventHubV2StreamInputDataSource

EventSerializationType

FileReferenceInputDataSource

GatewayMessageBusStreamInputDataSource

Input

InputListResult

IoTHubStreamInputDataSource

JsonOutputSerializationFormat

JsonSerialization

ParquetSerialization

ReferenceInputProperties

RefreshType

StorageAccount

StreamInputProperties

其他資源