Inputs - Get

Služba:

Stream Analytics

Verze rozhraní API:

2020-03-01

Získá podrobnosti o zadaném vstupu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
inputName	path	True	string	Název vstupu.
jobName	path	True	string	Název úlohy streamování.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Input	Zadaný vstup byl úspěšně načten. Hlavičky ETag: string
Other Status Codes	Error	Chyba.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

HTTP

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

Java

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

Go

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

JavaScript

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Java

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

Go

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

JavaScript

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Java

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

Go

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

JavaScript

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

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

HTTP

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

Java

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

Go

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

JavaScript

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AuthenticationMode	Režim ověřování. Platné režimy jsou ConnectionString, Msi a UserToken.
AvroSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu Avro.
AzureSqlReferenceInputDataSource	Popisuje referenční zdroj dat databáze Azure SQL.
BlobReferenceInputDataSource	Popisuje vstupní zdroj dat objektu blob, který obsahuje referenční data.
BlobStreamInputDataSource	Popisuje vstupní zdroj dat objektu blob, který obsahuje streamová data.
Compression	Popisuje, jak se vstupní data komprimují.
CompressionType	Určuje typ komprese, kterou vstupní vstup používá. Požadováno u požadavků PUT (CreateOrReplace).
CsvSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu CSV.
DiagnosticCondition	Podmínka použitelná na zdroj nebo na celkovou úlohu, která zaručuje pozornost zákazníka.
Diagnostics	Popisuje podmínky vztahující se na vstup, výstup nebo celkovou úlohu, která zaručuje pozornost zákazníka.
Encoding	Určuje kódování příchozích dat v případě vstupu a kódování odchozích dat v případě výstupu.
Error	Běžné vyjádření chyb
EventHubStreamInputDataSource	Popisuje vstupní zdroj dat centra událostí, který obsahuje streamová data.
EventHubV2StreamInputDataSource	Popisuje vstupní zdroj dat centra událostí, který obsahuje streamová data.
EventSerializationType	Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).
FileReferenceInputDataSource	Popisuje vstupní zdroj dat souboru, který obsahuje referenční data.
GatewayMessageBusStreamInputDataSource	Popisuje vstupní zdroj dat objektu blob, který obsahuje streamová data.
Input	Vstupní objekt obsahující všechny informace spojené s pojmenovaným vstupem. Všechny vstupy jsou obsaženy v úloze streamování.
IoTHubStreamInputDataSource	Popisuje vstupní zdroj dat ioT Hubu, který obsahuje streamová data.
JsonOutputSerializationFormat	Určuje formát JSON, ve kterém se výstup zapíše. Aktuálně podporované hodnoty jsou lineSeparated označující, že výstup bude formátován tak, že každý objekt JSON oddělený novým řádkem a pole označující, že výstup bude formátován jako pole objektů JSON.
JsonSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu JSON.
ParquetSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu Parquet.
ReferenceInputProperties	Vlastnosti přidružené ke vstupu obsahujícímu referenční data.
RefreshType	Označuje typ možnosti aktualizace dat.
StorageAccount	Vlastnosti přidružené k účtu služby Azure Storage
StreamInputProperties	Vlastnosti, které jsou přidružené ke vstupu obsahujícímu data datového proudu.

AuthenticationMode

Výčet

Režim ověřování. Platné režimy jsou ConnectionString, Msi a UserToken.

Hodnota	Description
ConnectionString
Msi
UserToken

AvroSerialization

Objekt

Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu Avro.

Name	Typ	Description
type	string: Avro	Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Objekt

Popisuje referenční zdroj dat databáze Azure SQL.

