Inputs - Get

Servicio:: Stream Analytics

Versión de la API:: 2020-03-01

Obtiene detalles sobre la entrada especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
inputName	path	True	string	Nombre de la entrada.
jobName	path	True	string	Nombre del trabajo de streaming.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Input	Se recuperó correctamente la entrada especificada. Encabezados ETag: string
Other Status Codes	Error	Error.

Nombre

Tipo

Description

200 OK

Input

Se recuperó correctamente la entrada especificada.

Encabezados

ETag: string

Other Status Codes

Error

Error.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AuthenticationMode	Modo de autenticación. Los modos válidos son `ConnectionString`, `Msi` y "UserToken".
AvroSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Avro.
AzureSqlReferenceInputDataSource	Describe un origen de datos de entrada de referencia de base de datos de Azure SQL.
BlobReferenceInputDataSource	Describe un origen de datos de entrada de blobs que contiene datos de referencia.
BlobStreamInputDataSource	Describe un origen de datos de entrada de blobs que contiene datos de flujo.
Compression	Describe cómo se comprimen los datos de entrada.
CompressionType	Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).
CsvSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato CSV.
DiagnosticCondition	Condición aplicable al recurso, o al trabajo en general, que garantiza la atención al cliente.
Diagnostics	Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan atención al cliente.
Encoding	Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida.
Error	Representación de error común.
EventHubStreamInputDataSource	Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.
EventHubV2StreamInputDataSource	Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.
EventSerializationType	Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
FileReferenceInputDataSource	Describe un origen de datos de entrada de archivo que contiene datos de referencia.
GatewayMessageBusStreamInputDataSource	Describe un origen de datos de entrada de blobs que contiene datos de flujo.
Input	Objeto de entrada que contiene toda la información asociada a la entrada con nombre. Todas las entradas están contenidas en un trabajo de streaming.
IoTHubStreamInputDataSource	Describe un origen de datos de entrada de IoT Hub que contiene datos de flujo.
JsonOutputSerializationFormat	Especifica el formato del json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se formateará con cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se formateará como una matriz de objetos JSON.
JsonSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato JSON.
ParquetSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Parquet.
ReferenceInputProperties	Propiedades asociadas a una entrada que contiene datos de referencia.
RefreshType	Indica el tipo de opción de actualización de datos.
StorageAccount	Las propiedades asociadas a una cuenta de Azure Storage
StreamInputProperties	Propiedades asociadas a una entrada que contiene datos de flujo.

AuthenticationMode

Enumeración

Modo de autenticación. Los modos válidos son ConnectionString, Msi y "UserToken".

Valor	Description
Msi
UserToken
ConnectionString

AvroSerialization

Object

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Avro.

Nombre	Tipo	Description
type	string: Avro	Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Object

Describe un origen de datos de entrada de referencia de base de datos de Azure SQL.

Nombre	Tipo	Description
properties.database	string	Este elemento está asociado al elemento de origen de datos. Este es el nombre de la base de datos en la que se escribirá la salida.
properties.deltaSnapshotQuery	string	Este elemento está asociado al elemento de origen de datos. Esta consulta se usa para capturar los cambios incrementales de la base de datos SQL. Para usar esta opción, se recomienda usar tablas temporales en Azure SQL Database.
properties.fullSnapshotQuery	string	Este elemento está asociado al elemento de origen de datos. Esta consulta se usa para capturar datos de la base de datos sql.
properties.password	string	Este elemento está asociado al elemento de origen de datos. Esta es la contraseña que se usará para conectarse a la instancia de SQL Database.
properties.refreshRate	string	Este elemento está asociado al elemento de origen de datos. Esto indica la frecuencia con la que se capturarán los datos de la base de datos. Es de formato DateTime.
properties.refreshType	RefreshType	Indica el tipo de opción de actualización de datos.
properties.server	string	Este elemento está asociado al elemento de origen de datos. Este es el nombre del servidor que contiene la base de datos en la que se escribirá.
properties.table	string	Este elemento está asociado al elemento de origen de datos. Nombre de la tabla en la base de datos de Azure SQL.
properties.user	string	Este elemento está asociado al elemento de origen de datos. Este es el nombre de usuario que se usará para conectarse a la instancia de SQL Database.
type	string: Microsoft.Sql/Server/Database	Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

BlobReferenceInputDataSource

Object

Describe un origen de datos de entrada de blobs que contiene datos de referencia.

