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	Идентификатор целевой подписки.
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

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
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


/**
 * 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", 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 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


/**
 * 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", 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 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


/**
 * 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", 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 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


/**
 * 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", 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 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	Описывает источник входных данных концентратора событий, содержащий потоковые данные.
EventHubV2StreamInputDataSource	Описывает источник входных данных концентратора событий, содержащий потоковые данные.
EventSerializationType	Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).
FileReferenceInputDataSource	Описывает источник входных данных файла, содержащий эталонные данные.
GatewayMessageBusStreamInputDataSource	Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.
Input	Входной объект, содержащий все сведения, связанные с именованным входным объектом. Все входные данные содержатся в задании потоковой передачи.
IoTHubStreamInputDataSource	Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.
JsonOutputSerializationFormat	Указывает формат JSON, в который будут записаны выходные данные. Поддерживаемые в настоящее время значения lineSeparated указывают, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой, а значение array означает, что выходные данные будут отформатированы в виде массива объектов JSON.
JsonSerialization	Описывает, как сериализуются данные из входных данных или как сериализуются данные при записи в выходные данные в формате JSON.
ParquetSerialization	Описывает, как сериализуются данные из входных данных или как сериализуются данные при записи в выходные данные в формате Parquet.
ReferenceInputProperties	Свойства, связанные с входными данными, содержащими ссылочные данные.
RefreshType	Указывает тип параметра обновления данных.
StorageAccount	Свойства, связанные с учетной записью хранения Azure
StreamInputProperties	Свойства, связанные с входными данными, содержащими потоковые данные.

AuthenticationMode

Режим проверки подлинности. Допустимые режимы: ConnectionString, Msi и UserToken.

Имя	Тип	Описание
ConnectionString	string
Msi	string
UserToken	string

AvroSerialization

Описывает, как сериализуются данные из входных данных или как сериализуются данные при записи в выходные данные в формате Avro.

Имя	Тип	Описание
type	string: Avro	Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Описывает источник входных данных ссылки на базу данных Azure SQL.

Имя	Тип	Описание
properties.database	string	Этот элемент связан с элементом datasource. Это имя базы данных, в которую буду записаны выходные данные.
properties.deltaSnapshotQuery	string	Этот элемент связан с элементом datasource. Этот запрос используется для получения добавочных изменений из базы данных SQL. Для использования этого параметра рекомендуется использовать темпоральные таблицы в базе данных Azure SQL.
properties.fullSnapshotQuery	string	Этот элемент связан с элементом datasource. Этот запрос используется для получения данных из базы данных SQL.
properties.password	string	Этот элемент связан с элементом datasource. Это пароль, который будет использоваться для подключения к экземпляру базы данных SQL.
properties.refreshRate	string	Этот элемент связан с элементом datasource. Это указывает, как часто данные будут извлекаться из базы данных. Имеет формат DateTime.
properties.refreshType	RefreshType	Указывает тип параметра обновления данных.
properties.server	string	Этот элемент связан с элементом datasource. Это имя сервера, содержащего базу данных,в которую будет выполняться запись.
properties.table	string	Этот элемент связан с элементом datasource. Имя таблицы в базе данных Azure SQL.
properties.user	string	Этот элемент связан с элементом datasource. Это имя пользователя, которое будет использоваться для подключения к экземпляру базы данных SQL.
type	string: Microsoft.Sql/Server/Database	Указывает тип источника входных данных, содержащего ссылочные данные. Требуется для запросов PUT (CreateOrReplace).

BlobReferenceInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий эталонные данные.

Имя	Тип	Default value	Описание
properties.authenticationMode	AuthenticationMode	ConnectionString	Режим проверки подлинности.
properties.container	string		Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит blob-объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).
properties.dateFormat	string		Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.
properties.pathPattern	string		Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, с которым будут сопоставляться имена 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		Формат времени. Везде, где {time} отображается в pathPattern, значение этого свойства используется в качестве формата времени.
type	string: Microsoft.Storage/Blob		Указывает тип источника входных данных, содержащего ссылочные данные. Требуется для запросов PUT (CreateOrReplace).

BlobStreamInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя	Тип	Default value	Описание
properties.authenticationMode	AuthenticationMode	ConnectionString	Режим проверки подлинности.
properties.container	string		Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит blob-объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).
properties.dateFormat	string		Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.
properties.pathPattern	string		Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, с которым будут сопоставляться имена 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		Формат времени. Везде, где {time} отображается в pathPattern, значение этого свойства используется в качестве формата времени.
type	string: Microsoft.Storage/Blob		Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

Compression

Описывает, как сжимаются входные данные

Имя	Тип	Default value	Описание
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-input . в разделе или https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output . Требуется для запросов PUT (CreateOrReplace).
type	string: Csv	Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

DiagnosticCondition

Условие, применимое к ресурсу или к заданию в целом, которое требует внимания клиента.

Имя	Тип	Описание
code	string	Непрозрачный диагностический код.
message	string	Удобочитаемое сообщение, подробно описывающее условие. Локализовано в Accept-Language клиентского запроса.
since	string	Метка времени в формате UTC, когда началось условие. Клиенты должны найти соответствующее событие в журнале операций примерно в это время.

Diagnostics

Описывает условия, применимые к входным, выходным данным или к заданию в целом, которые требуют внимания клиента.

Имя	Тип	Описание
conditions	DiagnosticCondition[]	Коллекция из нуля или более условий, применимых к ресурсу или к заданию в целом, которые требуют внимания клиента.

Encoding

Задает кодировку входящих данных в случае ввода и кодировку исходящих данных в случае вывода.

Имя	Тип	Описание
UTF8	string

Error

Представление общей ошибки.

Имя	Тип	Описание
error	Error	Свойства определения ошибки.

EventHubStreamInputDataSource

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя	Тип	Default value	Описание
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

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя	Тип	Default value	Описание
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).

Имя	Тип	Описание
Avro	string
Csv	string
Json	string
Parquet	string

FileReferenceInputDataSource

Описывает источник входных данных файла, содержащий эталонные данные.

Имя	Тип	Описание
properties.path	string	Путь к файлу.
type	string: File	Указывает тип источника входных данных, содержащего ссылочные данные. Требуется для запросов PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя	Тип	Описание
properties.topic	string	Имя раздела служебной шины.
type	string: GatewayMessageBus	Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

Input

Входной объект, содержащий все сведения, связанные с именованным входным объектом. Все входные данные содержатся в задании потоковой передачи.

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties	InputProperties: ReferenceInputProperties StreamInputProperties	Свойства, связанные с входными данными. Требуется для запросов PUT (CreateOrReplace).
type	string	Тип ресурса

IoTHubStreamInputDataSource

Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.

Имя	Тип	Описание
properties.consumerGroupName	string	Имя Центр Интернета вещей группы потребителей, которая должна использоваться для чтения событий из Центр Интернета вещей. Если значение не указано, входные данные используют группу потребителей Центра Интернета вещей по умолчанию.
properties.endpoint	string	Конечная точка Центр Интернета вещей для подключения (например, messages/events, messages/operationsMonitoringEvents и т. д.).
properties.iotHubNamespace	string	Имя или URI Центр Интернета вещей. Требуется для запросов PUT (CreateOrReplace).
properties.sharedAccessPolicyKey	string	Ключ политики общего доступа для указанной политики общего доступа. Требуется для запросов PUT (CreateOrReplace).
properties.sharedAccessPolicyName	string	Имя политики общего доступа для Центр Интернета вещей. Эта политика должна содержать по крайней мере разрешение Service Connect. Требуется для запросов PUT (CreateOrReplace).
type	string: Microsoft.Devices/IotHubs	Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

JsonOutputSerializationFormat

Указывает формат JSON, в который будут записаны выходные данные. Поддерживаемые в настоящее время значения lineSeparated указывают, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой, а значение array означает, что выходные данные будут отформатированы в виде массива объектов JSON.

Имя	Тип	Описание
Array	string
LineSeparated	string

JsonSerialization

Описывает, как сериализуются данные из входных данных или как сериализуются данные при записи в выходные данные в формате JSON.

Имя	Тип	Описание
properties.encoding	Encoding	Задает кодировку входящих данных в случае ввода и кодировку исходящих данных в случае вывода. Требуется для запросов PUT (CreateOrReplace).
properties.format	JsonOutputSerializationFormat	Это свойство применяется только к сериализации выходных данных JSON. Это неприменимо к входным данным. Это свойство задает формат JSON, в который будут записываться выходные данные. Поддерживаемые в настоящее время значения lineSeparated указывают, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой, а значение array означает, что выходные данные будут отформатированы в виде массива объектов JSON. Значение по умолчанию — "lineSeparated", если оставить значение NULL.
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

Имя	Тип	Описание
accountKey	string	Ключ учетной записи для учетной записи хранения Azure. Требуется для запросов 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

Дополнительные ресурсы