Name	Typ	Description
properties.database	string	Tento prvek je přidružen k prvku zdroje dat. Toto je název databáze, do které se zapíše výstup.
properties.deltaSnapshotQuery	string	Tento prvek je přidružen k prvku zdroje dat. Tento dotaz slouží k načtení přírůstkových změn z databáze SQL. Pokud chcete tuto možnost použít, doporučujeme používat dočasné tabulky ve službě Azure SQL Database.
properties.fullSnapshotQuery	string	Tento prvek je přidružen k prvku zdroje dat. Tento dotaz slouží k načtení dat z databáze SQL.
properties.password	string	Tento prvek je přidružen k prvku zdroje dat. Toto je heslo, které se použije pro připojení k instanci služby SQL Database.
properties.refreshRate	string	Tento prvek je přidružen k prvku zdroje dat. To určuje, jak často se budou data načítat z databáze. Je to formát DateTime.
properties.refreshType	RefreshType	Označuje typ možnosti aktualizace dat.
properties.server	string	Tento prvek je přidružen k prvku zdroje dat. Toto je název serveru, který obsahuje databázi, do které se zapíše.
properties.table	string	Tento prvek je přidružen k prvku zdroje dat. Název tabulky v databázi Azure SQL.
properties.user	string	Tento prvek je přidružen k prvku zdroje dat. Toto je uživatelské jméno, které se použije pro připojení k instanci služby SQL Database.
type	string: Microsoft.Sql/Server/Database	Určuje typ vstupního zdroje dat obsahujícího referenční data. Požadováno u požadavků PUT (CreateOrReplace).

BlobReferenceInputDataSource

Objekt

Popisuje vstupní zdroj dat objektu blob, který obsahuje referenční data.

Name	Typ	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Režim ověřování.
properties.container	string		Název kontejneru v rámci přidruženého účtu úložiště. Tento kontejner obsahuje objekty blob, ze které se mají číst, nebo zapisovat do. Požadováno u požadavků PUT (CreateOrReplace).
properties.dateFormat	string		Formát data. Všude, kde se {date} zobrazí v cestěPattern, se hodnota této vlastnosti použije jako formát data.
properties.pathPattern	string		Vzor cesty k objektu blob. Ne regulární výraz. Představuje vzor, proti kterému se názvy objektů blob budou shodovat s určením, jestli se mají zahrnout jako vstup nebo výstup úlohy. Podrobnější vysvětlení a příklad najdete v tématu https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input nebo https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output.
properties.storageAccounts	StorageAccount[]		Seznam jednoho nebo více účtů Azure Storage Požadováno u požadavků PUT (CreateOrReplace).
properties.timeFormat	string		Formát času. Kdykoli se {time} zobrazí v cestěPattern, hodnota této vlastnosti se místo toho použije jako formát času.
type	string: Microsoft.Storage/Blob		Určuje typ vstupního zdroje dat obsahujícího referenční data. Požadováno u požadavků PUT (CreateOrReplace).

BlobStreamInputDataSource

Objekt

Popisuje vstupní zdroj dat objektu blob, který obsahuje streamová data.

Name	Typ	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Režim ověřování.
properties.container	string		Název kontejneru v rámci přidruženého účtu úložiště. Tento kontejner obsahuje objekty blob, ze které se mají číst, nebo zapisovat do. Požadováno u požadavků PUT (CreateOrReplace).
properties.dateFormat	string		Formát data. Všude, kde se {date} zobrazí v cestěPattern, se hodnota této vlastnosti použije jako formát data.
properties.pathPattern	string		Vzor cesty k objektu blob. Ne regulární výraz. Představuje vzor, proti kterému se názvy objektů blob budou shodovat s určením, jestli se mají zahrnout jako vstup nebo výstup úlohy. Podrobnější vysvětlení a příklad najdete v tématu https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input nebo https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output.
properties.sourcePartitionCount	integer (int32)		Počet oddílů vstupního zdroje dat objektu blob. Rozsah 1 – 1024.
properties.storageAccounts	StorageAccount[]		Seznam jednoho nebo více účtů Azure Storage Požadováno u požadavků PUT (CreateOrReplace).
properties.timeFormat	string		Formát času. Kdykoli se {time} zobrazí v cestěPattern, hodnota této vlastnosti se místo toho použije jako formát času.
type	string: Microsoft.Storage/Blob		Určuje typ vstupního zdroje dat obsahujícího data datového proudu. Požadováno u požadavků PUT (CreateOrReplace).

