Outputs - List By Streaming Job

Wyświetla listę wszystkich danych wyjściowych w ramach określonego zadania przesyłania strumieniowego.

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

Parametry identyfikatora URI

Name In Required Type Description
jobName
path True
  • string

Nazwa zadania przesyłania strumieniowego.

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

$select
query
  • string

Parametr zapytania OData $select. Jest to rozdzielona przecinkami lista właściwości strukturalnych do uwzględnienia w odpowiedzi lub "" w celu uwzględnienia wszystkich właściwości. Domyślnie wszystkie właściwości są zwracane z wyjątkiem diagnostyki. Obecnie akceptuje tylko wartość "" jako prawidłową wartość.

Odpowiedzi

Name Type Description
200 OK

Pomyślnie wymieniono dane wyjściowe w określonym zadaniu przesyłania strumieniowego.

Other Status Codes

Błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

List all outputs in a streaming job

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755",
      "name": "output1755",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Sql/Server/Database",
          "properties": {
            "server": "someServer",
            "database": "someDatabase",
            "table": "differentTable",
            "user": "someUser"
          }
        },
        "etag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output958",
      "name": "output958",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/Table",
          "properties": {
            "accountName": "someAccountName",
            "table": "samples",
            "partitionKey": "differentPartitionKey",
            "rowKey": "rowKey",
            "columnsToRemove": [
              "column1",
              "column2"
            ],
            "batchSize": 25
          }
        },
        "etag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1623",
      "name": "output1623",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/Blob",
          "properties": {
            "storageAccounts": [
              {
                "accountName": "someAccountName"
              }
            ],
            "container": "differentContainer",
            "pathPattern": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3022",
      "name": "output3022",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/DocumentDB",
          "properties": {
            "accountId": "someAccountId",
            "database": "db01",
            "collectionNamePattern": "collection",
            "partitionKey": "differentPartitionKey",
            "documentId": "documentId"
          }
        },
        "etag": "7849c132-e995-4631-91c3-931606eec432"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5195",
      "name": "output5195",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/EventHub",
          "properties": {
            "eventHubName": "sdkeventhub",
            "partitionKey": "differentPartitionKey",
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "5020de6b-5bb3-4b88-8606-f11fb3c46185"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3456",
      "name": "output3456",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/Queue",
          "properties": {
            "queueName": "differentQueueName",
            "propertyColumns": [
              "column1",
              "column2"
            ],
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "429adaec-a777-4750-8a39-8d0c931d801c"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output7886",
      "name": "output7886",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/Topic",
          "properties": {
            "topicName": "differentTopicName",
            "propertyColumns": [
              "column1",
              "column2"
            ],
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "c1c2007f-45b2-419a-ae7d-4d2148998460"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3021",
      "name": "output3021",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "PowerBI",
          "properties": {
            "dataset": "differentDataset",
            "table": "someTable",
            "tokenUserPrincipalName": "bobsmith@contoso.com",
            "tokenUserDisplayName": "Bob Smith",
            "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
            "groupName": "MyPowerBIGroup"
          }
        },
        "etag": "4a492191-9672-4178-be10-043b9dbd4b9f"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5196",
      "name": "output5196",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.DataLake/Accounts",
          "properties": {
            "accountName": "differentaccount",
            "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd",
            "tokenUserPrincipalName": "bobsmith@contoso.com",
            "tokenUserDisplayName": "Bob Smith",
            "filePathPrefix": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "39ab7642-8c1e-48ed-85eb-949068d68002"
      }
    }
  ]
}

Definicje

AuthenticationMode

Tryb uwierzytelniania. Prawidłowe tryby to ConnectionString, Msi i "UserToken".

AvroSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania w danych wyjściowych w formacie Avro.

AzureDataLakeStoreOutputDataSource

Opisuje źródło danych wyjściowych usługi Azure Data Lake Store.

AzureFunctionOutputDataSource

Definiuje metadane elementu AzureFunctionOutputDataSource

