Outputs - Create Or Replace

  • Referencia
Service:
Stream Analytics
API Version:
2020-03-01

Crea una salida o reemplaza una salida ya existente en un trabajo de streaming existente.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
jobName
 path True

string

Nombre del trabajo de streaming.
outputName
 path True

string

Nombre de la salida.
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

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

string

Identificador de la suscripción de destino.
api-version
 query True

string

Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
If-Match

string

ETag de la salida. Omita este valor para sobrescribir siempre la salida actual. Especifique el último valor de ETag visto para evitar que se sobrescriba accidentalmente los cambios simultáneos.
If-None-Match

string

Establézcalo en "*" para permitir la creación de una nueva salida, pero para evitar la actualización de una salida existente. Otros valores darán como resultado una respuesta 412 Con error de condición previa.

Cuerpo de la solicitud

Nombre Tipo Description
name

string

Nombre del recurso
properties.datasource OutputDataSource:

Describe el origen de datos en el que se escribirá la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.serialization Serialization:

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).
properties.sizeWindow

integer

Ventana de tamaño a la que se va a restringir una salida de Stream Analytics.
properties.timeWindow

string

Período de tiempo para filtrar las salidas del trabajo de Stream Analytics.

Respuestas

Nombre Tipo Description
200 OK

Output

La salida se ha creado o reemplazado correctamente.

Headers

ETag: string
201 Created

Output

La salida se ha creado o reemplazado correctamente.

Headers

ETag: string
Other Status Codes

Error

Error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Create a blob output with CSV serialization
Create a DocumentDB output
Create a Gateway Message Bus output
Create a Power BI output
Create a Service Bus Queue output with Avro serialization
Create a Service Bus Topic output with CSV serialization
Create an Azure Data Lake Store output with JSON serialization
Create an Azure Data Warehouse output
Create an Azure Function output
Create an Azure SQL database output
Create an Azure Table output
Create an Event Hub output with JSON serialization

Create a blob output with CSV serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "storageAccounts": [
          {
            "accountName": "someAccountName",
            "accountKey": "accountKey=="
          }
        ],
        "container": "state",
        "pathPattern": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 5433fd97-d133-46e3-8588-5fe1f1599ee0
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623",
  "name": "output1623",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "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"
      }
    }
  }
}
Status code:
200 
ETag: 5433fd97-d133-46e3-8588-5fe1f1599ee0
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623",
  "name": "output1623",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "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"
      }
    }
  }
}

Create a DocumentDB output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "accountId": "someAccountId",
        "accountKey": "accountKey==",
        "database": "db01",
        "collectionNamePattern": "collection",
        "partitionKey": "key",
        "documentId": "documentId"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "accountId": "someAccountId",
        "database": "db01",
        "collectionNamePattern": "collection",
        "partitionKey": "key",
        "documentId": "documentId"
      }
    }
  }
}
Status code:
200 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "accountId": "someAccountId",
        "database": "db01",
        "collectionNamePattern": "collection",
        "partitionKey": "key",
        "documentId": "documentId"
      }
    }
  }
}

Create a Gateway Message Bus output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "GatewayMessageBus",
      "properties": {
        "topic": "EdgeTopic1"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "GatewayMessageBus",
      "properties": {
        "topic": "EdgeTopic1"
      }
    }
  }
}
Status code:
200 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "GatewayMessageBus",
      "properties": {
        "topic": "EdgeTopic1"
      }
    }
  }
}

Create a Power BI output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "someDataset",
        "table": "someTable",
        "refreshToken": "someRefreshToken==",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
        "groupName": "MyPowerBIGroup"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "someDataset",
        "table": "someTable",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
        "groupName": "MyPowerBIGroup"
      }
    }
  }
}
Status code:
200 
ETag: ccf8b864-259e-43c5-a628-ba10858b2c07
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "someDataset",
        "table": "someTable",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
        "groupName": "MyPowerBIGroup"
      }
    }
  }
}

Create a Service Bus Queue output with Avro serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey",
        "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
        "queueName": "sdkqueue",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "systemPropertyColumns": {
          "MessageId": "col3",
          "PartitionKey": "col4"
        }
      }
    },
    "serialization": {
      "type": "Avro"
    }
  }
}

Sample Response

Status code:
201 
ETag: 2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456",
  "name": "output3456",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "queueName": "sdkqueue",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Avro",
      "properties": {}
    }
  }
}
Status code:
200 
ETag: 2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456",
  "name": "output3456",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "queueName": "sdkqueue",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Avro",
      "properties": {}
    }
  }
}