Compression

Objekt

Popisuje, jak se vstupní data komprimují.

Name	Typ	Default value	Description
type	CompressionType	None	Určuje typ komprese, kterou vstupní vstup používá. Požadováno u požadavků PUT (CreateOrReplace).

CompressionType

Výčet

Určuje typ komprese, kterou vstupní vstup používá. Požadováno u požadavků PUT (CreateOrReplace).

Hodnota	Description
Deflate
GZip
None

CsvSerialization

Objekt

Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu CSV.

Name	Typ	Description
properties.encoding	Encoding	Určuje kódování příchozích dat v případě vstupu a kódování odchozích dat v případě výstupu. Požadováno u požadavků PUT (CreateOrReplace).
properties.fieldDelimiter	string	Určuje oddělovač, který se použije k oddělení záznamů hodnot oddělených čárkami (CSV). Seznam podporovaných hodnot najdete v https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input nebo https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Csv	Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).

DiagnosticCondition

Objekt

Podmínka použitelná na zdroj nebo na celkovou úlohu, která zaručuje pozornost zákazníka.

Name	Typ	Description
code	string	Neprůspatný diagnostický kód.
message	string	Zpráva čitelná člověkem popisující podmínku podrobně. Lokalizované v Accept-Language požadavku klienta.
since	string	Časové razítko UTC, kdy se podmínka spustila. Zákazníci by měli být schopni najít odpovídající událost v protokolu operací přibližně v tomto okamžiku.

Diagnostics

Objekt

Popisuje podmínky vztahující se na vstup, výstup nebo celkovou úlohu, která zaručuje pozornost zákazníka.

Name	Typ	Description
conditions	DiagnosticCondition[]	Kolekce nulových nebo více podmínek vztahujících se na prostředek nebo na celkovou úlohu, která zaručuje pozornost zákazníka.

Encoding

Výčet

Určuje kódování příchozích dat v případě vstupu a kódování odchozích dat v případě výstupu.

Hodnota	Description
UTF8

Error

Objekt

Běžné vyjádření chyb

Name	Typ	Description
error	Error	Vlastnosti definice chyby

EventHubStreamInputDataSource

Objekt

Popisuje vstupní zdroj dat centra událostí, který obsahuje streamová data.

Name	Typ	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Režim ověřování.
properties.consumerGroupName	string		Název skupiny příjemců centra událostí, která by se měla použít ke čtení událostí z centra událostí. Zadání jedinečných názvů skupin příjemců pro více vstupů umožňuje každému z těchto vstupů přijímat stejné události z centra událostí. Pokud není zadaný, použije vstup výchozí skupinu příjemců centra událostí.
properties.eventHubName	string		Název centra událostí. Požadováno u požadavků PUT (CreateOrReplace).
serviceBusNamespace	string		Obor názvů přidružený k požadovanému centru událostí, frontě služby Service Bus, tématu služby Service Bus atd. Požadováno u požadavků PUT (CreateOrReplace).
sharedAccessPolicyKey	string		Klíč zásad sdíleného přístupu pro zadanou zásadu sdíleného přístupu. Požadováno u požadavků PUT (CreateOrReplace).
sharedAccessPolicyName	string		Název zásady sdíleného přístupu pro centrum událostí, frontu služby Service Bus, téma služby Service Bus atd. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Microsoft.ServiceBus/EventHub		Určuje typ vstupního zdroje dat obsahujícího data datového proudu. Požadováno u požadavků PUT (CreateOrReplace).

EventHubV2StreamInputDataSource

Objekt

Popisuje vstupní zdroj dat centra událostí, který obsahuje streamová data.