AzureSqlDatabaseOutputDataSource

Opisuje źródło danych wyjściowych bazy danych Azure SQL.

AzureSynapseOutputDataSource

Opisuje Azure Synapse wyjściowe źródło danych.

AzureTableOutputDataSource

Opisuje źródło danych wyjściowych tabeli platformy Azure.

BlobOutputDataSource

Opisuje źródło danych wyjściowych obiektu blob.

CsvSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania danych wyjściowych w formacie CSV.

DiagnosticCondition

Warunek mający zastosowanie do zasobu lub ogólnego zadania, który gwarantuje uwagę klienta.

Diagnostics

Opisuje warunki dotyczące danych wejściowych, wyjściowych lub ogólnego zadania, które uzasadniają uwagę klienta.

DocumentDbOutputDataSource

Opisuje źródło danych wyjściowych usługi DocumentDB.

Encoding

Określa kodowanie danych przychodzących w przypadku danych wejściowych i kodowania danych wychodzących w przypadku danych wyjściowych.

Error

Typowa reprezentacja błędów.

EventHubOutputDataSource

Opisuje źródło danych wyjściowych centrum zdarzeń.

EventHubV2OutputDataSource

Opisuje źródło danych wyjściowych centrum zdarzeń.

EventSerializationType

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

GatewayMessageBusOutputDataSource

Opisuje źródło danych wyjściowych magistrali komunikatów bramy.

JsonOutputSerializationFormat

Określa format kodu JSON, w który będą zapisywane dane wyjściowe. Obecnie obsługiwane wartości to "lineSeparated", co wskazuje, że dane wyjściowe będą formatowane przez każdy obiekt JSON oddzielony przez nowy wiersz i "tablicę", co wskazuje, że dane wyjściowe zostaną sformatowane jako tablica obiektów JSON.

JsonSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania danych wyjściowych w formacie JSON.

Output

Obiekt wyjściowy zawierający wszystkie informacje skojarzone z nazwanymi danymi wyjściowymi. Wszystkie dane wyjściowe są zawarte w zadaniu przesyłania strumieniowego.

OutputListResult

Obiekt zawierający listę danych wyjściowych w ramach zadania przesyłania strumieniowego.

ParquetSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania w danych wyjściowych w formacie Parquet.

PowerBIOutputDataSource

Opisuje źródło danych wyjściowych usługi Power BI.

ServiceBusQueueOutputDataSource

Opisuje źródło danych wyjściowych kolejki usługi Service Bus.

ServiceBusTopicOutputDataSource

Opisuje źródło danych wyjściowych tematu usługi Service Bus.

StorageAccount

Właściwości skojarzone z kontem usługi Azure Storage

AuthenticationMode

Tryb uwierzytelniania. Prawidłowe tryby to ConnectionString, Msi i "UserToken".

Name Type Description
ConnectionString
  • string
Msi
  • string
UserToken
  • string

AvroSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania w danych wyjściowych w formacie Avro.

Name Type Description
type string:
  • Avro

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

AzureDataLakeStoreOutputDataSource

Opisuje źródło danych wyjściowych usługi Azure Data Lake Store.

Name Type Default Value Description
properties.accountName
  • string

Nazwa konta usługi Azure Data Lake Store. Wymagane w żądaniach PUT (CreateOrReplace).

properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.dateFormat
  • string

Format daty. Gdziekolwiek {date} pojawia się w plikuPathPrefix, wartość tej właściwości jest używana jako format daty.

properties.filePathPrefix
  • string

Lokalizacja pliku, do którego powinny być zapisywane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

properties.refreshToken
  • string