Create a Service Bus Topic output with CSV serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey",
        "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
        "topicName": "sdktopic",
        "propertyColumns": [
          "column1",
          "column2"
        ]
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 39259839-e581-4af4-bf68-302e6820e3a0
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886",
  "name": "output7886",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "topicName": "sdktopic",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}
Status code:
200 
ETag: 39259839-e581-4af4-bf68-302e6820e3a0
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886",
  "name": "output7886",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "topicName": "sdktopic",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": ",",
        "encoding": "UTF8"
      }
    }
  }
}

Create an Azure Data Lake Store output with JSON serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "someaccount",
        "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd",
        "refreshToken": "someRefreshToken==",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "filePathPrefix": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "Array"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 5472168f-7317-4241-8b75-0c8d9d0ea804
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "someaccount",
        "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": "Array"
      }
    }
  }
}
Status code:
200 
ETag: 5472168f-7317-4241-8b75-0c8d9d0ea804
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "someaccount",
        "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": "Array"
      }
    }
  }
}

Create an Azure Data Warehouse output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/DataWarehouse",
      "properties": {
        "table": "test2",
        "server": "asatestserver",
        "database": "zhayaSQLpool",
        "user": "tolladmin",
        "password": "password123"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/dwOutput",
  "name": "dwOutput",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/DataWarehouse",
      "properties": {
        "table": "test2",
        "server": "asatestserver",
        "database": "zhayaSQLpool",
        "user": "tolladmin"
      }
    }
  }
}
Status code:
200 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/dwOutput",
  "name": "dwOutput",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/DataWarehouse",
      "properties": {
        "table": "test2",
        "server": "asatestserver",
        "database": "zhayaSQLpool",
        "user": "tolladmin"
      }
    }
  }
}

Create an Azure Function output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionAppName": "functionappforasaautomation",
        "functionName": "HttpTrigger2",
        "apiKey": null,
        "maxBatchSize": 256,
        "maxBatchCount": 100
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "id": "/subscriptions/7f31cba8-b597-4129-b158-8f21a7395bd0/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/azureFunction1",
  "name": "azureFunction1",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionAppName": "functionappforasaautomation",
        "functionName": "HttpTrigger2",
        "apiKey": null,
        "maxBatchSize": 256,
        "maxBatchCount": 100
      }
    },
    "etag": "7b912929-346d-432e-9495-6972dbd63179"
  }
}
Status code:
200 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "id": "/subscriptions/7f31cba8-b597-4129-b158-8f21a7395bd0/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/azureFunction1",
  "name": "azureFunction1",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionAppName": "functionappforasaautomation",
        "functionName": "HttpTrigger2",
        "apiKey": null,
        "maxBatchSize": 256,
        "maxBatchCount": 100
      }
    },
    "etag": "7b912929-346d-432e-9495-6972dbd63179"
  }
}

Create an Azure SQL database output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "server": "someServer",
        "database": "someDatabase",
        "user": "<user>",
        "password": "somePassword",
        "table": "someTable"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "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": "someTable",
        "user": "someUser"
      }
    }
  }
}
Status code:
200 
ETag: 731a47c6-ff67-4439-bde6-a2a3da4c1ecf
Response Body
{
  "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": "someTable",
        "user": "someUser"
      }
    }
  }
}

Create an Azure Table output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "accountName": "someAccountName",
        "accountKey": "accountKey==",
        "table": "samples",
        "partitionKey": "partitionKey",
        "rowKey": "rowKey",
        "columnsToRemove": [
          "column1",
          "column2"
        ],
        "batchSize": 25
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 2409b6d1-c99c-405b-9a14-ea7833637038
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958",
  "name": "output958",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "accountName": "someAccountName",
        "table": "samples",
        "partitionKey": "partitionKey",
        "rowKey": "rowKey",
        "columnsToRemove": [
          "column1",
          "column2"
        ],
        "batchSize": 25
      }
    }
  }
}
Status code:
200 
ETag: 2409b6d1-c99c-405b-9a14-ea7833637038
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958",
  "name": "output958",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "accountName": "someAccountName",
        "table": "samples",
        "partitionKey": "partitionKey",
        "rowKey": "rowKey",
        "columnsToRemove": [
          "column1",
          "column2"
        ],
        "batchSize": 25
      }
    }
  }
}

Create an Event Hub output with JSON serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey",
        "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
        "eventHubName": "sdkeventhub",
        "partitionKey": "partitionKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "Array"
      }
    }
  }
}

Sample Response