Name	Typ	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Režim ověřování.
properties.consumerGroupName	string		Název skupiny příjemců centra událostí, která by se měla použít ke čtení událostí z centra událostí. Zadání jedinečných názvů skupin příjemců pro více vstupů umožňuje každému z těchto vstupů přijímat stejné události z centra událostí. Pokud není zadaný, použije vstup výchozí skupinu příjemců centra událostí.
properties.eventHubName	string		Název centra událostí. Požadováno u požadavků PUT (CreateOrReplace).
serviceBusNamespace	string		Obor názvů přidružený k požadovanému centru událostí, frontě služby Service Bus, tématu služby Service Bus atd. Požadováno u požadavků PUT (CreateOrReplace).
sharedAccessPolicyKey	string		Klíč zásad sdíleného přístupu pro zadanou zásadu sdíleného přístupu. Požadováno u požadavků PUT (CreateOrReplace).
sharedAccessPolicyName	string		Název zásady sdíleného přístupu pro centrum událostí, frontu služby Service Bus, téma služby Service Bus atd. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Microsoft.EventHub/EventHub		Určuje typ vstupního zdroje dat obsahujícího data datového proudu. Požadováno u požadavků PUT (CreateOrReplace).

EventSerializationType

Výčet

Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).

Hodnota	Description
Avro
Csv
Json
Parquet

FileReferenceInputDataSource

Objekt

Popisuje vstupní zdroj dat souboru, který obsahuje referenční data.

Name	Typ	Description
properties.path	string	Cesta k souboru.
type	string: File	Určuje typ vstupního zdroje dat obsahujícího referenční data. Požadováno u požadavků PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Objekt

Popisuje vstupní zdroj dat objektu blob, který obsahuje streamová data.

Name	Typ	Description
properties.topic	string	Název tématu služby Service Bus.
type	string: GatewayMessageBus	Určuje typ vstupního zdroje dat obsahujícího data datového proudu. Požadováno u požadavků PUT (CreateOrReplace).

Input

Objekt

Vstupní objekt obsahující všechny informace spojené s pojmenovaným vstupem. Všechny vstupy jsou obsaženy v úloze streamování.

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties	InputProperties: ReferenceInputProperties StreamInputProperties	Vlastnosti, které jsou přidruženy ke vstupu. Požadováno u požadavků PUT (CreateOrReplace).
type	string	Typ prostředku

IoTHubStreamInputDataSource

Objekt

Popisuje vstupní zdroj dat ioT Hubu, který obsahuje streamová data.

Name	Typ	Description
properties.consumerGroupName	string	Název skupiny příjemců ioT Hubu, která by se měla použít ke čtení událostí ze služby IoT Hub. Pokud není zadaný, použije vstup výchozí skupinu příjemců iot Hubu.
properties.endpoint	string	Koncový bod ioT Hubu pro připojení (tj. zprávy/události, zprávy/operationsMonitoringEvents atd.).
properties.iotHubNamespace	string	Název nebo identifikátor URI služby IoT Hub. Požadováno u požadavků PUT (CreateOrReplace).
properties.sharedAccessPolicyKey	string	Klíč zásad sdíleného přístupu pro zadanou zásadu sdíleného přístupu. Požadováno u požadavků PUT (CreateOrReplace).
properties.sharedAccessPolicyName	string	Název zásady sdíleného přístupu pro IoT Hub. Tato zásada musí obsahovat alespoň oprávnění připojení ke službě. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Microsoft.Devices/IotHubs	Určuje typ vstupního zdroje dat obsahujícího data datového proudu. Požadováno u požadavků PUT (CreateOrReplace).

JsonOutputSerializationFormat

Výčet

Určuje formát JSON, ve kterém se výstup zapíše. Aktuálně podporované hodnoty jsou lineSeparated označující, že výstup bude formátován tak, že každý objekt JSON oddělený novým řádkem a pole označující, že výstup bude formátován jako pole objektů JSON.

Hodnota	Description
Array
LineSeparated