Token odświeżania, którego można użyć do uzyskania prawidłowego tokenu dostępu, który może następnie służyć do uwierzytelniania w źródle danych. Prawidłowy token odświeżania jest obecnie dostępny tylko za pośrednictwem witryny Azure Portal. Zaleca się umieszczenie w tym miejscu fikcyjnej wartości ciągu podczas tworzenia źródła danych, a następnie przejście do witryny Azure Portal w celu uwierzytelnienia źródła danych, które zaktualizuje tę właściwość przy użyciu prawidłowego tokenu odświeżania. Wymagane w żądaniach PUT (CreateOrReplace).

properties.tenantId
  • string

Identyfikator dzierżawy użytkownika użyty do uzyskania tokenu odświeżania. Wymagane w żądaniach PUT (CreateOrReplace).

properties.timeFormat
  • string

Format czasu. Wszędzie tam, gdzie {time} pojawia się w plikuPathPrefix, wartość tej właściwości jest używana jako format czasu.

properties.tokenUserDisplayName
  • string

Nazwa wyświetlana użytkownika użyta do uzyskania tokenu odświeżania. Użyj tej właściwości, aby ułatwić zapamiętanie, którego użytkownika użyto do uzyskania tokenu odświeżania.

properties.tokenUserPrincipalName
  • string

Główna nazwa użytkownika (UPN) użytkownika, który został użyty do uzyskania tokenu odświeżania. Użyj tej właściwości, aby ułatwić zapamiętanie, którego użytkownika użyto do uzyskania tokenu odświeżania.

type string:
  • Microsoft.DataLake/Accounts

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Definiuje metadane elementu AzureFunctionOutputDataSource

Name Type Description
properties.apiKey
  • string

Jeśli chcesz użyć funkcji platformy Azure z innej subskrypcji, możesz to zrobić, podając klucz umożliwiający dostęp do funkcji.

properties.functionAppName
  • string

Nazwa aplikacji Azure Functions.

properties.functionName
  • string

Nazwa funkcji w aplikacji Azure Functions.

properties.maxBatchCount
  • number

Właściwość, która umożliwia określenie maksymalnej liczby zdarzeń w każdej partii wysyłanej do Azure Functions. Wartość domyślna to 100.

properties.maxBatchSize
  • number

Właściwość, która umożliwia ustawienie maksymalnego rozmiaru dla każdej partii wyjściowej wysyłanej do funkcji platformy Azure. Jednostka wejściowa jest w bajtach. Domyślnie ta wartość to 262 144 bajtów (256 KB).

type string:
  • Microsoft.AzureFunction

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

Opisuje źródło danych wyjściowych bazy danych Azure SQL.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.database
  • string

Nazwa bazy danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.maxBatchCount
  • number

Maksymalna liczba partii zapisu w bazie danych Sql, wartość domyślna to 10 000. Opcjonalnie w żądaniach PUT.

properties.maxWriterCount
  • number

Maksymalna liczba składników zapisywania, obecnie dostępne są tylko 1(pojedynczy moduł zapisywania) i 0 (na podstawie partycji zapytania). Opcjonalnie w żądaniach PUT.

properties.password
  • string

Hasło, które będzie używane do nawiązywania połączenia z bazą danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.server
  • string

Nazwa serwera SQL zawierającego bazę danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.table
  • string

Nazwa tabeli w bazie danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.user
  • string

Nazwa użytkownika, która będzie używana do nawiązywania połączenia z bazą danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/Database

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

AzureSynapseOutputDataSource

Opisuje Azure Synapse wyjściowe źródło danych.

Name Type Description
properties.database
  • string

Nazwa bazy danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.password
  • string

Hasło, które będzie używane do nawiązywania połączenia z bazą danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.server
  • string

Nazwa serwera SQL zawierającego bazę danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.table
  • string

Nazwa tabeli w bazie danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

properties.user
  • string

Nazwa użytkownika, która będzie używana do nawiązywania połączenia z bazą danych Azure SQL. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/DataWarehouse

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

AzureTableOutputDataSource

Opisuje źródło danych wyjściowych tabeli platformy Azure.

Name Type Description
properties.accountKey
  • string