Status code:
201 
ETag: 5472168f-7317-4241-8b75-0c8d9d0ea804
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "eventHubName": "sdkeventhub",
        "partitionKey": "partitionKey",
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "Array"
      }
    }
  }
}
Status code:
200 
ETag: 5472168f-7317-4241-8b75-0c8d9d0ea804
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "eventHubName": "sdkeventhub",
        "partitionKey": "partitionKey",
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "Array"
      }
    }
  }
}

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.
AzureDataLakeStoreOutputDataSource

Describe un origen de datos de salida de Azure Data Lake Store.
AzureFunctionOutputDataSource

Define los metadatos de AzureFunctionOutputDataSource.
AzureSqlDatabaseOutputDataSource

Describe un origen de datos de salida de base de datos Azure SQL.
AzureSynapseOutputDataSource

Describe un Azure Synapse origen de datos de salida.
AzureTableOutputDataSource

Describe un origen de datos de salida de tabla de Azure.
BlobOutputDataSource

Describe un origen de datos de salida de blob.
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 la atención al cliente.
DocumentDbOutputDataSource

Describe un origen de datos de salida de DocumentDB.
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.
EventHubOutputDataSource

Describe un origen de datos de salida del centro de eventos.
EventHubV2OutputDataSource

Describe un origen de datos de salida del centro de eventos.
EventSerializationType

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

Describe un origen de datos de salida de Gateway Message Bus.
JsonOutputSerializationFormat

Especifica el formato json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se dará formato al tener cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se dará formato 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.
Output

Objeto de salida que contiene toda la información asociada a la salida con nombre. Todas las salidas están contenidas en un trabajo de streaming.
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.
PowerBIOutputDataSource

Describe un origen de datos de salida de Power BI.
ServiceBusQueueOutputDataSource

Describe un origen de datos de salida de cola de Service Bus.
ServiceBusTopicOutputDataSource

Describe un origen de datos de salida de tema de Service Bus.
StorageAccount

Propiedades asociadas a una cuenta de Azure Storage

AuthenticationMode

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

Nombre Tipo Description
ConnectionString

string

Msi

string

UserToken

string

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.

Nombre Tipo Description
type string:

Avro

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

AzureDataLakeStoreOutputDataSource

Describe un origen de datos de salida de Azure Data Lake Store.

Nombre Tipo Valor predeterminado Description
properties.accountName

string

Nombre de la cuenta de Azure Data Lake Store. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.dateFormat

string

El formato de la fecha. Siempre que {date} aparezca en filePathPrefix, el valor de esta propiedad se usa como formato de fecha en su lugar.
properties.filePathPrefix

string

Ubicación del archivo en el que se debe escribir la salida. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.refreshToken

string

Token de actualización que se puede usar para obtener un token de acceso válido que se puede usar para autenticarse con el origen de datos. Actualmente, solo se puede obtener un token de actualización válido a través de Azure Portal. Se recomienda colocar aquí un valor de cadena ficticio al crear el origen de datos y, a continuación, ir a Azure Portal para autenticar el origen de datos que actualizará esta propiedad con un token de actualización válido. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.tenantId

string

Identificador de inquilino del usuario usado para obtener el token de actualización. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.timeFormat

string

Formato de hora. Siempre que aparezca {time} en filePathPrefix, el valor de esta propiedad se usa como formato de hora en su lugar.
properties.tokenUserDisplayName

string

Nombre para mostrar del usuario que se usó para obtener el token de actualización. Use esta propiedad para ayudar a recordar qué usuario se usó para obtener el token de actualización.
properties.tokenUserPrincipalName

string

Nombre principal de usuario (UPN) del usuario que se usó para obtener el token de actualización. Use esta propiedad para ayudar a recordar qué usuario se usó para obtener el token de actualización.
type string:

Microsoft.DataLake/Accounts

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Define los metadatos de AzureFunctionOutputDataSource.

Nombre Tipo Description
properties.apiKey

string

Si quiere usar una instancia de Azure Functions desde otra suscripción, debe proporcionar la clave para acceder a la función.
properties.functionAppName

string

Nombre de la aplicación de Azure Functions.
properties.functionName

string

Nombre de la función en la aplicación de Azure Functions.
properties.maxBatchCount

number

Propiedad que permite especificar el número máximo de eventos en cada lote que se envía a Azure Functions. El valor predeterminado es 100.
properties.maxBatchSize

number

Propiedad que permite establecer el tamaño máximo de cada lote de salida que se envía a la instancia de Azure Functions. La unidad de entrada se muestra en bytes. De manera predeterminada, este valor es 262 144 bytes (256 KB).
type string:

Microsoft.AzureFunction

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