JsonSerialization

Objekt

Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu JSON.

Name	Typ	Description
properties.encoding	Encoding	Určuje kódování příchozích dat v případě vstupu a kódování odchozích dat v případě výstupu. Požadováno u požadavků PUT (CreateOrReplace).
properties.format	JsonOutputSerializationFormat	Tato vlastnost se vztahuje pouze na serializaci JSON výstupů. Nevztahuje se na vstupy. Tato vlastnost určuje formát JSON, ve kterém se výstup zapíše. Aktuálně podporované hodnoty jsou lineSeparated označující, že výstup bude formátován tak, že každý objekt JSON oddělený novým řádkem a pole označující, že výstup bude formátován jako pole objektů JSON. Výchozí hodnota je lineSeparated, pokud je hodnota null.
type	string: Json	Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).

ParquetSerialization

Objekt

Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu ve formátu Parquet.

Name	Typ	Description
type	string: Parquet	Určuje typ serializace, kterou používá vstup nebo výstup. Požadováno u požadavků PUT (CreateOrReplace).

ReferenceInputProperties

Objekt

Vlastnosti přidružené ke vstupu obsahujícímu referenční data.

Name	Typ	Description
compression	Compression	Popisuje, jak se vstupní data komprimují.
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	Popisuje vstupní zdroj dat, který obsahuje referenční data. Požadováno u požadavků PUT (CreateOrReplace).
diagnostics	Diagnostics	Popisuje podmínky vztahující se na vstup, výstup nebo celkovou úlohu, která zaručuje pozornost zákazníka.
etag	string	Značka aktuální entity pro vstup. Jedná se o neprůhlený řetězec. Můžete ho použít ke zjištění, jestli se prostředek mezi požadavky změnil. Můžete ho také použít v hlavičce If-Match nebo if-None-Match pro operace zápisu pro optimistickou souběžnost.
partitionKey	string	partitionKey popisuje klíč ve vstupních datech, která se používají k dělení vstupních dat.
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Reference	Určuje, zda je vstup zdrojem referenčních dat nebo streamovaných dat. Požadováno u požadavků PUT (CreateOrReplace).

RefreshType

Výčet

Označuje typ možnosti aktualizace dat.

Hodnota	Description
RefreshPeriodicallyWithDelta
RefreshPeriodicallyWithFull
Static

StorageAccount

Objekt

Vlastnosti přidružené k účtu služby Azure Storage

Name	Typ	Description
accountKey	string	Klíč účtu pro účet Azure Storage. Požadováno u požadavků PUT (CreateOrReplace).
accountName	string	Název účtu služby Azure Storage. Požadováno u požadavků PUT (CreateOrReplace).

StreamInputProperties

Objekt

Vlastnosti, které jsou přidružené ke vstupu obsahujícímu data datového proudu.

Name	Typ	Description
compression	Compression	Popisuje, jak se vstupní data komprimují.
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	Popisuje vstupní zdroj dat, který obsahuje streamová data. Požadováno u požadavků PUT (CreateOrReplace).
diagnostics	Diagnostics	Popisuje podmínky vztahující se na vstup, výstup nebo celkovou úlohu, která zaručuje pozornost zákazníka.
etag	string	Značka aktuální entity pro vstup. Jedná se o neprůhlený řetězec. Můžete ho použít ke zjištění, jestli se prostředek mezi požadavky změnil. Můžete ho také použít v hlavičce If-Match nebo if-None-Match pro operace zápisu pro optimistickou souběžnost.
partitionKey	string	partitionKey popisuje klíč ve vstupních datech, která se používají k dělení vstupních dat.
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Popisuje, jak se data ze vstupu serializují nebo jak se data serializují při zápisu do výstupu. Požadováno u požadavků PUT (CreateOrReplace).
type	string: Stream	Určuje, zda je vstup zdrojem referenčních dat nebo streamovaných dat. Požadováno u požadavků PUT (CreateOrReplace).