Klucz konta dla konta usługi Azure Storage. Wymagane w żądaniach PUT (CreateOrReplace).

properties.accountName
  • string

Nazwa konta usługi Azure Storage. Wymagane w żądaniach PUT (CreateOrReplace).

properties.batchSize
  • integer

Liczba wierszy do zapisu w tabeli platformy Azure naraz.

properties.columnsToRemove
  • string[]

Jeśli zostanie określony, każdy element w tablicy jest nazwą kolumny do usunięcia (jeśli istnieje) z jednostek zdarzeń wyjściowych.

properties.partitionKey
  • string

Ten element wskazuje nazwę kolumny z instrukcji SELECT w zapytaniu, które będzie używane jako klucz partycji dla tabeli platformy Azure. Wymagane w żądaniach PUT (CreateOrReplace).

properties.rowKey
  • string

Ten element wskazuje nazwę kolumny z instrukcji SELECT w zapytaniu, które będzie używane jako klucz wiersza dla tabeli platformy Azure. Wymagane w żądaniach PUT (CreateOrReplace).

properties.table
  • string

Nazwa tabeli platformy Azure. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.Storage/Table

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

BlobOutputDataSource

Opisuje źródło danych wyjściowych obiektu blob.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.blobPathPrefix
  • string

Prefiks ścieżki obiektu blob.

properties.container
  • string

Nazwa kontenera w skojarzonym koncie magazynu. Ten kontener zawiera obiekty blob do odczytu lub zapisu. Wymagane w żądaniach PUT (CreateOrReplace).

properties.dateFormat
  • string

Format daty. Gdziekolwiek {date} pojawia się w ścieżcePattern, wartość tej właściwości jest używana jako format daty.

properties.pathPattern
  • string

Wzorzec ścieżki obiektu blob. Nie jest wyrażeniem regularnym. Reprezentuje on wzorzec, dla którego nazwy obiektów blob będą dopasowywane w celu określenia, czy powinny być uwzględniane jako dane wejściowe lub wyjściowe zadania. Zobacz https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input lub https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output , aby uzyskać bardziej szczegółowe wyjaśnienie i przykład.

properties.storageAccounts

Lista co najmniej jednego konta usługi Azure Storage. Wymagane w żądaniach PUT (CreateOrReplace).

properties.timeFormat
  • string

Format czasu. Gdziekolwiek {time} pojawia się w ścieżcePattern, wartość tej właściwości jest używana jako format czasu.

type string:
  • Microsoft.Storage/Blob

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

CsvSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania danych wyjściowych w formacie CSV.

Name Type Description
properties.encoding

Określa kodowanie danych przychodzących w przypadku danych wejściowych i kodowania danych wychodzących w przypadku danych wyjściowych. Wymagane w żądaniach PUT (CreateOrReplace).

properties.fieldDelimiter
  • string

Określa ogranicznik, który będzie używany do oddzielania rekordów wartości rozdzielanych przecinkami (CSV). Zobacz https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input lub https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output , aby uzyskać listę obsługiwanych wartości. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Csv

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

DiagnosticCondition

Warunek mający zastosowanie do zasobu lub ogólnego zadania, który gwarantuje uwagę klienta.

Name Type Description
code
  • string

Nieprzezroczysty kod diagnostyczny.

message
  • string

Czytelny dla człowieka komunikat opisujący szczegółowo warunek. Zlokalizowane w Accept-Language żądania klienta.

since
  • string

Sygnatura czasowa UTC czasu rozpoczęcia warunku. Klienci powinni mieć możliwość znalezienia odpowiedniego zdarzenia w dzienniku operacji w tym czasie.

Diagnostics

Opisuje warunki dotyczące danych wejściowych, wyjściowych lub ogólnego zadania, które uzasadniają uwagę klienta.

Name Type Description
conditions

Kolekcja zera lub większej liczby warunków mających zastosowanie do zasobu lub zadania ogólnego, które uzasadniają uwagę klienta.