Describe un origen de datos de salida de base de datos Azure SQL.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.database

string

Nombre de la base de datos Azure SQL. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.maxBatchCount

number

Número máximo de lotes para escritura en Sql Database, el valor predeterminado es 10 000. Opcional en las solicitudes PUT.
properties.maxWriterCount

number

Recuento máximo de escritor, actualmente solo hay disponibles 1 (escritor único) y 0 (basado en la partición de consulta). Opcional en las solicitudes PUT.
properties.password

string

Contraseña que se usará para conectarse a la base de datos de Azure SQL. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.server

string

Nombre del servidor SQL server que contiene la base de datos de Azure SQL. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.table

string

Nombre de la tabla de la base de datos Azure SQL. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.user

string

Nombre de usuario que se usará para conectarse a la base de datos de Azure SQL. Obligatorio en las solicitudes PUT (CreateOrReplace).
type string:

Microsoft.Sql/Server/Database

Indica el tipo de salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

AzureSynapseOutputDataSource

Describe un Azure Synapse origen de datos de salida.

Nombre Tipo Description
properties.database

string

Nombre de la base de datos Azure SQL. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.password

string

Contraseña que se usará para conectarse a la base de datos de Azure SQL. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.server

string

Nombre del servidor SQL server que contiene la base de datos de Azure SQL. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.table

string

Nombre de la tabla de la base de datos Azure SQL. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.user

string

Nombre de usuario que se usará para conectarse a la base de datos de Azure SQL. Se requiere en las solicitudes PUT (CreateOrReplace).
type string:

Microsoft.Sql/Server/DataWarehouse

Indica el tipo de salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

AzureTableOutputDataSource

Describe un origen de datos de salida de tabla de Azure.

Nombre Tipo Description
properties.accountKey

string

Clave de cuenta de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.accountName

string

nombre de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.batchSize

integer

Número de filas que se van a escribir en la tabla de Azure a la vez.
properties.columnsToRemove

string[]

Si se especifica, cada elemento de la matriz es el nombre de una columna para quitar (si existe) de entidades de eventos de salida.
properties.partitionKey

string

Este elemento indica el nombre de una columna de la instrucción SELECT de la consulta que se usará como clave de partición para la tabla de Azure. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.rowKey

string

Este elemento indica el nombre de una columna de la instrucción SELECT de la consulta que se usará como clave de fila para la tabla de Azure. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.table

string

Nombre de la tabla de Azure. Obligatorio en las solicitudes PUT (CreateOrReplace).
type string:

Microsoft.Storage/Table

Indica el tipo de salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

BlobOutputDataSource

Describe un origen de datos de salida de blob.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.blobPathPrefix

string

Prefijo de ruta de acceso de blob.
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

El formato de la 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 buscarán coincidencias con 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[]

Una 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 salida del origen de datos en el que se escribirá. 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.

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

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 en detalle. Localizado en el Accept-Language de la solicitud de cliente.
since

string

Marca de tiempo UTC de cuándo se inició la condición. Los clientes deben poder encontrar un evento correspondiente en el registro de operaciones en este momento.

Diagnostics

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan la 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 justifican la atención al cliente.

DocumentDbOutputDataSource

Describe un origen de datos de salida de DocumentDB.

Nombre Tipo Description
properties.accountId

string

Nombre o identificador de la cuenta de DocumentDB. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.accountKey

string

Clave de cuenta de la cuenta de DocumentDB. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.collectionNamePattern

string

Patrón de nombre de colección para las colecciones que se usará. El formato de nombre de la colección se pueden construir con el token opcional {partition}, donde las particiones comienzan desde 0. Consulte la sección DocumentDB de https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener más información. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.database

string

Nombre de la base de datos de DocumentDB. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.documentId

string

Nombre del campo de los eventos de salida utilizado para especificar la clave principal en la que se basan las operaciones de inserción o actualización.
properties.partitionKey

string

Nombre del campo en los eventos de salida que se utiliza para especificar la clave de partición de salida entre colecciones. Si 'collectionNamePattern' contiene el token {partition}, es necesario especificar esta propiedad.
type string:

Microsoft.Storage/DocumentDB

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

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.

Nombre Tipo Description
UTF8

string

Error

Representación de error común.

Nombre Tipo Description
error

Error

Propiedades de definición de error.

EventHubOutputDataSource

Describe un origen de datos de salida del centro de eventos.

Nombre Tipo Valor predeterminado Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.eventHubName

string

Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.partitionKey

string

Clave o columna que se usa para determinar a qué partición se van a enviar datos de eventos.
properties.propertyColumns

string[]