Nombre	Tipo	Valor predeterminado	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Modo de autenticación.
properties.container	string		Nombre de un contenedor dentro de la cuenta de almacenamiento asociada. Este contenedor contiene los blobs en los que se van a leer o escribir. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.dateFormat	string		Formato de fecha. Siempre que {date} aparezca en pathPattern, el valor de esta propiedad se usa como formato de fecha en su lugar.
properties.pathPattern	string		Patrón de ruta de acceso del blob. No es una expresión regular. Representa un patrón con el que se coincidirán los nombres de blobs para determinar si se deben incluir como entrada o salida en el trabajo. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una explicación y un ejemplo más detallados.
properties.storageAccounts	StorageAccount[]		Lista de una o varias cuentas de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.timeFormat	string		Formato de hora. Siempre que aparezca {time} en pathPattern, el valor de esta propiedad se usa como formato de hora en su lugar.
type	string: Microsoft.Storage/Blob		Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

BlobStreamInputDataSource

Object

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Nombre	Tipo	Valor predeterminado	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Modo de autenticación.
properties.container	string		Nombre de un contenedor dentro de la cuenta de almacenamiento asociada. Este contenedor contiene los blobs en los que se van a leer o escribir. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.dateFormat	string		Formato de fecha. Siempre que {date} aparezca en pathPattern, el valor de esta propiedad se usa como formato de fecha en su lugar.
properties.pathPattern	string		Patrón de ruta de acceso del blob. No es una expresión regular. Representa un patrón con el que se coincidirán los nombres de blobs para determinar si se deben incluir como entrada o salida en el trabajo. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una explicación y un ejemplo más detallados.
properties.sourcePartitionCount	integer (int32)		Recuento de particiones del origen de datos de entrada del blob. Intervalo 1 - 1024.
properties.storageAccounts	StorageAccount[]		Lista de una o varias cuentas de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.timeFormat	string		Formato de hora. Siempre que aparezca {time} en pathPattern, el valor de esta propiedad se usa como formato de hora en su lugar.
type	string: Microsoft.Storage/Blob		Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

Compression

Object

Describe cómo se comprimen los datos de entrada.

Nombre	Tipo	Valor predeterminado	Description
type	CompressionType	None	Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

CompressionType

Enumeración

Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

Valor	Description
None
GZip
Deflate

CsvSerialization

Object

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato CSV.

Nombre	Tipo	Description
properties.encoding	Encoding	Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.fieldDelimiter	string	Especifica el delimitador que se usará para separar los registros de valores separados por comas (CSV). Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una lista de valores admitidos. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Csv	Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

DiagnosticCondition

Object

Condición aplicable al recurso, o al trabajo en general, que garantiza la atención al cliente.

Nombre	Tipo	Description
code	string	Código de diagnóstico opaco.
message	string	Mensaje legible que describe la condición con detalle. Localizado en el Accept-Language de la solicitud de cliente.
since	string	Marca de tiempo UTC de cuando se inició la condición. Los clientes deben poder encontrar un evento correspondiente en el registro de operaciones en este momento.

Diagnostics

Object

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan atención al cliente.

Nombre	Tipo	Description
conditions	DiagnosticCondition[]	Colección de cero o más condiciones aplicables al recurso, o al trabajo en general, que garantizan atención al cliente.

Encoding

Enumeración

Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida.

Valor	Description
UTF8

Error

Object

Representación de error común.

Nombre	Tipo	Description
error	Error	Propiedades de definición de error.

EventHubStreamInputDataSource

Object

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

Nombre	Tipo	Valor predeterminado	Description
authenticationMode	AuthenticationMode	ConnectionString	Modo de autenticación.
properties.consumerGroupName	string		Nombre de un grupo de consumidores del centro de eventos que se debe usar para leer eventos del centro de eventos. Especificar nombres de grupo de consumidores distintos para varias entradas permite que cada una de esas entradas reciba los mismos eventos del Centro de eventos. Si no se especifica, la entrada usa el grupo de consumidores predeterminado del centro de eventos.
properties.eventHubName	string		Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).
serviceBusNamespace	string		Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).
sharedAccessPolicyKey	string		Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).
sharedAccessPolicyName	string		El nombre de la directiva de acceso compartido para el centro de eventos, la cola de Service Bus, el tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Microsoft.ServiceBus/EventHub		Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventHubV2StreamInputDataSource

Object

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

Nombre	Tipo	Valor predeterminado	Description
authenticationMode	AuthenticationMode	ConnectionString	Modo de autenticación.
properties.consumerGroupName	string		Nombre de un grupo de consumidores del centro de eventos que se debe usar para leer eventos del centro de eventos. Especificar nombres de grupo de consumidores distintos para varias entradas permite que cada una de esas entradas reciba los mismos eventos del Centro de eventos. Si no se especifica, la entrada usa el grupo de consumidores predeterminado del centro de eventos.
properties.eventHubName	string		Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).
serviceBusNamespace	string		Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).
sharedAccessPolicyKey	string		Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).
sharedAccessPolicyName	string		El nombre de la directiva de acceso compartido para el centro de eventos, la cola de Service Bus, el tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Microsoft.EventHub/EventHub		Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventSerializationType

Enumeración

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

Valor	Description
Csv
Avro
Json
Parquet

FileReferenceInputDataSource

Object

Describe un origen de datos de entrada de archivo que contiene datos de referencia.

Nombre	Tipo	Description
properties.path	string	Ruta de acceso del archivo.
type	string: File	Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Object

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Nombre	Tipo	Description
properties.topic	string	Nombre del tema de Service Bus.
type	string: GatewayMessageBus	Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

Input

Object

Objeto de entrada que contiene toda la información asociada a la entrada con nombre. Todas las entradas están contenidas en un trabajo de streaming.

Nombre	Tipo	Description
id	string	Identificador de recurso
name	string	Nombre del recurso
properties	InputProperties: ReferenceInputProperties StreamInputProperties	Propiedades asociadas a una entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string	Tipo de recurso

IoTHubStreamInputDataSource

Object

Describe un origen de datos de entrada de IoT Hub que contiene datos de flujo.

Nombre	Tipo	Description
properties.consumerGroupName	string	Nombre de un grupo de consumidores de IoT Hub que se debe usar para leer eventos de IoT Hub. Si no se especifica, la entrada usa el grupo de consumidores predeterminado de Iot Hub.
properties.endpoint	string	El punto de conexión de IoT Hub al que conectarse (es decir, mensajes/eventos, messages/operationsMonitoringEvents, etc.).
properties.iotHubNamespace	string	El nombre o el URI de IoT Hub. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.sharedAccessPolicyKey	string	Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.sharedAccessPolicyName	string	Nombre de la directiva de acceso compartido para IoT Hub. Esta directiva debe contener al menos el permiso de conexión de servicio. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Microsoft.Devices/IotHubs	Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

JsonOutputSerializationFormat

Enumeración

Especifica el formato del json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se formateará con cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se formateará como una matriz de objetos JSON.

Valor	Description
LineSeparated
Array

JsonSerialization

Object

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato JSON.

Nombre	Tipo	Description
properties.encoding	Encoding	Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.format	JsonOutputSerializationFormat	Esta propiedad solo se aplica a la serialización JSON de salidas. No es aplicable a las entradas. Esta propiedad especifica el formato de JSON en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se formateará con cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se formateará como una matriz de objetos JSON. El valor predeterminado es "lineSeparated" si se deja null.
type	string: Json	Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

ParquetSerialization

Object

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Parquet.

Nombre	Tipo	Description
type	string: Parquet	Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

ReferenceInputProperties

Object

Propiedades asociadas a una entrada que contiene datos de referencia.

Nombre	Tipo	Description
compression	Compression	Describe cómo se comprimen los datos de entrada.
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	Describe un origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).
diagnostics	Diagnostics	Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan atención al cliente.
etag	string	Etiqueta de entidad actual para la entrada. Se trata de una cadena opaca. Puede usarlo para detectar si el recurso ha cambiado entre solicitudes. También puede usarlo en los encabezados If-Match o If-None-Match para operaciones de escritura para simultaneidad optimista.
partitionKey	string	partitionKey Describe una clave en los datos de entrada que se usan para crear particiones de los datos de entrada.
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Reference	Indica si la entrada es un origen de datos de referencia o datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

RefreshType

Enumeración

Indica el tipo de opción de actualización de datos.

Valor	Description
Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

StorageAccount

Object

Las propiedades asociadas a una cuenta de Azure Storage

Nombre	Tipo	Description
accountKey	string	Clave de cuenta de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).
accountName	string	Nombre de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).

StreamInputProperties

Object

Propiedades asociadas a una entrada que contiene datos de flujo.

Nombre	Tipo	Description
compression	Compression	Describe cómo se comprimen los datos de entrada.
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	Describe un origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).
diagnostics	Diagnostics	Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan atención al cliente.
etag	string	Etiqueta de entidad actual para la entrada. Se trata de una cadena opaca. Puede usarlo para detectar si el recurso ha cambiado entre solicitudes. También puede usarlo en los encabezados If-Match o If-None-Match para operaciones de escritura para simultaneidad optimista.
partitionKey	string	partitionKey Describe una clave en los datos de entrada que se usan para crear particiones de los datos de entrada.
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
type	string: Stream	Indica si la entrada es un origen de datos de referencia o datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

Compartir a través de

Inputs - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get a reference blob input with CSV serialization

Solicitud de ejemplo

Respuesta de muestra

Get a stream blob input with CSV serialization

Solicitud de ejemplo

Respuesta de muestra

Get a stream Event Hub input with JSON serialization

Solicitud de ejemplo

Respuesta de muestra

Get a stream IoT Hub input with Avro serialization

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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