DocumentDbOutputDataSource

Opisuje źródło danych wyjściowych usługi DocumentDB.

Name Type Description
properties.accountId
  • string

Nazwa lub identyfikator konta usługi DocumentDB. Wymagane w żądaniach PUT (CreateOrReplace).

properties.accountKey
  • string

Klucz konta dla konta usługi DocumentDB. Wymagane w żądaniach PUT (CreateOrReplace).

properties.collectionNamePattern
  • string

Wzorzec nazwy kolekcji do użycia. Format nazwy kolekcji można skonstruować przy użyciu opcjonalnego tokenu {partition}, w którym partycje zaczynają się od 0. Aby uzyskać więcej informacji, zobacz sekcję https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output usługi DocumentDB. Wymagane w żądaniach PUT (CreateOrReplace).

properties.database
  • string

Nazwa bazy danych DocumentDB. Wymagane w żądaniach PUT (CreateOrReplace).

properties.documentId
  • string

Nazwa pola w zdarzeniach wyjściowych używanych do określenia klucza podstawowego, na którym opierają się operacje wstawiania lub aktualizowania.

properties.partitionKey
  • string

Nazwa pola w zdarzeniach wyjściowych używanych do określania klucza do partycjonowania danych wyjściowych w kolekcjach. Jeśli element "collectionNamePattern" zawiera token {partition}, ta właściwość jest wymagana do określenia.

type string:
  • Microsoft.Storage/DocumentDB

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

Encoding

Określa kodowanie danych przychodzących w przypadku danych wejściowych i kodowania danych wychodzących w przypadku danych wyjściowych.

Name Type Description
UTF8
  • string

Error

Typowa reprezentacja błędów.

Name Type Description
error

Właściwości definicji błędu.

EventHubOutputDataSource

Opisuje źródło danych wyjściowych centrum zdarzeń.

Name Type Default Value Description
authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.eventHubName
  • string

Nazwa centrum zdarzeń. Wymagane w żądaniach PUT (CreateOrReplace).

properties.partitionKey
  • string

Klucz/kolumna, która służy do określania, która partycja ma wysyłać dane zdarzenia.

properties.propertyColumns
  • string[]

Właściwości skojarzone z danymi wyjściowymi tego centrum zdarzeń.

serviceBusNamespace
  • string

Przestrzeń nazw skojarzona z żądanym centrum zdarzeń, kolejką usługi Service Bus, tematem usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

Klucz zasad dostępu współdzielonego dla określonych zasad dostępu współdzielonego. Wymagane w żądaniach PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

Nazwa zasad dostępu współdzielonego dla centrum zdarzeń, kolejki usługi Service Bus, tematu usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/EventHub

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

EventHubV2OutputDataSource

Opisuje źródło danych wyjściowych centrum zdarzeń.

Name Type Default Value Description
authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.eventHubName
  • string

Nazwa centrum zdarzeń. Wymagane w żądaniach PUT (CreateOrReplace).

properties.partitionKey
  • string

Klucz/kolumna, która służy do określania, która partycja ma wysyłać dane zdarzenia.

properties.propertyColumns
  • string[]

Właściwości skojarzone z danymi wyjściowymi tego centrum zdarzeń.

serviceBusNamespace
  • string

Przestrzeń nazw skojarzona z żądanym centrum zdarzeń, kolejką usługi Service Bus, tematem usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

Klucz zasad dostępu współdzielonego dla określonych zasad dostępu współdzielonego. Wymagane w żądaniach PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

Nazwa zasad dostępu współdzielonego dla centrum zdarzeń, kolejki usługi Service Bus, tematu usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.EventHub/EventHub

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

EventSerializationType

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

Name Type Description
Avro
  • string
Csv
  • string
Json
  • string
Parquet
  • string

GatewayMessageBusOutputDataSource

Opisuje źródło danych wyjściowych magistrali komunikatów bramy.

Name Type Description
properties.topic
  • string