Propiedades asociadas a esta salida del centro de eventos.
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 salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventHubV2OutputDataSource

Describe un origen de datos de salida del centro de eventos.

Nombre Tipo Valor predeterminado Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.eventHubName

string

Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.partitionKey

string

Clave o columna que se usa para determinar a qué partición se van a enviar datos de eventos.
properties.propertyColumns

string[]

Propiedades asociadas a esta salida del centro de eventos.
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 salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventSerializationType

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

Nombre Tipo Description
Avro

string

Csv

string

Json

string

Parquet

string

GatewayMessageBusOutputDataSource

Describe un origen de datos de salida de Gateway Message Bus.

Nombre Tipo Description
properties.topic

string

Nombre del tema de Service Bus.
type string:

GatewayMessageBus

Indica el tipo de salida del origen de datos en el que se escribirá. Obligatorio en las solicitudes PUT (CreateOrReplace).

JsonOutputSerializationFormat

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

Nombre Tipo Description
Array

string

LineSeparated

string

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.

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 json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se dará formato al tener cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se dará formato 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).

Output

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

Nombre Tipo Description
id

string

Id. de recurso
name

string

Nombre del recurso
properties.datasource OutputDataSource:

Describe el origen de datos en el que se escribirá la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).
properties.diagnostics

Diagnostics

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

string

Etiqueta de entidad actual para la salida. 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 la simultaneidad optimista.
properties.serialization Serialization:

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).
properties.sizeWindow

integer

Ventana de tamaño a la que se va a restringir una salida de Stream Analytics.
properties.timeWindow

string

Período de tiempo para filtrar las salidas del trabajo de Stream Analytics.
type

string

Tipo de recurso

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.

Nombre Tipo Description
type string:

Parquet

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

PowerBIOutputDataSource

Describe un origen de datos de salida de Power BI.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.dataset

string

Nombre del conjunto de datos de Power BI. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.groupId

string

Identificador del grupo de Power BI.
properties.groupName

string

Nombre del grupo de Power BI. Use esta propiedad para recordar qué identificador de grupo de Power BI específico se usó.
properties.refreshToken

string

Token de actualización que se puede usar para obtener un token de acceso válido que se puede usar para autenticarse con el origen de datos. Actualmente, solo se puede obtener un token de actualización válido a través de Azure Portal. Se recomienda colocar aquí un valor de cadena ficticio al crear el origen de datos y, a continuación, ir a Azure Portal para autenticar el origen de datos que actualizará esta propiedad con un token de actualización válido. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.table

string

Nombre de la tabla de Power BI en el conjunto de datos especificado. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.tokenUserDisplayName

string

Nombre para mostrar del usuario que se usó para obtener el token de actualización. Utilice esta propiedad para ayudar a recordar qué usuario se usó para obtener el token de actualización.
properties.tokenUserPrincipalName

string

Nombre principal de usuario (UPN) del usuario que se usó para obtener el token de actualización. Utilice esta propiedad para ayudar a recordar qué usuario se usó para obtener el token de actualización.
type string:

PowerBI

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

Describe un origen de datos de salida de cola de Service Bus.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.propertyColumns

string[]

Matriz de cadenas de los nombres de las columnas de salida que se van a adjuntar a los mensajes de Service Bus como propiedades personalizadas.
properties.queueName

string

El nombre de la cola de Service Bus Se requiere en las solicitudes PUT (CreateOrReplace).
properties.serviceBusNamespace

string

Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.sharedAccessPolicyKey

string

Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.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. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.systemPropertyColumns

object

Las propiedades del sistema asociadas a la cola de Service Bus. Se admiten las siguientes propiedades del sistema: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.
type string:

Microsoft.ServiceBus/Queue

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Describe un origen de datos de salida de tema de Service Bus.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.
properties.propertyColumns

string[]

Matriz de cadenas de los nombres de las columnas de salida que se van a adjuntar a los mensajes de Service Bus como propiedades personalizadas.
properties.serviceBusNamespace

string

Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.sharedAccessPolicyKey

string

Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.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. Se requiere en las solicitudes PUT (CreateOrReplace).
properties.systemPropertyColumns

object

Las propiedades del sistema asociadas a la salida del tema de Service Bus. Se admiten las siguientes propiedades del sistema: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.
properties.topicName

string

Nombre del tema de Service Bus. Se requiere en las solicitudes PUT (CreateOrReplace).
type string:

Microsoft.ServiceBus/Topic

Indica el tipo de salida del origen de datos en el que se escribirá. Se requiere en las solicitudes PUT (CreateOrReplace).

StorageAccount

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