Nazwa tematu usługi Service Bus.

type string:
  • GatewayMessageBus

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

JsonOutputSerializationFormat

Określa format kodu JSON, w który będą zapisywane dane wyjściowe. Obecnie obsługiwane wartości to "lineSeparated", co wskazuje, że dane wyjściowe będą formatowane przez każdy obiekt JSON oddzielony przez nowy wiersz i "tablicę", co wskazuje, że dane wyjściowe zostaną sformatowane jako tablica obiektów JSON.

Name Type Description
Array
  • string
LineSeparated
  • string

JsonSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania danych wyjściowych w formacie JSON.

Name Type Description
properties.encoding

Określa kodowanie danych przychodzących w przypadku danych wejściowych i kodowania danych wychodzących w przypadku danych wyjściowych. Wymagane w żądaniach PUT (CreateOrReplace).

properties.format

Ta właściwość dotyczy tylko serializacji danych wyjściowych w formacie JSON. Nie ma zastosowania do danych wejściowych. Ta właściwość określa format kodu JSON, w który będą zapisywane dane wyjściowe. Obecnie obsługiwane wartości to "lineSeparated", co wskazuje, że dane wyjściowe będą formatowane przez każdy obiekt JSON oddzielony przez nowy wiersz i "tablicę", co wskazuje, że dane wyjściowe zostaną sformatowane jako tablica obiektów JSON. Wartość domyślna to "lineSeparated", jeśli pozostawiono wartość null.

type string:
  • Json

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

Output

Obiekt wyjściowy zawierający wszystkie informacje skojarzone z nazwanymi danymi wyjściowymi. Wszystkie dane wyjściowe są zawarte w zadaniu przesyłania strumieniowego.

Name Type Description
id
  • string

Identyfikator zasobu

name
  • string

Nazwa zasobu

properties.datasource OutputDataSource:

Opisuje źródło danych, do którego zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

properties.diagnostics

Opisuje warunki dotyczące danych wejściowych, wyjściowych lub ogólnego zadania, które uzasadniają uwagę klienta.

properties.etag
  • string

Bieżący tag jednostki dla danych wyjściowych. Jest to nieprzezroczystych ciągów. Można go użyć do wykrywania, czy zasób zmienił się między żądaniami. Można go również użyć w nagłówkach If-Match lub If-None-Match na potrzeby operacji zapisu na potrzeby optymistycznej współbieżności.

properties.serialization Serialization:

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania w danych wyjściowych. Wymagane w żądaniach PUT (CreateOrReplace).

properties.sizeWindow
  • number

Okno rozmiaru umożliwiające ograniczenie danych wyjściowych usługi Stream Analytics do.

properties.timeWindow
  • string

Przedział czasu filtrowania danych wyjściowych zadania usługi Stream Analytics.

type
  • string

Typ zasobu

OutputListResult

Obiekt zawierający listę danych wyjściowych w ramach zadania przesyłania strumieniowego.

Name Type Description
nextLink
  • string

Link (adres URL) do następnej strony wyników.

value

Lista danych wyjściowych w ramach zadania przesyłania strumieniowego. Wypełnione przez operację "Lista".

ParquetSerialization

Opisuje sposób serializacji danych wejściowych lub serializacji danych podczas zapisywania w danych wyjściowych w formacie Parquet.

Name Type Description
type string:
  • Parquet

Wskazuje typ serializacji używanej przez dane wejściowe lub wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

PowerBIOutputDataSource

Opisuje źródło danych wyjściowych usługi Power BI.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.dataset
  • string

Nazwa zestawu danych usługi Power BI. Wymagane w żądaniach PUT (CreateOrReplace).

properties.groupId
  • string

Identyfikator grupy usługi Power BI.

properties.groupName
  • string

Nazwa grupy usługi Power BI. Użyj tej właściwości, aby ułatwić zapamiętanie określonego identyfikatora grupy usługi Power BI.

properties.refreshToken
  • string

Token odświeżania, którego można użyć do uzyskania prawidłowego tokenu dostępu, który może następnie służyć do uwierzytelniania w źródle danych. Prawidłowy token odświeżania jest obecnie dostępny tylko za pośrednictwem witryny Azure Portal. Zaleca się umieszczenie w tym miejscu fikcyjnej wartości ciągu podczas tworzenia źródła danych, a następnie przejście do witryny Azure Portal w celu uwierzytelnienia źródła danych, które zaktualizuje tę właściwość przy użyciu prawidłowego tokenu odświeżania. Wymagane w żądaniach PUT (CreateOrReplace).

properties.table
  • string

Nazwa tabeli usługi Power BI w określonym zestawie danych. Wymagane w żądaniach PUT (CreateOrReplace).

properties.tokenUserDisplayName
  • string

Nazwa wyświetlana użytkownika użyta do uzyskania tokenu odświeżania. Użyj tej właściwości, aby ułatwić zapamiętanie, którego użytkownika użyto do uzyskania tokenu odświeżania.

properties.tokenUserPrincipalName
  • string

Główna nazwa użytkownika (UPN) użytkownika, który został użyty do uzyskania tokenu odświeżania. Użyj tej właściwości, aby ułatwić zapamiętanie, którego użytkownika użyto do uzyskania tokenu odświeżania.

type string:
  • PowerBI

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

Opisuje źródło danych wyjściowych kolejki usługi Service Bus.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.propertyColumns
  • string[]

Tablica ciągów nazw kolumn wyjściowych, które mają być dołączone do komunikatów usługi Service Bus jako właściwości niestandardowych.

properties.queueName
  • string

Nazwa kolejki usługi Service Bus. Wymagane w żądaniach PUT (CreateOrReplace).

properties.serviceBusNamespace
  • string

Przestrzeń nazw skojarzona z żądanym centrum zdarzeń, kolejką usługi Service Bus, tematem usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

Klucz zasad dostępu współdzielonego dla określonych zasad dostępu współdzielonego. Wymagane w żądaniach PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

Nazwa zasad dostępu współdzielonego dla centrum zdarzeń, kolejki usługi Service Bus, tematu usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

Właściwości systemu skojarzone z kolejką usługi Service Bus. Obsługiwane są następujące właściwości systemowe: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

type string:
  • Microsoft.ServiceBus/Queue

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Opisuje źródło danych wyjściowych tematu usługi Service Bus.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Tryb uwierzytelniania.

properties.propertyColumns
  • string[]

Tablica ciągów nazw kolumn wyjściowych, które mają być dołączone do komunikatów usługi Service Bus jako właściwości niestandardowych.

properties.serviceBusNamespace
  • string

Przestrzeń nazw skojarzona z żądanym centrum zdarzeń, kolejką usługi Service Bus, tematem usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

Klucz zasad dostępu współdzielonego dla określonych zasad dostępu współdzielonego. Wymagane w żądaniach PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

Nazwa zasad dostępu współdzielonego dla centrum zdarzeń, kolejki usługi Service Bus, tematu usługi Service Bus itp. Wymagane w żądaniach PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

Właściwości systemu skojarzone z danymi wyjściowymi tematu usługi Service Bus. Obsługiwane są następujące właściwości systemowe: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

properties.topicName
  • string

Nazwa tematu usługi Service Bus. Wymagane w żądaniach PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/Topic

Wskazuje typ danych wyjściowych źródła danych, do których zostaną zapisane dane wyjściowe. Wymagane w żądaniach PUT (CreateOrReplace).

StorageAccount

Właściwości skojarzone z kontem usługi Azure Storage

Name Type Description
accountKey
  • string

Klucz konta dla konta usługi Azure Storage. Wymagane w żądaniach PUT (CreateOrReplace).

accountName
  • string

Nazwa konta usługi Azure Storage. Wymagane w żądaniach PUT (CreateOrReplace).