{ "swagger": "2.0", "info": { "title": "LogicManagementClient", "description": "REST API for Azure Logic Apps.", "version": "2019-05-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows": { "get": { "tags": [ "Workflows" ], "operationId": "Workflows_ListBySubscription", "description": "Gets a list of workflows by subscription.", "x-ms-examples": { "List all workflows in a subscription": { "$ref": "./examples/Workflows_ListBySubscription.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows": { "get": { "tags": [ "Workflows" ], "operationId": "Workflows_ListByResourceGroup", "description": "Gets a list of workflows by resource group.", "x-ms-examples": { "List all workflows in a resource group": { "$ref": "./examples/Workflows_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}": { "get": { "tags": [ "Workflows" ], "operationId": "Workflows_Get", "description": "Gets a workflow.", "x-ms-examples": { "Get a workflow": { "$ref": "./examples/Workflows_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workflow" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "Workflows" ], "operationId": "Workflows_CreateOrUpdate", "description": "Creates or updates a workflow.", "x-ms-examples": { "Create or update a workflow": { "$ref": "./examples/Workflows_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "workflow", "description": "The workflow.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Workflow" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workflow" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/Workflow" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Workflows" ], "operationId": "Workflows_Update", "description": "Updates a workflow.", "x-ms-examples": { "Patch a workflow": { "$ref": "./examples/Workflows_Update.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Workflow" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Workflows" ], "operationId": "Workflows_Delete", "description": "Deletes a workflow.", "x-ms-examples": { "Delete a workflow": { "$ref": "./examples/Workflows_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_Disable", "description": "Disables a workflow.", "x-ms-examples": { "Disable a workflow": { "$ref": "./examples/Workflows_Disable.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_Enable", "description": "Enables a workflow.", "x-ms-examples": { "Enable a workflow": { "$ref": "./examples/Workflows_Enable.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_GenerateUpgradedDefinition", "description": "Generates the upgraded definition for a workflow.", "x-ms-examples": { "Generate an upgraded definition": { "$ref": "./examples/Workflows_GenerateUpgradedDefinition.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "parameters", "description": "Parameters for generating an upgraded definition.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GenerateUpgradedDefinitionParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Object" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listCallbackUrl": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_ListCallbackUrl", "description": "Get the workflow callback Url.", "x-ms-examples": { "Get callback url": { "$ref": "./examples/Workflows_ListCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "listCallbackUrl", "description": "Which callback url to list.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_ListSwagger", "description": "Gets an OpenAPI definition for the workflow.", "x-ms-examples": { "Get the swagger for a workflow": { "$ref": "./examples/Workflows_ListSwagger.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Object" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/move": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_Move", "x-ms-long-running-operation": true, "description": "Moves an existing workflow.", "x-ms-examples": { "Move a workflow": { "$ref": "./examples/Workflows_Move.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "move", "description": "The workflow to move.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WorkflowReference" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_RegenerateAccessKey", "description": "Regenerates the callback URL access key for request triggers.", "x-ms-examples": { "Regenerate the callback URL access key for request triggers": { "$ref": "./examples/Workflows_RegenerateAccessKey.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "keyType", "description": "The access key type.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegenerateActionParameter" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/validate": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_ValidateByResourceGroup", "description": "Validates the workflow.", "x-ms-examples": { "Validate a workflow": { "$ref": "./examples/Workflows_ValidateByResourceGroup.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "validate", "description": "The workflow.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Workflow" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions": { "get": { "tags": [ "WorkflowVersions" ], "operationId": "WorkflowVersions_List", "description": "Gets a list of workflow versions.", "x-ms-examples": { "List a workflows versions": { "$ref": "./examples/WorkflowVersions_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowVersionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}": { "get": { "tags": [ "WorkflowVersions" ], "operationId": "WorkflowVersions_Get", "description": "Gets a workflow version.", "x-ms-examples": { "Get a workflow version": { "$ref": "./examples/WorkflowVersions_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "versionId", "description": "The workflow versionId.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowVersion" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers": { "get": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_List", "description": "Gets a list of workflow triggers.", "x-ms-examples": { "List workflow triggers": { "$ref": "./examples/WorkflowTriggers_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowTriggerFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}": { "get": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_Get", "description": "Gets a workflow trigger.", "x-ms-examples": { "Get a workflow trigger": { "$ref": "./examples/WorkflowTriggers_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTrigger" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/reset": { "post": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_Reset", "description": "Resets a workflow trigger.", "x-ms-examples": { "Reset trigger": { "$ref": "./examples/WorkflowTriggers_Reset.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run": { "post": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_Run", "description": "Runs a workflow trigger.", "x-ms-examples": { "Run a workflow trigger": { "$ref": "./examples/WorkflowTriggers_Run.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the trigger run failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/schemas/json": { "get": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_GetSchemaJson", "description": "Get the trigger schema as JSON.", "x-ms-examples": { "Get trigger schema": { "$ref": "./examples/WorkflowTriggers_GetSchemaJson.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/JsonSchema" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState": { "post": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_SetState", "description": "Sets the state of a workflow trigger.", "x-ms-examples": { "Set trigger state": { "$ref": "./examples/WorkflowTriggers_SetState.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "name": "setState", "description": "The workflow trigger state.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SetTriggerStateActionDefinition" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl": { "post": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowTriggers_ListCallbackUrl", "description": "Get the callback URL for a workflow trigger.", "x-ms-examples": { "Get the callback URL for a trigger": { "$ref": "./examples/WorkflowTriggers_ListCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl": { "post": { "tags": [ "WorkflowTriggers" ], "operationId": "WorkflowVersionTriggers_ListCallbackUrl", "description": "Get the callback url for a trigger of a workflow version.", "x-ms-examples": { "Get the callback url for a trigger of a workflow version": { "$ref": "./examples/WorkflowVersionTriggers_ListCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "versionId", "description": "The workflow versionId.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "description": "The callback URL parameters.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories": { "get": { "tags": [ "WorkflowTriggerHistories" ], "operationId": "WorkflowTriggerHistories_List", "description": "Gets a list of workflow trigger histories.", "x-ms-examples": { "List a workflow trigger history": { "$ref": "./examples/WorkflowTriggerHistories_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerHistoryListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowTriggerHistoryFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}": { "get": { "tags": [ "WorkflowTriggerHistories" ], "operationId": "WorkflowTriggerHistories_Get", "description": "Gets a workflow trigger history.", "x-ms-examples": { "Get a workflow trigger history": { "$ref": "./examples/WorkflowTriggerHistories_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "name": "historyName", "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerHistory" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit": { "post": { "tags": [ "WorkflowTriggerHistories" ], "operationId": "WorkflowTriggerHistories_Resubmit", "description": "Resubmits a workflow run based on the trigger history.", "x-ms-examples": { "Resubmit a workflow run based on the trigger history": { "$ref": "./examples/WorkflowTriggerHistories_Resubmit.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "triggerName", "description": "The workflow trigger name.", "in": "path", "required": true, "type": "string" }, { "name": "historyName", "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs": { "get": { "tags": [ "WorkflowRuns" ], "operationId": "WorkflowRuns_List", "description": "Gets a list of workflow runs.", "x-ms-examples": { "List workflow runs": { "$ref": "./examples/WorkflowRuns_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowRunFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}": { "get": { "tags": [ "WorkflowRuns" ], "operationId": "WorkflowRuns_Get", "description": "Gets a workflow run.", "x-ms-examples": { "Get a run for a workflow": { "$ref": "./examples/WorkflowRuns_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRun" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel": { "post": { "tags": [ "WorkflowRuns" ], "operationId": "WorkflowRuns_Cancel", "description": "Cancels a workflow run.", "x-ms-examples": { "Cancel a workflow run": { "$ref": "./examples/WorkflowRuns_Cancel.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActions_List", "description": "Gets a list of workflow run actions.", "x-ms-examples": { "List a workflow run actions": { "$ref": "./examples/WorkflowRunActions_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: Status.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunActionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/WorkflowRunActionFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActions_Get", "description": "Gets a workflow run action.", "x-ms-examples": { "Get a workflow run action": { "$ref": "./examples/WorkflowRunActions_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunAction" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces": { "post": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActions_ListExpressionTraces", "description": "Lists a workflow run expression trace.", "x-ms-examples": { "List expression traces": { "$ref": "./examples/WorkflowRunActions_ListExpressionTraces.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpressionTraces" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null, "itemName": "inputs" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRepetitions_List", "description": "Get all of a workflow run action repetitions.", "x-ms-examples": { "List repetitions": { "$ref": "./examples/WorkflowRunActionRepetitions_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRepetitions_Get", "description": "Get a workflow run action repetition.", "x-ms-examples": { "Get a repetition": { "$ref": "./examples/WorkflowRunActionRepetitions_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "repetitionName", "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces": { "post": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRepetitions_ListExpressionTraces", "description": "Lists a workflow run expression trace.", "x-ms-examples": { "List expression traces for a repetition": { "$ref": "./examples/WorkflowRunActionRepetitions_ListExpressionTraces.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "repetitionName", "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExpressionTraces" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null, "itemName": "inputs" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRepetitionsRequestHistories_List", "description": "List a workflow run repetition request history.", "x-ms-examples": { "List repetition request history": { "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "repetitionName", "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RequestHistoryListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRepetitionsRequestHistories_Get", "description": "Gets a workflow run repetition request history.", "x-ms-examples": { "Get a repetition request history": { "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "repetitionName", "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" }, { "name": "requestHistoryName", "description": "The request history name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RequestHistory" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRequestHistories_List", "description": "List a workflow run request history.", "x-ms-examples": { "List a request history": { "$ref": "./examples/WorkflowRunActionRequestHistories_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RequestHistoryListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionRequestHistories_Get", "description": "Gets a workflow run request history.", "x-ms-examples": { "Get a request history": { "$ref": "./examples/WorkflowRunActionRequestHistories_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "requestHistoryName", "description": "The request history name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RequestHistory" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionScopeRepetitions_List", "description": "List the workflow run action scoped repetitions.", "x-ms-examples": { "List the scoped repetitions": { "$ref": "./examples/WorkflowRunActionScopeRepetitions_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}": { "get": { "tags": [ "WorkflowRunActions" ], "operationId": "WorkflowRunActionScopeRepetitions_Get", "description": "Get a workflow run action scoped repetition.", "x-ms-examples": { "Get a scoped repetition": { "$ref": "./examples/WorkflowRunActionScopeRepetitions_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "actionName", "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "name": "repetitionName", "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/operations/{operationId}": { "get": { "tags": [ "WorkflowRunOperations" ], "operationId": "WorkflowRunOperations_Get", "description": "Gets an operation for a run.", "x-ms-examples": { "Get a run operation": { "$ref": "./examples/WorkflowRunOperations_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "runName", "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "name": "operationId", "description": "The workflow operation id.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowRun" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate": { "post": { "tags": [ "Workflows" ], "operationId": "Workflows_ValidateByLocation", "description": "Validates the workflow definition.", "x-ms-examples": { "Validate a workflow": { "$ref": "./examples/Workflows_ValidateByLocation.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "location", "description": "The workflow location.", "in": "path", "required": true, "type": "string" }, { "name": "workflowName", "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "name": "validate", "description": "The workflow.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Workflow" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts": { "get": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_ListBySubscription", "description": "Gets a list of integration accounts by subscription.", "x-ms-examples": { "List integration accounts by subscription": { "$ref": "./examples/IntegrationAccounts_ListBySubscription.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts": { "get": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_ListByResourceGroup", "description": "Gets a list of integration accounts by resource group.", "x-ms-examples": { "List integration accounts by resource group name": { "$ref": "./examples/IntegrationAccounts_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}": { "get": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_Get", "description": "Gets an integration account.", "x-ms-examples": { "Get integration account by name": { "$ref": "./examples/IntegrationAccounts_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_CreateOrUpdate", "description": "Creates or updates an integration account.", "x-ms-examples": { "Create or update an integration account": { "$ref": "./examples/IntegrationAccounts_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "integrationAccount", "description": "The integration account.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccount" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_Update", "description": "Updates an integration account.", "x-ms-examples": { "Patch an integration account": { "$ref": "./examples/IntegrationAccounts_Update.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "integrationAccount", "description": "The integration account.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccount" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_Delete", "description": "Deletes an integration account.", "x-ms-examples": { "Delete an integration account": { "$ref": "./examples/IntegrationAccounts_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies": { "get": { "tags": [ "IntegrationAccountAssemblies" ], "operationId": "IntegrationAccountAssemblies_List", "description": "List the assemblies for an integration account.", "x-ms-examples": { "List integration account assemblies": { "$ref": "./examples/IntegrationAccountAssemblies_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssemblyCollection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}": { "get": { "tags": [ "IntegrationAccountAssemblies" ], "operationId": "IntegrationAccountAssemblies_Get", "description": "Get an assembly for an integration account.", "x-ms-examples": { "Get an integration account assembly": { "$ref": "./examples/IntegrationAccountAssemblies_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "assemblyArtifactName", "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssemblyDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountAssemblies" ], "operationId": "IntegrationAccountAssemblies_CreateOrUpdate", "description": "Create or update an assembly for an integration account.", "x-ms-examples": { "Create or update an account assembly": { "$ref": "./examples/IntegrationAccountAssemblies_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "assemblyArtifactName", "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" }, { "name": "assemblyArtifact", "description": "The assembly artifact.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AssemblyDefinition" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssemblyDefinition" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AssemblyDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountAssemblies" ], "operationId": "IntegrationAccountAssemblies_Delete", "description": "Delete an assembly for an integration account.", "x-ms-examples": { "Delete an integration account assembly": { "$ref": "./examples/IntegrationAccountAssemblies_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "assemblyArtifactName", "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}/listContentCallbackUrl": { "post": { "tags": [ "IntegrationAccountAssemblies" ], "operationId": "IntegrationAccountAssemblies_ListContentCallbackUrl", "description": "Get the content callback url for an integration account assembly.", "x-ms-examples": { "Get the callback url for an integration account assembly": { "$ref": "./examples/IntegrationAccountAssemblies_ListContentCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "assemblyArtifactName", "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations": { "get": { "tags": [ "IntegrationAccountBatchConfigurations" ], "operationId": "IntegrationAccountBatchConfigurations_List", "description": "List the batch configurations for an integration account.", "x-ms-examples": { "List batch configurations": { "$ref": "./examples/IntegrationAccountBatchConfigurations_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchConfigurationCollection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}": { "get": { "tags": [ "IntegrationAccountBatchConfigurations" ], "operationId": "IntegrationAccountBatchConfigurations_Get", "description": "Get a batch configuration for an integration account.", "x-ms-examples": { "Get a batch configuration": { "$ref": "./examples/IntegrationAccountBatchConfigurations_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "batchConfigurationName", "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountBatchConfigurations" ], "operationId": "IntegrationAccountBatchConfigurations_CreateOrUpdate", "description": "Create or update a batch configuration for an integration account.", "x-ms-examples": { "Create or update a batch configuration": { "$ref": "./examples/IntegrationAccountBatchConfigurations_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "batchConfigurationName", "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" }, { "name": "batchConfiguration", "description": "The batch configuration.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BatchConfiguration" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchConfiguration" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/BatchConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountBatchConfigurations" ], "operationId": "IntegrationAccountBatchConfigurations_Delete", "description": "Delete a batch configuration for an integration account.", "x-ms-examples": { "Delete a batch configuration": { "$ref": "./examples/IntegrationAccountBatchConfigurations_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "batchConfigurationName", "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl": { "post": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_ListCallbackUrl", "description": "Gets the integration account callback URL.", "x-ms-examples": { "List IntegrationAccount callback URL": { "$ref": "./examples/IntegrationAccounts_ListCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "parameters", "description": "The callback URL parameters.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listKeyVaultKeys": { "post": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_ListKeyVaultKeys", "description": "Gets the integration account's Key Vault keys.", "x-ms-examples": { "Get Integration Account callback URL": { "$ref": "./examples/IntegrationAccounts_ListKeyVaultKeys.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "listKeyVaultKeys", "description": "The key vault parameters.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ListKeyVaultKeysDefinition" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/KeyVaultKeyCollection" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/logTrackingEvents": { "post": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_LogTrackingEvents", "description": "Logs the integration account's tracking events.", "x-ms-examples": { "Log a tracked event": { "$ref": "./examples/IntegrationAccounts_LogTrackingEvents.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "logTrackingEvents", "description": "The callback URL parameters.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TrackingEventsDefinition" } } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/regenerateAccessKey": { "post": { "tags": [ "IntegrationAccounts" ], "operationId": "IntegrationAccounts_RegenerateAccessKey", "description": "Regenerates the integration account access key.", "x-ms-examples": { "Regenerate access key": { "$ref": "./examples/IntegrationAccounts_RegenerateAccessKey.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "regenerateAccessKey", "description": "The access key type.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RegenerateActionParameter" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccount" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas": { "get": { "tags": [ "IntegrationAccountSchemas" ], "operationId": "IntegrationAccountSchemas_List", "description": "Gets a list of integration account schemas.", "x-ms-examples": { "Get schemas by integration account name": { "$ref": "./examples/IntegrationAccountSchemas_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: SchemaType.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSchemaListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/IntegrationAccountSchemaFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}": { "get": { "tags": [ "IntegrationAccountSchemas" ], "operationId": "IntegrationAccountSchemas_Get", "description": "Gets an integration account schema.", "x-ms-examples": { "Get schema by name": { "$ref": "./examples/IntegrationAccountSchemas_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "schemaName", "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSchema" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountSchemas" ], "operationId": "IntegrationAccountSchemas_CreateOrUpdate", "description": "Creates or updates an integration account schema.", "x-ms-examples": { "Create or update schema": { "$ref": "./examples/IntegrationAccountSchemas_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "schemaName", "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "schema", "description": "The integration account schema.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountSchema" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSchema" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountSchema" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountSchemas" ], "operationId": "IntegrationAccountSchemas_Delete", "description": "Deletes an integration account schema.", "x-ms-examples": { "Delete a schema by name": { "$ref": "./examples/IntegrationAccountSchemas_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "schemaName", "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}/listContentCallbackUrl": { "post": { "tags": [ "IntegrationAccountSchemas" ], "operationId": "IntegrationAccountSchemas_ListContentCallbackUrl", "description": "Get the content callback url.", "x-ms-examples": { "Get the content callback url": { "$ref": "./examples/IntegrationAccountSchemas_ListContentCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "schemaName", "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "listContentCallbackUrl", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps": { "get": { "tags": [ "IntegrationAccountMaps" ], "operationId": "IntegrationAccountMaps_List", "description": "Gets a list of integration account maps.", "x-ms-examples": { "Get maps by integration account name": { "$ref": "./examples/IntegrationAccountMaps_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: MapType.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountMapListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/IntegrationAccountMapFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}": { "get": { "tags": [ "IntegrationAccountMaps" ], "operationId": "IntegrationAccountMaps_Get", "description": "Gets an integration account map.", "x-ms-examples": { "Get map by name": { "$ref": "./examples/IntegrationAccountMaps_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "mapName", "description": "The integration account map name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountMap" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountMaps" ], "operationId": "IntegrationAccountMaps_CreateOrUpdate", "description": "Creates or updates an integration account map. If the map is larger than 4 MB, you need to store the map in an Azure blob and use the blob's Shared Access Signature (SAS) URL as the 'contentLink' property value.", "x-ms-examples": { "Create or update a map": { "$ref": "./examples/IntegrationAccountMaps_CreateOrUpdate.json" }, "Create or update a map larger than 4 MB": { "$ref": "./examples/IntegrationAccountLargeMaps_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "mapName", "description": "The integration account map name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "map", "description": "The integration account map.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountMap" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountMap" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountMap" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountMaps" ], "operationId": "IntegrationAccountMaps_Delete", "description": "Deletes an integration account map.", "x-ms-examples": { "Delete a map": { "$ref": "./examples/IntegrationAccountMaps_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "mapName", "description": "The integration account map name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}/listContentCallbackUrl": { "post": { "tags": [ "IntegrationAccountMaps" ], "operationId": "IntegrationAccountMaps_ListContentCallbackUrl", "description": "Get the content callback url.", "x-ms-examples": { "Get the content callback url": { "$ref": "./examples/IntegrationAccountMaps_ListContentCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "mapName", "description": "The integration account map name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "listContentCallbackUrl", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners": { "get": { "tags": [ "IntegrationAccountPartners" ], "operationId": "IntegrationAccountPartners_List", "description": "Gets a list of integration account partners.", "x-ms-examples": { "Get partners by integration account name": { "$ref": "./examples/IntegrationAccountPartners_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: PartnerType.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountPartnerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/IntegrationAccountPartnerFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}": { "get": { "tags": [ "IntegrationAccountPartners" ], "operationId": "IntegrationAccountPartners_Get", "description": "Gets an integration account partner.", "x-ms-examples": { "Get partner by name": { "$ref": "./examples/IntegrationAccountPartners_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "partnerName", "description": "The integration account partner name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountPartner" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountPartners" ], "operationId": "IntegrationAccountPartners_CreateOrUpdate", "description": "Creates or updates an integration account partner.", "x-ms-examples": { "Create or update a partner": { "$ref": "./examples/IntegrationAccountPartners_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "partnerName", "description": "The integration account partner name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "partner", "description": "The integration account partner.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountPartner" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountPartner" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountPartner" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountPartners" ], "operationId": "IntegrationAccountPartners_Delete", "description": "Deletes an integration account partner.", "x-ms-examples": { "Delete a partner": { "$ref": "./examples/IntegrationAccountPartners_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "partnerName", "description": "The integration account partner name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}/listContentCallbackUrl": { "post": { "tags": [ "IntegrationAccountPartners" ], "operationId": "IntegrationAccountPartners_ListContentCallbackUrl", "description": "Get the content callback url.", "x-ms-examples": { "Get the content callback url": { "$ref": "./examples/IntegrationAccountPartners_ListContentCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "partnerName", "description": "The integration account partner name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "listContentCallbackUrl", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements": { "get": { "tags": [ "IntegrationAccountAgreements" ], "operationId": "IntegrationAccountAgreements_List", "description": "Gets a list of integration account agreements.", "x-ms-examples": { "Get agreements by integration account name": { "$ref": "./examples/IntegrationAccountAgreements_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: AgreementType.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountAgreementListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/IntegrationAccountAgreementFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}": { "get": { "tags": [ "IntegrationAccountAgreements" ], "operationId": "IntegrationAccountAgreements_Get", "description": "Gets an integration account agreement.", "x-ms-examples": { "Get agreement by name": { "$ref": "./examples/IntegrationAccountAgreements_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "agreementName", "description": "The integration account agreement name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountAgreement" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountAgreements" ], "operationId": "IntegrationAccountAgreements_CreateOrUpdate", "description": "Creates or updates an integration account agreement.", "x-ms-examples": { "Create or update an agreement": { "$ref": "./examples/IntegrationAccountAgreements_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "agreementName", "description": "The integration account agreement name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "agreement", "description": "The integration account agreement.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountAgreement" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountAgreement" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountAgreement" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountAgreements" ], "operationId": "IntegrationAccountAgreements_Delete", "description": "Deletes an integration account agreement.", "x-ms-examples": { "Delete an agreement": { "$ref": "./examples/IntegrationAccountAgreements_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "agreementName", "description": "The integration account agreement name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}/listContentCallbackUrl": { "post": { "tags": [ "IntegrationAccountAgreements" ], "operationId": "IntegrationAccountAgreements_ListContentCallbackUrl", "description": "Get the content callback url.", "x-ms-examples": { "Get the content callback url": { "$ref": "./examples/IntegrationAccountAgreements_ListContentCallbackUrl.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "agreementName", "description": "The integration account agreement name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "listContentCallbackUrl", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCallbackUrlParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates": { "get": { "tags": [ "IntegrationAccountCertificates" ], "operationId": "IntegrationAccountCertificates_List", "description": "Gets a list of integration account certificates.", "x-ms-examples": { "Get certificates by integration account name": { "$ref": "./examples/IntegrationAccountCertificates_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountCertificateListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}": { "get": { "tags": [ "IntegrationAccountCertificates" ], "operationId": "IntegrationAccountCertificates_Get", "description": "Gets an integration account certificate.", "x-ms-examples": { "Get certificate by name": { "$ref": "./examples/IntegrationAccountCertificates_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "certificateName", "description": "The integration account certificate name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountCertificate" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountCertificates" ], "operationId": "IntegrationAccountCertificates_CreateOrUpdate", "description": "Creates or updates an integration account certificate.", "x-ms-examples": { "Create or update a certificate": { "$ref": "./examples/IntegrationAccountCertificates_CreateOrUpdate.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "certificateName", "description": "The integration account certificate name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "certificate", "description": "The integration account certificate.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountCertificate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountCertificate" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountCertificate" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountCertificates" ], "operationId": "IntegrationAccountCertificates_Delete", "description": "Deletes an integration account certificate.", "x-ms-examples": { "Delete a certificate": { "$ref": "./examples/IntegrationAccountCertificates_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "certificateName", "description": "The integration account certificate name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions": { "get": { "tags": [ "IntegrationAccountSessions" ], "operationId": "IntegrationAccountSessions_List", "x-ms-examples": { "Get a list of integration account sessions": { "$ref": "./examples/IntegrationAccountSessions_List.json" } }, "description": "Gets a list of integration account sessions.", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "$filter", "description": "The filter to apply on the operation. Options for filters include: ChangedTime.", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSessionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/IntegrationAccountSessionFilter" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}": { "get": { "tags": [ "IntegrationAccountSessions" ], "operationId": "IntegrationAccountSessions_Get", "x-ms-examples": { "Get an integration account session": { "$ref": "./examples/IntegrationAccountSessions_Get.json" } }, "description": "Gets an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "sessionName", "description": "The integration account session name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSession" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationAccountSessions" ], "operationId": "IntegrationAccountSessions_CreateOrUpdate", "x-ms-examples": { "Create or update an integration account session": { "$ref": "./examples/IntegrationAccountSessions_CreateOrUpdate.json" } }, "description": "Creates or updates an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "sessionName", "description": "The integration account session name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "session", "description": "The integration account session.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationAccountSession" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationAccountSession" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationAccountSession" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationAccountSessions" ], "operationId": "IntegrationAccountSessions_Delete", "x-ms-examples": { "Delete an integration account session": { "$ref": "./examples/IntegrationAccountSessions_Delete.json" } }, "description": "Deletes an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroupName", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationAccountName", "description": "The integration account name.", "in": "path", "required": true, "type": "string" }, { "name": "sessionName", "description": "The integration account session name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationServiceEnvironments": { "get": { "tags": [ "integrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_ListBySubscription", "description": "Gets a list of integration service environments by subscription.", "x-ms-examples": { "List integration service environments by subscription": { "$ref": "./examples/IntegrationServiceEnvironments_ListBySubscription.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentListResult" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments": { "get": { "tags": [ "IntegrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_ListByResourceGroup", "description": "Gets a list of integration service environments by resource group.", "x-ms-examples": { "List integration service environments by resource group name": { "$ref": "./examples/IntegrationServiceEnvironments_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "$top", "description": "The number of items to be included in the result.", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentListResult" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}": { "get": { "tags": [ "IntegrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_Get", "description": "Gets an integration service environment.", "x-ms-examples": { "Get integration service environment by name": { "$ref": "./examples/IntegrationServiceEnvironments_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "IntegrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_CreateOrUpdate", "x-ms-long-running-operation": true, "description": "Creates or updates an integration service environment.", "x-ms-examples": { "Create or update an integration service environment": { "$ref": "./examples/IntegrationServiceEnvironments_Put.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "integrationServiceEnvironment", "description": "The integration service environment.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "IntegrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_Update", "description": "Updates an integration service environment.", "x-ms-long-running-operation": true, "x-ms-examples": { "Patch an integration service environment": { "$ref": "./examples/IntegrationServiceEnvironments_Patch.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "integrationServiceEnvironment", "description": "The integration service environment.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironment" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "IntegrationServiceEnvironments" ], "operationId": "IntegrationServiceEnvironments_Delete", "description": "Deletes an integration service environment.", "x-ms-examples": { "Delete an integration account": { "$ref": "./examples/IntegrationServiceEnvironments_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/skus": { "get": { "tags": [ "integrationServiceEnvironmentSkus" ], "operationId": "IntegrationServiceEnvironmentSkus_List", "description": "Gets a list of integration service environment Skus.", "x-ms-examples": { "List integration service environment skus": { "$ref": "./examples/IntegrationServiceEnvironments_Skus.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuList" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/restart": { "post": { "tags": [ "integrationServiceEnvironmentRestart" ], "operationId": "IntegrationServiceEnvironments_Restart", "description": "Restarts an integration service environment.", "x-ms-examples": { "Restarts an integration service environment": { "$ref": "./examples/IntegrationServiceEnvironments_Restart.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/health/network": { "get": { "tags": [ "integrationServiceEnvironmentNetworkHealth" ], "operationId": "IntegrationServiceEnvironmentNetworkHealth_Get", "description": "Gets the integration service environment network health.", "x-ms-examples": { "Gets the integration service environment network health": { "$ref": "./examples/IntegrationServiceEnvironments_NetworkHealth.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkHealth" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis": { "get": { "tags": [ "integrationServiceEnvironmentManagedApis" ], "operationId": "IntegrationServiceEnvironmentManagedApis_List", "description": "Gets the integration service environment managed Apis.", "x-ms-examples": { "Gets the integration service environment managed Apis": { "$ref": "./examples/IntegrationServiceEnvironments_ManagedApis_List.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApiListResult" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}": { "get": { "tags": [ "integrationServiceEnvironmentManagedApi" ], "operationId": "IntegrationServiceEnvironmentManagedApis_Get", "description": "Gets the integration service environment managed Api.", "x-ms-examples": { "Gets the integration service environment managed Apis": { "$ref": "./examples/IntegrationServiceEnvironments_ManagedApis_Get.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "name": "apiName", "description": "The api name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApi" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "integrationServiceEnvironmentManagedApi" ], "operationId": "IntegrationServiceEnvironmentManagedApis_Put", "description": "Puts the integration service environment managed Api.", "x-ms-long-running-operation": true, "x-ms-examples": { "Gets the integration service environment managed Apis": { "$ref": "./examples/IntegrationServiceEnvironments_ManagedApis_Put.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group name.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "name": "apiName", "description": "The api name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" }, { "name": "integrationServiceEnvironmentManagedApi", "description": "The integration service environment managed api.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApi" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApi" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApi" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "integrationServiceEnvironmentManagedApi" ], "operationId": "IntegrationServiceEnvironmentManagedApis_Delete", "description": "Deletes the integration service environment managed Api.", "x-ms-long-running-operation": true, "x-ms-examples": { "Deletes the integration service environment managed Apis": { "$ref": "./examples/IntegrationServiceEnvironments_ManagedApis_Delete.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "name": "apiName", "description": "The api name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}/apiOperations": { "get": { "tags": [ "integrationServiceEnvironmentManagedApis" ], "operationId": "IntegrationServiceEnvironmentManagedApiOperations_List", "description": "Gets the managed Api operations.", "x-ms-examples": { "Gets the integration service environment managed Apis": { "$ref": "./examples/IntegrationServiceEnvironments_ManagedApis_ListApiOperations.json" } }, "parameters": [ { "$ref": "#/parameters/subscriptionId" }, { "name": "resourceGroup", "description": "The resource group.", "in": "path", "required": true, "type": "string" }, { "name": "integrationServiceEnvironmentName", "description": "The integration service environment name.", "in": "path", "required": true, "type": "string" }, { "name": "apiName", "description": "The api name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ApiOperationListResult" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Logic/operations": { "get": { "tags": [ "Operations" ], "description": "Lists all of the available Logic REST API operations.", "operationId": "Operations_List", "x-ms-examples": { "List Microsoft.Logic operations": { "$ref": "./examples/Operations_List.json" } }, "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Logic error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "Resource": { "properties": { "id": { "type": "string", "readOnly": true, "description": "The resource id." }, "name": { "type": "string", "readOnly": true, "description": "Gets the resource name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the resource type." }, "location": { "type": "string", "description": "The resource location." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The resource tags." } }, "x-ms-azure-resource": true, "description": "The base resource type." }, "SubResource": { "properties": { "id": { "type": "string", "readOnly": true, "description": "The resource id." } }, "x-ms-azure-resource": true, "description": "The sub resource type." }, "Object": { "type": "object", "properties": {} }, "ResourceReference": { "type": "object", "properties": { "id": { "type": "string", "description": "The resource id." }, "name": { "type": "string", "readOnly": true, "description": "Gets the resource name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the resource type." } }, "description": "The resource reference." }, "Workflow": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowProperties", "description": "The workflow properties." }, "identity": { "$ref": "#/definitions/ManagedServiceIdentity" } }, "description": "The workflow type.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "WorkflowProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/WorkflowProvisioningState", "readOnly": true, "description": "Gets the provisioning state." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the changed time." }, "state": { "$ref": "#/definitions/WorkflowState", "description": "The state." }, "version": { "type": "string", "readOnly": true, "description": "Gets the version." }, "accessEndpoint": { "type": "string", "readOnly": true, "description": "Gets the access endpoint." }, "endpointsConfiguration": { "$ref": "#/definitions/FlowEndpointsConfiguration", "description": "The endpoints configuration." }, "accessControl": { "$ref": "#/definitions/FlowAccessControlConfiguration", "description": "The access control configuration." }, "sku": { "$ref": "#/definitions/Sku", "readOnly": true, "description": "The sku." }, "integrationAccount": { "$ref": "#/definitions/ResourceReference", "description": "The integration account." }, "integrationServiceEnvironment": { "$ref": "#/definitions/ResourceReference", "description": "The integration service environment." }, "definition": { "$ref": "#/definitions/Object", "description": "The definition." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/WorkflowParameter" }, "description": "The parameters." } }, "description": "The workflow properties." }, "WorkflowFilter": { "type": "object", "properties": { "state": { "$ref": "#/definitions/WorkflowState", "description": "The state of workflows." } }, "description": "The workflow filter." }, "WorkflowListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Workflow" }, "description": "The list of workflows." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflows." }, "WorkflowVersion": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowVersionProperties", "description": "The workflow version properties." } }, "description": "The workflow version.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "WorkflowVersionProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/WorkflowProvisioningState", "readOnly": true, "description": "The provisioning state." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the changed time." }, "state": { "$ref": "#/definitions/WorkflowState", "description": "The state." }, "version": { "type": "string", "readOnly": true, "description": "Gets the version." }, "accessEndpoint": { "type": "string", "readOnly": true, "description": "Gets the access endpoint." }, "endpointsConfiguration": { "$ref": "#/definitions/FlowEndpointsConfiguration", "description": "The endpoints configuration." }, "accessControl": { "$ref": "#/definitions/FlowAccessControlConfiguration", "description": "The access control configuration." }, "sku": { "$ref": "#/definitions/Sku", "readOnly": true, "description": "The sku." }, "integrationAccount": { "$ref": "#/definitions/ResourceReference", "description": "The integration account." }, "definition": { "$ref": "#/definitions/Object", "description": "The definition." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/WorkflowParameter" }, "description": "The parameters." } }, "description": "The workflow version properties." }, "WorkflowVersionListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowVersion", "description": "The workflow version." }, "description": "A list of workflow versions." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow versions." }, "WorkflowTrigger": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowTriggerProperties", "description": "The workflow trigger properties." }, "name": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger type." } }, "description": "The workflow trigger.", "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "WorkflowTriggerProperties": { "type": "object", "properties": { "provisioningState": { "$ref": "#/definitions/WorkflowTriggerProvisioningState", "readOnly": true, "description": "Gets the provisioning state." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the changed time." }, "state": { "$ref": "#/definitions/WorkflowState", "readOnly": true, "description": "Gets the state." }, "status": { "$ref": "#/definitions/WorkflowStatus", "readOnly": true, "description": "Gets the status." }, "lastExecutionTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the last execution time." }, "nextExecutionTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the next execution time." }, "recurrence": { "$ref": "#/definitions/WorkflowTriggerRecurrence", "readOnly": true, "description": "Gets the workflow trigger recurrence." }, "workflow": { "$ref": "#/definitions/ResourceReference", "readOnly": true, "description": "Gets the reference to workflow." } }, "description": "The workflow trigger properties." }, "WorkflowTriggerFilter": { "type": "object", "properties": { "state": { "$ref": "#/definitions/WorkflowState", "description": "The state of workflow trigger." } }, "description": "The workflow trigger filter." }, "WorkflowTriggerListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowTrigger" }, "description": "A list of workflow triggers." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow triggers." }, "WorkflowTriggerCallbackUrl": { "type": "object", "properties": { "value": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger callback URL." }, "method": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger callback URL HTTP method." }, "basePath": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger callback URL base path." }, "relativePath": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger callback URL relative path." }, "relativePathParameters": { "type": "array", "items": { "type": "string" }, "description": "Gets the workflow trigger callback URL relative path parameters." }, "queries": { "$ref": "#/definitions/WorkflowTriggerListCallbackUrlQueries", "description": "Gets the workflow trigger callback URL query parameters." } }, "description": "The workflow trigger callback URL." }, "WorkflowTriggerListCallbackUrlQueries": { "type": "object", "properties": { "api-version": { "type": "string", "description": "The api version." }, "sp": { "type": "string", "description": "The SAS permissions." }, "sv": { "type": "string", "description": "The SAS version." }, "sig": { "type": "string", "description": "The SAS signature." }, "se": { "type": "string", "description": "The SAS timestamp." } }, "description": "Gets the workflow trigger callback URL query parameters." }, "WorkflowTriggerHistory": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowTriggerHistoryProperties", "description": "Gets the workflow trigger history properties." }, "name": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger history name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the workflow trigger history type." } }, "description": "The workflow trigger history.", "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "WorkflowTriggerHistoryProperties": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the start time." }, "endTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the end time." }, "scheduledTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The scheduled time." }, "status": { "$ref": "#/definitions/WorkflowStatus", "readOnly": true, "description": "Gets the status." }, "code": { "type": "string", "readOnly": true, "description": "Gets the code." }, "error": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the error." }, "trackingId": { "type": "string", "readOnly": true, "description": "Gets the tracking id." }, "correlation": { "$ref": "#/definitions/Correlation", "description": "The run correlation." }, "inputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to input parameters." }, "outputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to output parameters." }, "fired": { "type": "boolean", "readOnly": true, "description": "The value indicating whether trigger was fired." }, "run": { "$ref": "#/definitions/ResourceReference", "readOnly": true, "description": "Gets the reference to workflow run." } }, "description": "The workflow trigger history properties." }, "WorkflowTriggerHistoryListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowTriggerHistory" }, "description": "A list of workflow trigger histories." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow trigger histories." }, "WorkflowTriggerHistoryFilter": { "type": "object", "properties": { "status": { "$ref": "#/definitions/WorkflowStatus", "description": "The status of workflow trigger history." } }, "description": "The workflow trigger history filter." }, "WorkflowRun": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowRunProperties", "description": "The workflow run properties." }, "name": { "type": "string", "readOnly": true, "description": "Gets the workflow run name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the workflow run type." } }, "description": "The workflow run.", "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "WorkflowRunProperties": { "type": "object", "properties": { "waitEndTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the wait end time." }, "startTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the start time." }, "endTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the end time." }, "status": { "$ref": "#/definitions/WorkflowStatus", "readOnly": true, "description": "Gets the status." }, "code": { "type": "string", "readOnly": true, "description": "Gets the code." }, "error": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the error." }, "correlationId": { "type": "string", "readOnly": true, "description": "Gets the correlation id." }, "correlation": { "$ref": "#/definitions/Correlation", "description": "The run correlation." }, "workflow": { "$ref": "#/definitions/ResourceReference", "readOnly": true, "description": "Gets the reference to workflow version." }, "trigger": { "$ref": "#/definitions/WorkflowRunTrigger", "readOnly": true, "description": "Gets the fired trigger." }, "outputs": { "type": "object", "readOnly": true, "additionalProperties": { "$ref": "#/definitions/WorkflowOutputParameter", "description": "The workflow output parameter." }, "description": "Gets the outputs." }, "response": { "$ref": "#/definitions/WorkflowRunTrigger", "readOnly": true, "description": "Gets the response of the flow run." } }, "description": "The workflow run properties." }, "WorkflowRunFilter": { "type": "object", "properties": { "status": { "$ref": "#/definitions/WorkflowStatus", "description": "The status of workflow run." } }, "description": "The workflow run filter." }, "WorkflowRunListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowRun" }, "description": "A list of workflow runs." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow runs." }, "WorkflowRunAction": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkflowRunActionProperties", "description": "The workflow run action properties." }, "name": { "type": "string", "readOnly": true, "description": "Gets the workflow run action name." }, "type": { "type": "string", "readOnly": true, "description": "Gets the workflow run action type." } }, "description": "The workflow run action.", "allOf": [ { "$ref": "#/definitions/SubResource" } ] }, "WorkflowRunActionProperties": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the start time." }, "endTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the end time." }, "status": { "$ref": "#/definitions/WorkflowStatus", "readOnly": true, "description": "Gets the status." }, "code": { "type": "string", "readOnly": true, "description": "Gets the code." }, "error": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the error." }, "trackingId": { "type": "string", "readOnly": true, "description": "Gets the tracking id." }, "correlation": { "$ref": "#/definitions/RunActionCorrelation", "description": "The correlation properties." }, "inputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to inputs." }, "outputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to outputs." }, "trackedProperties": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the tracked properties." }, "retryHistory": { "type": "array", "items": { "$ref": "#/definitions/RetryHistory" }, "x-ms-identifiers": [], "description": "Gets the retry histories." } }, "description": "The workflow run action properties." }, "WorkflowRunActionFilter": { "type": "object", "properties": { "status": { "$ref": "#/definitions/WorkflowStatus", "description": "The status of workflow run action." } }, "description": "The workflow run action filter." }, "WorkflowRunActionListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowRunAction" }, "description": "A list of workflow run actions." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow run actions." }, "SkuName": { "type": "string", "enum": [ "NotSpecified", "Free", "Shared", "Basic", "Standard", "Premium" ], "x-ms-enum": { "name": "SkuName", "modelAsString": true }, "description": "The sku name." }, "WorkflowState": { "type": "string", "description": "The workflow state.", "enum": [ "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", "Suspended" ], "x-ms-enum": { "name": "WorkflowState", "modelAsString": true } }, "WorkflowStatus": { "type": "string", "description": "The workflow status.", "enum": [ "NotSpecified", "Paused", "Running", "Waiting", "Succeeded", "Skipped", "Suspended", "Cancelled", "Failed", "Faulted", "TimedOut", "Aborted", "Ignored" ], "x-ms-enum": { "name": "WorkflowStatus", "modelAsString": true } }, "ParameterType": { "type": "string", "description": "The parameter type.", "enum": [ "NotSpecified", "String", "SecureString", "Int", "Float", "Bool", "Array", "Object", "SecureObject" ], "x-ms-enum": { "name": "ParameterType", "modelAsString": true } }, "KeyType": { "type": "string", "description": "The key type.", "enum": [ "NotSpecified", "Primary", "Secondary" ], "x-ms-enum": { "name": "KeyType", "modelAsString": true } }, "Sku": { "type": "object", "description": "The sku type.", "required": [ "name" ], "properties": { "name": { "$ref": "#/definitions/SkuName", "description": "The name." }, "plan": { "$ref": "#/definitions/ResourceReference", "description": "The reference to plan." } } }, "ContentLink": { "type": "object", "properties": { "uri": { "type": "string", "description": "The content link URI." }, "contentVersion": { "type": "string", "description": "The content version.", "readOnly": true }, "contentSize": { "type": "integer", "format": "int64", "description": "The content size.", "readOnly": true }, "contentHash": { "$ref": "#/definitions/ContentHash", "description": "The content hash.", "readOnly": true }, "metadata": { "$ref": "#/definitions/Object", "description": "The metadata.", "readOnly": true } }, "description": "The content link." }, "ContentHash": { "type": "object", "properties": { "algorithm": { "type": "string", "description": "The algorithm of the content hash." }, "value": { "type": "string", "description": "The value of the content hash." } }, "description": "The content hash." }, "RegenerateActionParameter": { "type": "object", "properties": { "keyType": { "$ref": "#/definitions/KeyType", "description": "The key type." } }, "description": "The access key regenerate action content." }, "RetryHistory": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "Gets the start time." }, "endTime": { "type": "string", "format": "date-time", "description": "Gets the end time." }, "code": { "type": "string", "description": "Gets the status code." }, "clientRequestId": { "type": "string", "description": "Gets the client request Id." }, "serviceRequestId": { "type": "string", "description": "Gets the service request Id." }, "error": { "$ref": "#/definitions/ErrorResponse", "description": "Gets the error response." } }, "description": "The retry history." }, "Correlation": { "type": "object", "properties": { "clientTrackingId": { "type": "string", "description": "The client tracking id." } }, "description": "The correlation property." }, "WorkflowParameter": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ParameterType", "description": "The type." }, "value": { "$ref": "#/definitions/Object", "description": "The value." }, "metadata": { "$ref": "#/definitions/Object", "description": "The metadata." }, "description": { "type": "string", "description": "The description." } }, "description": "The workflow parameters." }, "WorkflowOutputParameter": { "type": "object", "properties": { "error": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the error." } }, "description": "The workflow output parameter.", "allOf": [ { "$ref": "#/definitions/WorkflowParameter" } ] }, "RecurrenceFrequency": { "type": "string", "description": "The recurrence frequency.", "enum": [ "NotSpecified", "Second", "Minute", "Hour", "Day", "Week", "Month", "Year" ], "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": true } }, "RecurrenceSchedule": { "type": "object", "properties": { "minutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The minutes." }, "hours": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The hours." }, "weekDays": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "x-ms-enum": { "name": "DaysOfWeek", "modelAsString": false } }, "description": "The days of the week." }, "monthDays": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The month days." }, "monthlyOccurrences": { "type": "array", "items": { "$ref": "#/definitions/RecurrenceScheduleOccurrence" }, "x-ms-identifiers": [], "description": "The monthly occurrences." } }, "description": "The recurrence schedule." }, "RecurrenceScheduleOccurrence": { "type": "object", "properties": { "day": { "$ref": "#/definitions/DayOfWeek", "description": "The day of the week." }, "occurrence": { "type": "integer", "format": "int32", "description": "The occurrence." } }, "description": "The recurrence schedule occurrence." }, "WorkflowTriggerRecurrence": { "type": "object", "properties": { "frequency": { "$ref": "#/definitions/RecurrenceFrequency", "description": "The frequency." }, "interval": { "type": "integer", "format": "int32", "description": "The interval." }, "startTime": { "type": "string", "description": "The start time." }, "endTime": { "type": "string", "description": "The end time." }, "timeZone": { "type": "string", "description": "The time zone." }, "schedule": { "$ref": "#/definitions/RecurrenceSchedule", "description": "The recurrence schedule." } }, "description": "The workflow trigger recurrence." }, "WorkflowRunTrigger": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "description": "Gets the name." }, "inputs": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the inputs." }, "inputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to inputs." }, "outputs": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the outputs." }, "outputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to outputs." }, "scheduledTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the scheduled time." }, "startTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the start time." }, "endTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "Gets the end time." }, "trackingId": { "type": "string", "readOnly": true, "description": "Gets the tracking id." }, "correlation": { "$ref": "#/definitions/Correlation", "description": "The run correlation." }, "code": { "type": "string", "readOnly": true, "description": "Gets the code." }, "status": { "$ref": "#/definitions/WorkflowStatus", "readOnly": true, "description": "Gets the status." }, "error": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the error." }, "trackedProperties": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the tracked properties." } }, "description": "The workflow run trigger." }, "WorkflowTriggerProvisioningState": { "type": "string", "description": "The workflow trigger provisioning state.", "enum": [ "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed" ], "x-ms-enum": { "name": "WorkflowTriggerProvisioningState", "modelAsString": true } }, "WorkflowProvisioningState": { "type": "string", "description": "The workflow provisioning state.", "enum": [ "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", "InProgress" ], "x-ms-enum": { "name": "WorkflowProvisioningState", "modelAsString": true } }, "DayOfWeek": { "type": "string", "description": "The day of the week.", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "x-ms-enum": { "name": "DayOfWeek", "modelAsString": false } }, "GenerateUpgradedDefinitionParameters": { "type": "object", "properties": { "targetSchemaVersion": { "type": "string", "description": "The target schema version." } }, "description": "The parameters to generate upgraded definition." }, "ApiTier": { "description": "The Api tier.", "type": "string", "enum": [ "NotSpecified", "Enterprise", "Standard", "Premium" ], "x-ms-enum": { "name": "ApiTier", "modelAsString": true } }, "ApiOperationAnnotation": { "type": "object", "description": "The Api Operation Annotation.", "properties": { "status": { "$ref": "#/definitions/StatusAnnotation" }, "family": { "type": "string", "description": "The family." }, "revision": { "type": "integer", "description": "The revision." } } }, "SwaggerXml": { "type": "object", "description": "The Swagger XML.", "properties": { "name": { "type": "string", "description": "The xml element or attribute name." }, "namespace": { "type": "string", "description": "The xml namespace." }, "prefix": { "type": "string", "description": "The name prefix." }, "attribute": { "type": "boolean", "description": "Indicates whether the property should be an attribute instead of an element." }, "wrapped": { "type": "boolean", "description": "Indicates whether the array elements are wrapped in a container element." }, "extensions": { "type": "object", "description": "The vendor extensions.", "additionalProperties": { "$ref": "#/definitions/Object" } } } }, "SwaggerExternalDocumentation": { "type": "object", "description": "The swagger external documentation", "properties": { "description": { "type": "string", "description": "The document description." }, "uri": { "description": "The documentation Uri.", "type": "string" }, "extensions": { "type": "object", "description": "The vendor extensions.", "additionalProperties": { "$ref": "#/definitions/Object" } } } }, "SwaggerCustomDynamicSchema": { "type": "object", "description": "The swagger custom dynamic schema.", "properties": { "operationId": { "type": "string", "description": "The operation id to fetch dynamic schema." }, "valuePath": { "type": "string", "description": "Json pointer to the dynamic schema on the response body." }, "parameters": { "type": "object", "description": "The operation parameters.", "additionalProperties": { "$ref": "#/definitions/Object" } } } }, "SwaggerCustomDynamicProperties": { "type": "object", "description": "The swagger custom dynamic properties.", "properties": { "operationId": { "type": "string", "description": "The operation id to fetch dynamic schema." }, "valuePath": { "type": "string", "description": "Json pointer to the dynamic schema on the response body." }, "parameters": { "type": "object", "description": "The operation parameters.", "additionalProperties": { "$ref": "#/definitions/SwaggerCustomDynamicProperties" } } } }, "SwaggerCustomDynamicList": { "type": "object", "description": "The swagger custom dynamic list.", "properties": { "operationId": { "type": "string", "description": "The operation id to fetch dynamic schema." }, "builtInOperation": { "type": "string", "description": "The built in operation." }, "itemsPath": { "type": "string", "description": "The path to a response property (relative to the response object, not the response body) which contains an array of dynamic value items." }, "itemValuePath": { "type": "string", "description": "The path to a property which defines the value which should be used." }, "itemTitlePath": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "parameters": { "type": "object", "description": "The parameters.", "additionalProperties": { "$ref": "#/definitions/SwaggerCustomDynamicProperties" } } } }, "SwaggerCustomDynamicTree": { "type": "object", "description": "The swagger custom dynamic tree.", "properties": { "settings": { "description": "The tree settings", "$ref": "#/definitions/SwaggerCustomDynamicTreeSettings" }, "open": { "description": "The tree on-open configuration", "$ref": "#/definitions/SwaggerCustomDynamicTreeCommand" }, "browse": { "description": "The tree on-browse configuration", "$ref": "#/definitions/SwaggerCustomDynamicTreeCommand" } } }, "SwaggerCustomDynamicTreeParameter": { "type": "object", "description": "The swagger custom dynamic tree parameter.", "properties": { "selectedItemValuePath": { "type": "string", "description": "Gets or sets a path to a property in the currently selected item to pass as a value to a parameter for the given operation." }, "value": { "$ref": "#/definitions/Object", "description": "The parameter value." }, "parameterReference": { "type": "string", "description": "The parameter reference." }, "required": { "type": "boolean", "description": "Indicates whether the parameter is required." } } }, "SwaggerCustomDynamicTreeCommand": { "type": "object", "description": "The swagger tree command.", "properties": { "operationId": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "itemsPath": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "itemValuePath": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "itemTitlePath": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "itemFullTitlePath": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "itemIsParent": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "selectableFilter": { "type": "string", "description": "The path to an item property which defines the display name of the item." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/SwaggerCustomDynamicTreeParameter" } } } }, "SwaggerCustomDynamicTreeSettings": { "type": "object", "description": "The swagger custom dynamic tree settings.", "properties": { "CanSelectParentNodes": { "type": "boolean", "description": "Indicates whether parent nodes can be selected." }, "CanSelectLeafNodes": { "type": "boolean", "description": "Indicates whether leaf nodes can be selected." } } }, "SwaggerSchemaType": { "type": "string", "enum": [ "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null" ], "x-ms-enum": { "name": "SwaggerSchemaType", "modelAsString": true }, "description": "The swagger schema type." }, "SwaggerSchema": { "type": "object", "description": "The swagger schema.", "properties": { "ref": { "type": "string", "description": "The reference." }, "type": { "$ref": "#/definitions/SwaggerSchemaType", "description": "The type" }, "title": { "type": "string", "description": "The title." }, "items": { "description": "The items schema.", "$ref": "#/definitions/SwaggerSchema" }, "properties": { "type": "object", "x-ms-client-flatten": true, "description": "The object properties", "additionalProperties": { "$ref": "#/definitions/SwaggerSchema" } }, "additionalProperties": { "description": "The additional properties.", "$ref": "#/definitions/Object" }, "required": { "type": "array", "description": "The object required properties.", "items": { "type": "string" } }, "maxProperties": { "type": "integer", "description": "The maximum number of allowed properties." }, "minProperties": { "type": "integer", "description": "The minimum number of allowed properties." }, "allOf": { "type": "array", "description": "The schemas which must pass validation when this schema is used.", "items": { "$ref": "#/definitions/SwaggerSchema" }, "x-ms-identifiers": [] }, "discriminator": { "type": "string", "description": "The discriminator." }, "readOnly": { "type": "boolean", "description": "Indicates whether this property must be present in the a request." }, "xml": { "$ref": "#/definitions/SwaggerXml", "description": "The xml representation format for a property." }, "externalDocs": { "$ref": "#/definitions/SwaggerExternalDocumentation", "description": "The external documentation." }, "example": { "description": "The example value.", "$ref": "#/definitions/Object" }, "notificationUrlExtension": { "type": "boolean", "description": "Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook." }, "dynamicSchemaOld": { "$ref": "#/definitions/SwaggerCustomDynamicSchema", "description": "The dynamic schema configuration." }, "dynamicSchemaNew": { "$ref": "#/definitions/SwaggerCustomDynamicProperties", "description": "The dynamic schema configuration." }, "dynamicListNew": { "$ref": "#/definitions/SwaggerCustomDynamicList", "description": "The dynamic list." }, "dynamicTree": { "$ref": "#/definitions/SwaggerCustomDynamicTree", "description": "The dynamic values tree configuration." } } }, "ApiOperationPropertiesDefinition": { "type": "object", "description": "The api operations properties", "properties": { "summary": { "type": "string", "description": "The summary of the api operation." }, "description": { "type": "string", "description": "The description of the api operation." }, "visibility": { "type": "string", "description": "The visibility of the api operation." }, "trigger": { "type": "string", "description": "The trigger type of api operation." }, "triggerHint": { "type": "string", "description": "The trigger hint for the api operation." }, "pageable": { "type": "boolean", "description": "Indicates whether the api operation is pageable." }, "annotation": { "$ref": "#/definitions/ApiOperationAnnotation", "description": "The annotation of api operation." }, "api": { "$ref": "#/definitions/ApiReference", "description": "The api reference." }, "inputsDefinition": { "$ref": "#/definitions/SwaggerSchema", "description": "The operation inputs definition schema." }, "responsesDefinition": { "type": "object", "description": "The operation responses definition schemas.", "additionalProperties": { "$ref": "#/definitions/SwaggerSchema" } }, "isWebhook": { "type": "boolean", "description": "Indicates whether the API operation is webhook or not." }, "isNotification": { "type": "boolean", "description": "Indicates whether the API operation is notification or not." } } }, "ApiOperation": { "type": "object", "description": "The api operation.", "properties": { "properties": { "$ref": "#/definitions/ApiOperationPropertiesDefinition" } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "ApiOperationListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApiOperation" }, "description": "The api operation definitions for an API." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of managed API operations." }, "StatusAnnotation": { "type": "string", "description": "The status annotation.", "enum": [ "NotSpecified", "Preview", "Production" ], "x-ms-enum": { "name": "StatusAnnotation", "modelAsString": true } }, "WorkflowTriggerReference": { "type": "object", "description": "The workflow trigger reference.", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The workflow trigger resource reference name." }, "flowName": { "type": "string", "description": "The workflow name." }, "triggerName": { "type": "string", "description": "The workflow trigger name." } }, "allOf": [ { "$ref": "#/definitions/ResourceReference" } ] }, "WorkflowReference": { "type": "object", "description": "The workflow reference.", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The workflow name." } }, "allOf": [ { "$ref": "#/definitions/ResourceReference" } ] }, "ApiReference": { "type": "object", "description": "The Api reference.", "properties": { "displayName": { "type": "string", "description": "The display name of the api." }, "description": { "type": "string", "description": "The description of the api." }, "iconUri": { "type": "string", "description": "The icon uri of the api." }, "swagger": { "$ref": "#/definitions/Object", "description": "The swagger of the api." }, "brandColor": { "type": "string", "description": "The brand color of the api." }, "category": { "$ref": "#/definitions/ApiTier", "description": "The tier." }, "integrationServiceEnvironment": { "$ref": "#/definitions/ResourceReference", "description": "The integration service environment reference." } }, "allOf": [ { "$ref": "#/definitions/ResourceReference" } ] }, "ManagedApiListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ManagedApi" }, "description": "The managed APIs." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of managed APIs." }, "ApiResourceProperties": { "type": "object", "description": "The API resource properties.", "properties": { "name": { "type": "string", "description": "The name", "readOnly": true }, "connectionParameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Object" }, "description": "The connection parameters.", "readOnly": true }, "metadata": { "$ref": "#/definitions/ApiResourceMetadata", "description": "The metadata.", "readOnly": true }, "runtimeUrls": { "type": "array", "description": "The runtime urls.", "items": { "type": "string" }, "readOnly": true }, "generalInformation": { "$ref": "#/definitions/ApiResourceGeneralInformation", "description": "The api general information.", "readOnly": true }, "capabilities": { "type": "array", "description": "The capabilities.", "items": { "type": "string" }, "readOnly": true }, "backendService": { "$ref": "#/definitions/ApiResourceBackendService", "description": "The backend service.", "readOnly": true }, "policies": { "$ref": "#/definitions/ApiResourcePolicies", "description": "The policies for the API.", "readOnly": true }, "apiDefinitionUrl": { "type": "string", "description": "The API definition.", "readOnly": true }, "apiDefinitions": { "$ref": "#/definitions/ApiResourceDefinitions", "description": "The api definitions.", "readOnly": true }, "integrationServiceEnvironment": { "$ref": "#/definitions/ResourceReference", "description": "The integration service environment reference." }, "provisioningState": { "$ref": "#/definitions/WorkflowProvisioningState", "description": "The provisioning state.", "readOnly": true }, "category": { "$ref": "#/definitions/ApiTier", "description": "The category.", "readOnly": true } } }, "ApiResourcePolicies": { "type": "object", "description": "The API resource policies.", "properties": { "content": { "type": "string", "description": "The API level only policies XML as embedded content." }, "contentLink": { "type": "string", "description": "The content link to the policies." } } }, "ApiResourceDefinitions": { "type": "object", "description": "The Api resource definition.", "properties": { "originalSwaggerUrl": { "type": "string", "description": "The original swagger url." }, "modifiedSwaggerUrl": { "type": "string", "description": "The modified swagger url." } } }, "ApiDeploymentParameterMetadataSet": { "type": "object", "description": "The API deployment parameters metadata.", "properties": { "packageContentLink": { "$ref": "#/definitions/ApiDeploymentParameterMetadata", "description": "The package content link parameter." }, "redisCacheConnectionString": { "$ref": "#/definitions/ApiDeploymentParameterMetadata", "description": "The package content link parameter." } } }, "ApiDeploymentParameterMetadata": { "type": "object", "description": "The API deployment parameter metadata.", "properties": { "type": { "type": "string", "description": "The type." }, "isRequired": { "type": "boolean", "description": "Indicates whether its required." }, "displayName": { "type": "string", "description": "The display name." }, "description": { "type": "string", "description": "The description." }, "visibility": { "$ref": "#/definitions/ApiDeploymentParameterVisibility", "description": "The visibility." } } }, "ApiDeploymentParameterVisibility": { "type": "string", "description": "The Api deployment parameter visibility.", "enum": [ "NotSpecified", "Default", "Internal" ], "x-ms-enum": { "name": "ApiDeploymentParameterVisibility", "modelAsString": true } }, "ApiResourceBackendService": { "type": "object", "properties": { "serviceUrl": { "type": "string", "description": "The service URL." } }, "description": "The API backend service." }, "ApiResourceMetadata": { "type": "object", "description": "The api resource metadata.", "properties": { "source": { "type": "string", "description": "The source." }, "brandColor": { "type": "string", "description": "The brand color." }, "hideKey": { "type": "string", "description": "The hide key." }, "tags": { "type": "object", "description": "The tags.", "additionalProperties": { "type": "string" } }, "ApiType": { "$ref": "#/definitions/ApiType", "description": "The api type." }, "wsdlService": { "$ref": "#/definitions/WsdlService", "description": "The WSDL service." }, "wsdlImportMethod": { "$ref": "#/definitions/WsdlImportMethod", "description": "The WSDL import method." }, "connectionType": { "type": "string", "description": "The connection type." }, "provisioningState": { "$ref": "#/definitions/WorkflowProvisioningState", "description": "The provisioning state." }, "deploymentParameters": { "$ref": "#/definitions/ApiDeploymentParameterMetadataSet", "description": "The connector deployment parameters metadata." } } }, "ApiType": { "type": "string", "enum": [ "NotSpecified", "Rest", "Soap" ], "x-ms-enum": { "name": "ApiType", "modelAsString": true } }, "WsdlService": { "type": "object", "description": "The WSDL service.", "properties": { "qualifiedName": { "type": "string", "description": "The qualified name." }, "EndpointQualifiedNames": { "type": "array", "description": "The list of endpoints' qualified names.", "items": { "type": "string" } } } }, "WsdlImportMethod": { "type": "string", "description": "The WSDL import method.", "enum": [ "NotSpecified", "SoapToRest", "SoapPassThrough" ], "x-ms-enum": { "name": "WsdlImportMethod", "modelAsString": true } }, "ApiResourceGeneralInformation": { "type": "object", "description": "The API general information.", "properties": { "iconUrl": { "type": "string", "description": "The icon url." }, "displayName": { "type": "string", "description": "The display name." }, "description": { "type": "string", "description": "The description." }, "termsOfUseUrl": { "type": "string", "description": "The terms of use url." }, "releaseTag": { "type": "string", "description": "The release tag." }, "tier": { "$ref": "#/definitions/ApiTier", "description": "The tier." } } }, "ManagedApi": { "type": "object", "description": "The managed api definition.", "properties": { "properties": { "$ref": "#/definitions/ApiResourceProperties", "description": "The api resource properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationServiceEnvironmentNetworkEndPointAccessibilityState": { "type": "string", "description": "The integration service environment network endpoint accessibility state.", "enum": [ "NotSpecified", "Unknown", "Available", "NotAvailable" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentNetworkEndPointAccessibilityState", "modelAsString": true } }, "IntegrationServiceEnvironmentNetworkEndpoint": { "type": "object", "description": "The network endpoint.", "properties": { "accessibility": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkEndPointAccessibilityState", "description": "The accessibility state." }, "domainName": { "type": "string", "description": "The domain name." }, "ports": { "type": "array", "description": "The ports.", "items": { "type": "string" } } } }, "IntegrationServiceEnvironmentNetworkDependencyCategoryType": { "type": "string", "description": "The integration service environment network dependency category type.", "enum": [ "NotSpecified", "AzureStorage", "AzureManagement", "AzureActiveDirectory", "SSLCertificateVerification", "DiagnosticLogsAndMetrics", "IntegrationServiceEnvironmentConnectors", "RedisCache", "AccessEndpoints", "RecoveryService", "SQL", "RegionalService" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentNetworkDependencyCategoryType", "modelAsString": true } }, "IntegrationServiceEnvironmentNetworkDependency": { "type": "object", "description": "The azure async operation resource.", "properties": { "category": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkDependencyCategoryType", "description": "The network dependency category type." }, "displayName": { "type": "string", "description": "The display name." }, "endpoints": { "type": "array", "description": "The endpoints.", "items": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkEndpoint", "description": "The endpoint." }, "x-ms-identifiers": [] } } }, "IntegrationServiceEnvironmentNetworkDependencyHealthState": { "type": "string", "description": "The integration service environment network dependency health state.", "enum": [ "NotSpecified", "Healthy", "Unhealthy", "Unknown" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentNetworkDependencyHealthState", "modelAsString": true } }, "IntegrationServiceEnvironmentNetworkDependencyHealth": { "type": "object", "description": "The integration service environment subnet network health.", "properties": { "error": { "$ref": "#/definitions/ExtendedErrorInfo", "description": "The error if any occurred during the operation." }, "state": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkDependencyHealthState", "description": "The network dependency health state." } } }, "IntegrationServiceEnvironmentNetworkHealth": { "type": "object", "description": "The integration service environment network health of all the subnets.", "additionalProperties": { "$ref": "#/definitions/IntegrationServiceEnvironmentSubnetNetworkHealth", "description": "The integration service environment subnet network health." } }, "IntegrationServiceEnvironmentSubnetNetworkHealth": { "type": "object", "description": "The integration service environment subnet network health.", "required": [ "networkDependencyHealthState" ], "properties": { "outboundNetworkDependencies": { "description": "The outbound network dependencies.", "type": "array", "items": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkDependency", "description": "The integration service environment network dependency." }, "x-ms-identifiers": [] }, "outboundNetworkHealth": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkDependencyHealth", "description": "The integration service environment network health." }, "networkDependencyHealthState": { "$ref": "#/definitions/IntegrationServiceEnvironmentNetworkEndPointAccessibilityState", "description": "The integration service environment network health state." } } }, "ExtendedErrorInfo": { "type": "object", "description": "The extended error info.", "required": [ "code", "message" ], "properties": { "code": { "description": "The error code.", "$ref": "#/definitions/ErrorResponseCode" }, "message": { "type": "string", "description": "The error message." }, "details": { "type": "array", "description": "The error message details.", "items": { "$ref": "#/definitions/ExtendedErrorInfo" }, "x-ms-identifiers": [ "code" ] }, "innerError": { "$ref": "#/definitions/Object", "description": "The inner error." } } }, "ErrorResponseCode": { "type": "string", "description": "The error response code.", "enum": [ "NotSpecified", "IntegrationServiceEnvironmentNotFound", "InternalServerError", "InvalidOperationId" ], "x-ms-enum": { "name": "ErrorResponseCode", "modelAsString": true } }, "AzureAsyncOperationState": { "type": "string", "description": "The Azure async operation state.", "enum": [ "Failed", "Succeeded", "Pending", "Canceled" ], "x-ms-enum": { "name": "AzureAsyncOperationState", "modelAsString": true } }, "IntegrationServiceEnvironmentListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationServiceEnvironment", "description": "The integration service environment." } }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration service environments." }, "IntegrationServiceEnvironment": { "type": "object", "description": "The integration service environment.", "properties": { "properties": { "$ref": "#/definitions/IntegrationServiceEnvironmentProperties", "description": "The integration service environment properties." }, "sku": { "$ref": "#/definitions/IntegrationServiceEnvironmentSku", "description": "The sku." }, "identity": { "$ref": "#/definitions/ManagedServiceIdentity" } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationServiceEnvironmentSku": { "type": "object", "description": "The integration service environment sku.", "properties": { "name": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuName", "description": "The sku name." }, "capacity": { "type": "integer", "format": "int32", "description": "The sku capacity." } } }, "IntegrationServiceEnvironmentProperties": { "type": "object", "description": "The integration service environment properties.", "properties": { "provisioningState": { "$ref": "#/definitions/WorkflowProvisioningState", "description": "The provisioning state." }, "state": { "$ref": "#/definitions/WorkflowState", "description": "The integration service environment state." }, "integrationServiceEnvironmentId": { "type": "string", "description": "Gets the tracking id." }, "endpointsConfiguration": { "$ref": "#/definitions/FlowEndpointsConfiguration", "description": "The endpoints configuration." }, "networkConfiguration": { "$ref": "#/definitions/NetworkConfiguration", "description": "The network configuration." }, "encryptionConfiguration": { "$ref": "#/definitions/IntegrationServiceEnvironmenEncryptionConfiguration", "description": "The encryption configuration." } } }, "IntegrationServiceEnvironmentSkuName": { "type": "string", "description": "The integration service environment sku name.", "enum": [ "NotSpecified", "Premium", "Developer" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentSkuName", "modelAsString": true } }, "NetworkConfiguration": { "type": "object", "description": "The network configuration.", "properties": { "virtualNetworkAddressSpace": { "type": "string", "description": "Gets the virtual network address space." }, "accessEndpoint": { "$ref": "#/definitions/IntegrationServiceEnvironmentAccessEndpoint", "description": "The access endpoint." }, "subnets": { "type": "array", "description": "The subnets.", "items": { "$ref": "#/definitions/ResourceReference", "description": "The subnet." } } } }, "IntegrationServiceEnvironmentAccessEndpoint": { "type": "object", "description": "The integration service environment access endpoint.", "properties": { "type": { "$ref": "#/definitions/IntegrationServiceEnvironmentAccessEndpointType", "description": "The access endpoint type." } } }, "IntegrationServiceEnvironmentAccessEndpointType": { "type": "string", "description": "The integration service environment access endpoint type.", "enum": [ "NotSpecified", "External", "Internal" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentAccessEndpointType", "modelAsString": true } }, "IntegrationServiceEnvironmenEncryptionConfiguration": { "type": "object", "description": "The encryption configuration for the integration service environment.", "properties": { "encryptionKeyReference": { "$ref": "#/definitions/IntegrationServiceEnvironmenEncryptionKeyReference", "description": "The encryption key reference." } } }, "IntegrationServiceEnvironmenEncryptionKeyReference": { "type": "object", "description": "The encryption key details for the integration service environment.", "properties": { "keyVault": { "$ref": "#/definitions/ResourceReference", "description": "The key vault reference." }, "keyName": { "type": "string", "description": "Gets the key name in the Key Vault." }, "keyVersion": { "type": "string", "description": "Gets the version of the key specified in the keyName property." } } }, "FlowAccessControlConfiguration": { "type": "object", "description": "The access control configuration.", "properties": { "triggers": { "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", "description": "The access control configuration for invoking workflow triggers." }, "contents": { "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", "description": "The access control configuration for accessing workflow run contents." }, "actions": { "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", "description": "The access control configuration for workflow actions." }, "workflowManagement": { "$ref": "#/definitions/FlowAccessControlConfigurationPolicy", "description": "The access control configuration for workflow management." } } }, "FlowAccessControlConfigurationPolicy": { "type": "object", "description": "The access control configuration policy.", "properties": { "allowedCallerIpAddresses": { "type": "array", "description": "The allowed caller IP address ranges.", "items": { "$ref": "#/definitions/IpAddressRange", "description": "The ip address range." }, "x-ms-identifiers": [] }, "openAuthenticationPolicies": { "$ref": "#/definitions/OpenAuthenticationAccessPolicies", "description": "The authentication policies for workflow." } } }, "IpAddressRange": { "type": "object", "description": "The ip address range.", "properties": { "addressRange": { "type": "string", "description": "The IP address range." } } }, "OpenAuthenticationAccessPolicies": { "type": "object", "description": "AuthenticationPolicy of type Open.", "properties": { "policies": { "type": "object", "additionalProperties": { "$ref": "#/definitions/OpenAuthenticationAccessPolicy" }, "description": "Open authentication policies." } } }, "OpenAuthenticationAccessPolicy": { "type": "object", "description": "Open authentication access policy defined by user.", "properties": { "type": { "$ref": "#/definitions/OpenAuthenticationProviderType", "description": "Type of provider for OAuth." }, "claims": { "type": "array", "description": "The access policy claims.", "items": { "$ref": "#/definitions/OpenAuthenticationPolicyClaim", "description": "The access policy claim." }, "x-ms-identifiers": [ "name" ] } } }, "OpenAuthenticationProviderType": { "type": "string", "description": "Open authentication policy provider type.", "enum": [ "AAD" ], "x-ms-enum": { "name": "OpenAuthenticationProviderType", "modelAsString": true } }, "OpenAuthenticationPolicyClaim": { "type": "object", "description": "Open authentication policy claim.", "properties": { "name": { "type": "string", "description": "The name of the claim." }, "value": { "type": "string", "description": "The value of the claim." } } }, "FlowEndpointsConfiguration": { "type": "object", "description": "The endpoints configuration.", "properties": { "workflow": { "$ref": "#/definitions/FlowEndpoints", "description": "The workflow endpoints." }, "connector": { "$ref": "#/definitions/FlowEndpoints", "description": "The connector endpoints." } } }, "FlowEndpoints": { "type": "object", "description": "The flow endpoints configuration.", "properties": { "outgoingIpAddresses": { "type": "array", "description": "The outgoing ip address.", "items": { "$ref": "#/definitions/IpAddress", "description": "The ip address." }, "x-ms-identifiers": [ "address" ] }, "accessEndpointIpAddresses": { "type": "array", "description": "The access endpoint ip address.", "items": { "$ref": "#/definitions/IpAddress", "description": "The ip address." }, "x-ms-identifiers": [ "address" ] } } }, "IpAddress": { "type": "object", "description": "The ip address.", "properties": { "address": { "type": "string", "description": "The address." } } }, "ManagedServiceIdentity": { "description": "Managed service identity properties.", "type": "object", "properties": { "type": { "description": "Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource.", "enum": [ "SystemAssigned", "UserAssigned", "None" ], "type": "string", "x-ms-enum": { "name": "ManagedServiceIdentityType", "modelAsString": true } }, "tenantId": { "description": "Tenant of managed service identity.", "type": "string", "format": "uuid", "readOnly": true }, "principalId": { "description": "Principal Id of managed service identity.", "type": "string", "format": "uuid", "readOnly": true }, "userAssignedIdentities": { "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}", "type": "object", "additionalProperties": { "$ref": "#/definitions/userAssignedIdentity" } } }, "required": [ "type" ] }, "userAssignedIdentity": { "description": "User Assigned identity properties.", "type": "object", "properties": { "principalId": { "description": "Principal Id of user assigned identity", "type": "string", "readOnly": true }, "clientId": { "description": "Client Id of user assigned identity", "type": "string", "readOnly": true } } }, "IntegrationServiceEnvironmentSkuList": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuDefinition" }, "x-ms-identifiers": [ "sku/name", "sku/tier" ], "description": "The list of integration service environment skus." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration service environment skus." }, "IntegrationServiceEnvironmentSkuDefinition": { "type": "object", "description": "The integration service environment sku definition.", "properties": { "resourceType": { "description": "The resource type.", "type": "string" }, "sku": { "type": "object", "description": "The sku.", "properties": { "name": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuName", "description": "The sku name." }, "tier": { "type": "string", "description": "The sku tier." } } }, "capacity": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuCapacity", "description": "The sku capacity." } } }, "IntegrationServiceEnvironmentSkuCapacity": { "type": "object", "description": "The integration service environment sku capacity.", "properties": { "minimum": { "type": "integer", "format": "int32", "description": "The minimum capacity." }, "maximum": { "type": "integer", "format": "int32", "description": "The maximum capacity." }, "default": { "type": "integer", "format": "int32", "description": "The default capacity." }, "scaleType": { "$ref": "#/definitions/IntegrationServiceEnvironmentSkuScaleType", "description": "The sku scale type." } } }, "IntegrationServiceEnvironmentSkuScaleType": { "type": "string", "description": "The integration service environment sku scale type.", "enum": [ "Manual", "Automatic", "None" ], "x-ms-enum": { "name": "IntegrationServiceEnvironmentSkuScaleType", "modelAsString": true } }, "IntegrationServiceEnvironmentManagedApiListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApi" }, "description": "The integration service environment managed APIs." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration service environment managed APIs." }, "IntegrationServiceEnvironmentManagedApi": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApiProperties", "description": "The integration service environment managed api properties." } }, "description": "The integration service environment managed api.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationServiceEnvironmentManagedApiProperties": { "type": "object", "description": "The integration service environment managed api properties.", "properties": { "deploymentParameters": { "$ref": "#/definitions/IntegrationServiceEnvironmentManagedApiDeploymentParameters", "description": "The integration service environment managed api deployment parameters." } }, "allOf": [ { "$ref": "#/definitions/ApiResourceProperties" } ] }, "IntegrationServiceEnvironmentManagedApiDeploymentParameters": { "type": "object", "description": "The integration service environment managed api deployment parameters.", "properties": { "contentLinkDefinition": { "$ref": "#/definitions/ContentLink", "description": "The integration service environment managed api content link for deployment." } } }, "IntegrationAccountSkuName": { "type": "string", "description": "The integration account sku name.", "enum": [ "NotSpecified", "Free", "Basic", "Standard" ], "x-ms-enum": { "name": "IntegrationAccountSkuName", "modelAsString": true } }, "IntegrationAccount": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountProperties", "description": "The integration account properties." }, "sku": { "$ref": "#/definitions/IntegrationAccountSku", "description": "The sku." } }, "description": "The integration account.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountProperties": { "type": "object", "description": "The integration account properties.", "properties": { "integrationServiceEnvironment": { "$ref": "#/definitions/ResourceReference", "description": "The integration service environment." }, "state": { "$ref": "#/definitions/WorkflowState", "description": "The workflow state." } } }, "IntegrationAccountListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccount" }, "description": "The list of integration accounts." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration accounts." }, "GetCallbackUrlParameters": { "type": "object", "properties": { "notAfter": { "type": "string", "format": "date-time", "description": "The expiry time." }, "keyType": { "$ref": "#/definitions/KeyType", "description": "The key type." } }, "description": "The callback url parameters." }, "CallbackUrl": { "type": "object", "properties": { "value": { "type": "string", "description": "The URL value." } }, "description": "The callback url." }, "IntegrationAccountSchema": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountSchemaProperties", "description": "The integration account schema properties." } }, "description": "The integration account schema.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountSchemaProperties": { "type": "object", "required": [ "schemaType" ], "properties": { "schemaType": { "$ref": "#/definitions/SchemaType", "description": "The schema type." }, "targetNamespace": { "type": "string", "description": "The target namespace of the schema." }, "documentName": { "type": "string", "description": "The document name." }, "fileName": { "type": "string", "description": "The file name." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "metadata": { "type": "object", "description": "The metadata.", "properties": {} }, "content": { "type": "string", "description": "The content.", "properties": {} }, "contentType": { "type": "string", "description": "The content type." }, "contentLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "The content link." } }, "description": "The integration account schema properties." }, "IntegrationAccountSchemaListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountSchema" }, "description": "The list of integration account schemas." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account schemas." }, "IntegrationAccountSchemaFilter": { "type": "object", "required": [ "schemaType" ], "properties": { "schemaType": { "$ref": "#/definitions/SchemaType", "description": "The schema type of integration account schema." } }, "description": "The integration account schema filter for odata query." }, "SchemaType": { "type": "string", "description": "The schema type.", "enum": [ "NotSpecified", "Xml" ], "x-ms-enum": { "name": "SchemaType", "modelAsString": true } }, "IntegrationAccountMap": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountMapProperties", "description": "The integration account map properties." } }, "description": "The integration account map.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountMapProperties": { "type": "object", "required": [ "mapType" ], "properties": { "mapType": { "$ref": "#/definitions/MapType", "description": "The map type." }, "parametersSchema": { "type": "object", "properties": { "ref": { "type": "string", "description": "The reference name." } }, "description": "The parameters schema of integration account map." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "content": { "type": "string", "description": "The content.", "properties": {} }, "contentType": { "type": "string", "description": "The content type." }, "contentLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "The content link." }, "metadata": { "type": "object", "description": "The metadata.", "properties": {} } }, "description": "The integration account map." }, "IntegrationAccountMapListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountMap" }, "description": "The list of integration account maps." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account maps." }, "IntegrationAccountMapFilter": { "type": "object", "required": [ "mapType" ], "properties": { "mapType": { "$ref": "#/definitions/MapType", "description": "The map type of integration account map." } }, "description": "The integration account map filter for odata query." }, "MapType": { "type": "string", "description": "The map type.", "enum": [ "NotSpecified", "Xslt", "Xslt20", "Xslt30", "Liquid" ], "x-ms-enum": { "name": "MapType", "modelAsString": true } }, "IntegrationAccountSku": { "type": "object", "required": [ "name" ], "properties": { "name": { "$ref": "#/definitions/IntegrationAccountSkuName", "description": "The sku name." } }, "description": "The integration account sku." }, "IntegrationAccountPartnerListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountPartner" }, "description": "The list of integration account partners." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account partners." }, "IntegrationAccountPartnerFilter": { "type": "object", "required": [ "partnerType" ], "properties": { "partnerType": { "$ref": "#/definitions/PartnerType", "description": "The partner type of integration account partner." } }, "description": "The integration account partner filter for odata query." }, "IntegrationAccountPartner": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountPartnerProperties", "description": "The integration account partner properties." } }, "description": "The integration account partner.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountPartnerProperties": { "type": "object", "required": [ "partnerType", "content" ], "properties": { "partnerType": { "$ref": "#/definitions/PartnerType", "description": "The partner type." }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "metadata": { "type": "object", "description": "The metadata.", "properties": {} }, "content": { "$ref": "#/definitions/PartnerContent", "description": "The partner content." } }, "description": "The integration account partner properties." }, "PartnerType": { "type": "string", "description": "The partner type.", "enum": [ "NotSpecified", "B2B" ], "x-ms-enum": { "name": "PartnerType", "modelAsString": true } }, "PartnerContent": { "type": "object", "properties": { "b2b": { "$ref": "#/definitions/B2BPartnerContent", "description": "The B2B partner content." } }, "description": "The integration account partner content." }, "B2BPartnerContent": { "type": "object", "properties": { "businessIdentities": { "type": "array", "items": { "$ref": "#/definitions/BusinessIdentity" }, "x-ms-identifiers": [ "qualifier" ], "description": "The list of partner business identities." } }, "description": "The B2B partner content." }, "BusinessIdentity": { "type": "object", "required": [ "qualifier", "value" ], "properties": { "qualifier": { "type": "string", "description": "The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32" }, "value": { "type": "string", "description": "The user defined business identity value." } }, "description": "The integration account partner's business identity." }, "IntegrationAccountAgreementListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountAgreement" }, "description": "The list of integration account agreements." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account agreements." }, "IntegrationAccountAgreementFilter": { "type": "object", "required": [ "agreementType" ], "properties": { "agreementType": { "$ref": "#/definitions/AgreementType", "description": "The agreement type of integration account agreement." } }, "description": "The integration account agreement filter for odata query." }, "IntegrationAccountAgreement": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountAgreementProperties", "description": "The integration account agreement properties." } }, "description": "The integration account agreement.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountAgreementProperties": { "type": "object", "required": [ "hostPartner", "guestPartner", "hostIdentity", "guestIdentity", "agreementType", "content" ], "properties": { "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "metadata": { "type": "object", "description": "The metadata.", "properties": {} }, "agreementType": { "$ref": "#/definitions/AgreementType", "description": "The agreement type." }, "hostPartner": { "type": "string", "description": "The integration account partner that is set as host partner for this agreement." }, "guestPartner": { "type": "string", "description": "The integration account partner that is set as guest partner for this agreement." }, "hostIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The business identity of the host partner." }, "guestIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The business identity of the guest partner." }, "content": { "$ref": "#/definitions/AgreementContent", "description": "The agreement content." } }, "description": "The integration account agreement properties." }, "AgreementType": { "type": "string", "description": "The agreement type.", "enum": [ "NotSpecified", "AS2", "X12", "Edifact" ], "x-ms-enum": { "name": "AgreementType", "modelAsString": false } }, "AgreementContent": { "type": "object", "properties": { "aS2": { "$ref": "#/definitions/AS2AgreementContent", "description": "The AS2 agreement content." }, "x12": { "$ref": "#/definitions/X12AgreementContent", "description": "The X12 agreement content." }, "edifact": { "$ref": "#/definitions/EdifactAgreementContent", "description": "The EDIFACT agreement content." } }, "description": "The integration account agreement content." }, "AS2AgreementContent": { "type": "object", "required": [ "receiveAgreement", "sendAgreement" ], "properties": { "receiveAgreement": { "$ref": "#/definitions/AS2OneWayAgreement", "description": "The AS2 one-way receive agreement." }, "sendAgreement": { "$ref": "#/definitions/AS2OneWayAgreement", "description": "The AS2 one-way send agreement." } }, "description": "The integration account AS2 agreement content." }, "AS2OneWayAgreement": { "type": "object", "required": [ "senderBusinessIdentity", "receiverBusinessIdentity", "protocolSettings" ], "properties": { "senderBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The sender business identity" }, "receiverBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The receiver business identity" }, "protocolSettings": { "$ref": "#/definitions/AS2ProtocolSettings", "description": "The AS2 protocol settings." } }, "description": "The integration account AS2 one-way agreement." }, "AS2ProtocolSettings": { "type": "object", "required": [ "messageConnectionSettings", "acknowledgementConnectionSettings", "mdnSettings", "securitySettings", "validationSettings", "envelopeSettings", "errorSettings" ], "properties": { "messageConnectionSettings": { "$ref": "#/definitions/AS2MessageConnectionSettings", "description": "The message connection settings." }, "acknowledgementConnectionSettings": { "$ref": "#/definitions/AS2AcknowledgementConnectionSettings", "description": "The acknowledgement connection settings." }, "mdnSettings": { "$ref": "#/definitions/AS2MdnSettings", "description": "The MDN settings." }, "securitySettings": { "$ref": "#/definitions/AS2SecuritySettings", "description": "The security settings." }, "validationSettings": { "$ref": "#/definitions/AS2ValidationSettings", "description": "The validation settings." }, "envelopeSettings": { "$ref": "#/definitions/AS2EnvelopeSettings", "description": "The envelope settings." }, "errorSettings": { "$ref": "#/definitions/AS2ErrorSettings", "description": "The error settings." } }, "description": "The AS2 agreement protocol settings." }, "AS2AcknowledgementConnectionSettings": { "type": "object", "required": [ "ignoreCertificateNameMismatch", "supportHttpStatusCodeContinue", "keepHttpConnectionAlive", "unfoldHttpHeaders" ], "properties": { "ignoreCertificateNameMismatch": { "type": "boolean", "description": "Indicates whether to ignore mismatch in certificate name." }, "supportHttpStatusCodeContinue": { "type": "boolean", "description": "Indicates whether to support HTTP status code 'CONTINUE'." }, "keepHttpConnectionAlive": { "type": "boolean", "description": "Indicates whether to keep the connection alive." }, "unfoldHttpHeaders": { "type": "boolean", "description": "Indicates whether to unfold the HTTP headers." } }, "description": "The AS2 agreement acknowledgement connection settings." }, "AS2MessageConnectionSettings": { "type": "object", "required": [ "ignoreCertificateNameMismatch", "supportHttpStatusCodeContinue", "keepHttpConnectionAlive", "unfoldHttpHeaders" ], "properties": { "ignoreCertificateNameMismatch": { "type": "boolean", "description": "The value indicating whether to ignore mismatch in certificate name." }, "supportHttpStatusCodeContinue": { "type": "boolean", "description": "The value indicating whether to support HTTP status code 'CONTINUE'." }, "keepHttpConnectionAlive": { "type": "boolean", "description": "The value indicating whether to keep the connection alive." }, "unfoldHttpHeaders": { "type": "boolean", "description": "The value indicating whether to unfold the HTTP headers." } }, "description": "The AS2 agreement message connection settings." }, "AS2MdnSettings": { "type": "object", "required": [ "needMDN", "signMDN", "sendMDNAsynchronously", "signOutboundMDNIfOptional", "sendInboundMDNToMessageBox", "micHashingAlgorithm" ], "properties": { "needMDN": { "type": "boolean", "description": "The value indicating whether to send or request a MDN." }, "signMDN": { "type": "boolean", "description": "The value indicating whether the MDN needs to be signed or not." }, "sendMDNAsynchronously": { "type": "boolean", "description": "The value indicating whether to send the asynchronous MDN." }, "receiptDeliveryUrl": { "type": "string", "description": "The receipt delivery URL." }, "dispositionNotificationTo": { "type": "string", "description": "The disposition notification to header value." }, "signOutboundMDNIfOptional": { "type": "boolean", "description": "The value indicating whether to sign the outbound MDN if optional." }, "mdnText": { "type": "string", "description": "The MDN text." }, "sendInboundMDNToMessageBox": { "type": "boolean", "description": "The value indicating whether to send inbound MDN to message box." }, "micHashingAlgorithm": { "$ref": "#/definitions/HashingAlgorithm", "description": "The signing or hashing algorithm." } }, "description": "The AS2 agreement mdn settings." }, "AS2SecuritySettings": { "type": "object", "required": [ "overrideGroupSigningCertificate", "enableNRRForInboundEncodedMessages", "enableNRRForInboundDecodedMessages", "enableNRRForOutboundMDN", "enableNRRForOutboundEncodedMessages", "enableNRRForOutboundDecodedMessages", "enableNRRForInboundMDN" ], "properties": { "overrideGroupSigningCertificate": { "type": "boolean", "description": "The value indicating whether to send or request a MDN." }, "signingCertificateName": { "type": "string", "description": "The name of the signing certificate." }, "encryptionCertificateName": { "type": "string", "description": "The name of the encryption certificate." }, "enableNRRForInboundEncodedMessages": { "type": "boolean", "description": "The value indicating whether to enable NRR for inbound encoded messages." }, "enableNRRForInboundDecodedMessages": { "type": "boolean", "description": "The value indicating whether to enable NRR for inbound decoded messages." }, "enableNRRForOutboundMDN": { "type": "boolean", "description": "The value indicating whether to enable NRR for outbound MDN." }, "enableNRRForOutboundEncodedMessages": { "type": "boolean", "description": "The value indicating whether to enable NRR for outbound encoded messages." }, "enableNRRForOutboundDecodedMessages": { "type": "boolean", "description": "The value indicating whether to enable NRR for outbound decoded messages." }, "enableNRRForInboundMDN": { "type": "boolean", "description": "The value indicating whether to enable NRR for inbound MDN." }, "sha2AlgorithmFormat": { "type": "string", "description": "The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize." } }, "description": "The AS2 agreement security settings." }, "AS2ValidationSettings": { "type": "object", "required": [ "overrideMessageProperties", "encryptMessage", "signMessage", "compressMessage", "checkDuplicateMessage", "interchangeDuplicatesValidityDays", "checkCertificateRevocationListOnSend", "checkCertificateRevocationListOnReceive", "encryptionAlgorithm" ], "properties": { "overrideMessageProperties": { "type": "boolean", "description": "The value indicating whether to override incoming message properties with those in agreement." }, "encryptMessage": { "type": "boolean", "description": "The value indicating whether the message has to be encrypted." }, "signMessage": { "type": "boolean", "description": "The value indicating whether the message has to be signed." }, "compressMessage": { "type": "boolean", "description": "The value indicating whether the message has to be compressed." }, "checkDuplicateMessage": { "type": "boolean", "description": "The value indicating whether to check for duplicate message." }, "interchangeDuplicatesValidityDays": { "type": "integer", "format": "int32", "description": "The number of days to look back for duplicate interchange." }, "checkCertificateRevocationListOnSend": { "type": "boolean", "description": "The value indicating whether to check for certificate revocation list on send." }, "checkCertificateRevocationListOnReceive": { "type": "boolean", "description": "The value indicating whether to check for certificate revocation list on receive." }, "encryptionAlgorithm": { "$ref": "#/definitions/EncryptionAlgorithm", "description": "The encryption algorithm." }, "signingAlgorithm": { "$ref": "#/definitions/SigningAlgorithm", "description": "The signing algorithm." } }, "description": "The AS2 agreement validation settings." }, "AS2EnvelopeSettings": { "type": "object", "required": [ "messageContentType", "transmitFileNameInMimeHeader", "fileNameTemplate", "suspendMessageOnFileNameGenerationError", "autogenerateFileName" ], "properties": { "messageContentType": { "type": "string", "description": "The message content type." }, "transmitFileNameInMimeHeader": { "type": "boolean", "description": "The value indicating whether to transmit file name in mime header." }, "fileNameTemplate": { "type": "string", "description": "The template for file name." }, "suspendMessageOnFileNameGenerationError": { "type": "boolean", "description": "The value indicating whether to suspend message on file name generation error." }, "autogenerateFileName": { "type": "boolean", "description": "The value indicating whether to auto generate file name." } }, "description": "The AS2 agreement envelope settings." }, "AS2ErrorSettings": { "type": "object", "required": [ "suspendDuplicateMessage", "resendIfMDNNotReceived" ], "properties": { "suspendDuplicateMessage": { "type": "boolean", "description": "The value indicating whether to suspend duplicate message." }, "resendIfMDNNotReceived": { "type": "boolean", "description": "The value indicating whether to resend message If MDN is not received." } }, "description": "The AS2 agreement error settings." }, "X12AgreementContent": { "type": "object", "required": [ "receiveAgreement", "sendAgreement" ], "properties": { "receiveAgreement": { "$ref": "#/definitions/X12OneWayAgreement", "description": "The X12 one-way receive agreement." }, "sendAgreement": { "$ref": "#/definitions/X12OneWayAgreement", "description": "The X12 one-way send agreement." } }, "description": "The X12 agreement content." }, "X12OneWayAgreement": { "type": "object", "required": [ "senderBusinessIdentity", "receiverBusinessIdentity", "protocolSettings" ], "properties": { "senderBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The sender business identity" }, "receiverBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The receiver business identity" }, "protocolSettings": { "$ref": "#/definitions/X12ProtocolSettings", "description": "The X12 protocol settings." } }, "description": "The X12 one-way agreement." }, "X12ProtocolSettings": { "type": "object", "required": [ "validationSettings", "framingSettings", "envelopeSettings", "acknowledgementSettings", "messageFilter", "securitySettings", "processingSettings", "schemaReferences" ], "properties": { "validationSettings": { "$ref": "#/definitions/X12ValidationSettings", "description": "The X12 validation settings." }, "framingSettings": { "$ref": "#/definitions/X12FramingSettings", "description": "The X12 framing settings." }, "envelopeSettings": { "$ref": "#/definitions/X12EnvelopeSettings", "description": "The X12 envelope settings." }, "acknowledgementSettings": { "$ref": "#/definitions/X12AcknowledgementSettings", "description": "The X12 acknowledgment settings." }, "messageFilter": { "$ref": "#/definitions/X12MessageFilter", "description": "The X12 message filter." }, "securitySettings": { "$ref": "#/definitions/X12SecuritySettings", "description": "The X12 security settings." }, "processingSettings": { "$ref": "#/definitions/X12ProcessingSettings", "description": "The X12 processing settings." }, "envelopeOverrides": { "type": "array", "items": { "$ref": "#/definitions/X12EnvelopeOverride" }, "x-ms-identifiers": [ "messageId" ], "description": "The X12 envelope override settings." }, "validationOverrides": { "type": "array", "items": { "$ref": "#/definitions/X12ValidationOverride" }, "x-ms-identifiers": [ "messageId" ], "description": "The X12 validation override settings." }, "messageFilterList": { "type": "array", "items": { "$ref": "#/definitions/X12MessageIdentifier" }, "x-ms-identifiers": [ "messageId" ], "description": "The X12 message filter list." }, "schemaReferences": { "type": "array", "items": { "$ref": "#/definitions/X12SchemaReference" }, "x-ms-identifiers": [ "messageId" ], "description": "The X12 schema references." }, "x12DelimiterOverrides": { "type": "array", "items": { "$ref": "#/definitions/X12DelimiterOverrides" }, "x-ms-identifiers": [], "description": "The X12 delimiter override settings." } }, "description": "The X12 agreement protocol settings." }, "X12ValidationSettings": { "type": "object", "required": [ "validateCharacterSet", "checkDuplicateInterchangeControlNumber", "interchangeControlNumberValidityDays", "checkDuplicateGroupControlNumber", "checkDuplicateTransactionSetControlNumber", "validateEDITypes", "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trimLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy" ], "properties": { "validateCharacterSet": { "type": "boolean", "description": "The value indicating whether to validate character set in the message." }, "checkDuplicateInterchangeControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate interchange control number." }, "interchangeControlNumberValidityDays": { "type": "integer", "format": "int32", "description": "The validity period of interchange control number." }, "checkDuplicateGroupControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate group control number." }, "checkDuplicateTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate transaction set control number." }, "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate EDI types." }, "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate XSD types." }, "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, "trimLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to trim leading and trailing spaces and zeroes." }, "trailingSeparatorPolicy": { "$ref": "#/definitions/TrailingSeparatorPolicy", "description": "The trailing separator policy." } }, "description": "The X12 agreement validation settings." }, "X12FramingSettings": { "type": "object", "required": [ "dataElementSeparator", "componentSeparator", "replaceSeparatorsInPayload", "replaceCharacter", "segmentTerminator", "characterSet", "segmentTerminatorSuffix" ], "properties": { "dataElementSeparator": { "type": "integer", "format": "int32", "description": "The data element separator." }, "componentSeparator": { "type": "integer", "format": "int32", "description": "The component separator." }, "replaceSeparatorsInPayload": { "type": "boolean", "description": "The value indicating whether to replace separators in payload." }, "replaceCharacter": { "type": "integer", "format": "int32", "description": "The replacement character." }, "segmentTerminator": { "type": "integer", "format": "int32", "description": "The segment terminator." }, "characterSet": { "$ref": "#/definitions/X12CharacterSet", "description": "The X12 character set." }, "segmentTerminatorSuffix": { "$ref": "#/definitions/SegmentTerminatorSuffix", "description": "The segment terminator suffix." } }, "description": "The X12 agreement framing settings." }, "X12EnvelopeSettings": { "type": "object", "required": [ "controlStandardsId", "useControlStandardsIdAsRepetitionCharacter", "senderApplicationId", "receiverApplicationId", "controlVersionNumber", "interchangeControlNumberLowerBound", "interchangeControlNumberUpperBound", "rolloverInterchangeControlNumber", "enableDefaultGroupHeaders", "groupControlNumberLowerBound", "groupControlNumberUpperBound", "rolloverGroupControlNumber", "groupHeaderAgencyCode", "groupHeaderVersion", "transactionSetControlNumberLowerBound", "transactionSetControlNumberUpperBound", "rolloverTransactionSetControlNumber", "overwriteExistingTransactionSetControlNumber", "groupHeaderDateFormat", "groupHeaderTimeFormat", "usageIndicator" ], "properties": { "controlStandardsId": { "type": "integer", "format": "int32", "description": "The controls standards id." }, "useControlStandardsIdAsRepetitionCharacter": { "type": "boolean", "description": "The value indicating whether to use control standards id as repetition character." }, "senderApplicationId": { "type": "string", "description": "The sender application id." }, "receiverApplicationId": { "type": "string", "description": "The receiver application id." }, "controlVersionNumber": { "type": "string", "description": "The control version number." }, "interchangeControlNumberLowerBound": { "type": "integer", "format": "int32", "description": "The interchange control number lower bound." }, "interchangeControlNumberUpperBound": { "type": "integer", "format": "int32", "description": "The interchange control number upper bound." }, "rolloverInterchangeControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover interchange control number." }, "enableDefaultGroupHeaders": { "type": "boolean", "description": "The value indicating whether to enable default group headers." }, "functionalGroupId": { "type": "string", "description": "The functional group id." }, "groupControlNumberLowerBound": { "type": "integer", "format": "int32", "description": "The group control number lower bound." }, "groupControlNumberUpperBound": { "type": "integer", "format": "int32", "description": "The group control number upper bound." }, "rolloverGroupControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover group control number." }, "groupHeaderAgencyCode": { "type": "string", "description": "The group header agency code." }, "groupHeaderVersion": { "type": "string", "description": "The group header version." }, "transactionSetControlNumberLowerBound": { "type": "integer", "format": "int32", "description": "The transaction set control number lower bound." }, "transactionSetControlNumberUpperBound": { "type": "integer", "format": "int32", "description": "The transaction set control number upper bound." }, "rolloverTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover transaction set control number." }, "transactionSetControlNumberPrefix": { "type": "string", "description": "The transaction set control number prefix." }, "transactionSetControlNumberSuffix": { "type": "string", "description": "The transaction set control number suffix." }, "overwriteExistingTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to overwrite existing transaction set control number." }, "groupHeaderDateFormat": { "$ref": "#/definitions/X12DateFormat", "description": "The group header date format." }, "groupHeaderTimeFormat": { "$ref": "#/definitions/X12TimeFormat", "description": "The group header time format." }, "usageIndicator": { "$ref": "#/definitions/UsageIndicator", "description": "The usage indicator." } }, "description": "The X12 agreement envelope settings." }, "X12AcknowledgementSettings": { "type": "object", "required": [ "needTechnicalAcknowledgement", "batchTechnicalAcknowledgements", "needFunctionalAcknowledgement", "batchFunctionalAcknowledgements", "needImplementationAcknowledgement", "batchImplementationAcknowledgements", "needLoopForValidMessages", "sendSynchronousAcknowledgement", "acknowledgementControlNumberLowerBound", "acknowledgementControlNumberUpperBound", "rolloverAcknowledgementControlNumber" ], "properties": { "needTechnicalAcknowledgement": { "type": "boolean", "description": "The value indicating whether technical acknowledgement is needed." }, "batchTechnicalAcknowledgements": { "type": "boolean", "description": "The value indicating whether to batch the technical acknowledgements." }, "needFunctionalAcknowledgement": { "type": "boolean", "description": "The value indicating whether functional acknowledgement is needed." }, "functionalAcknowledgementVersion": { "type": "string", "description": "The functional acknowledgement version." }, "batchFunctionalAcknowledgements": { "type": "boolean", "description": "The value indicating whether to batch functional acknowledgements." }, "needImplementationAcknowledgement": { "type": "boolean", "description": "The value indicating whether implementation acknowledgement is needed." }, "implementationAcknowledgementVersion": { "type": "string", "description": "The implementation acknowledgement version." }, "batchImplementationAcknowledgements": { "type": "boolean", "description": "The value indicating whether to batch implementation acknowledgements." }, "needLoopForValidMessages": { "type": "boolean", "description": "The value indicating whether a loop is needed for valid messages." }, "sendSynchronousAcknowledgement": { "type": "boolean", "description": "The value indicating whether to send synchronous acknowledgement." }, "acknowledgementControlNumberPrefix": { "type": "string", "description": "The acknowledgement control number prefix." }, "acknowledgementControlNumberSuffix": { "type": "string", "description": "The acknowledgement control number suffix." }, "acknowledgementControlNumberLowerBound": { "type": "integer", "format": "int32", "description": "The acknowledgement control number lower bound." }, "acknowledgementControlNumberUpperBound": { "type": "integer", "format": "int32", "description": "The acknowledgement control number upper bound." }, "rolloverAcknowledgementControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover acknowledgement control number." } }, "description": "The X12 agreement acknowledgement settings." }, "X12MessageFilter": { "type": "object", "required": [ "messageFilterType" ], "properties": { "messageFilterType": { "$ref": "#/definitions/MessageFilterType", "description": "The message filter type." } }, "description": "The X12 message filter for odata query." }, "X12SecuritySettings": { "type": "object", "required": [ "authorizationQualifier", "securityQualifier" ], "properties": { "authorizationQualifier": { "type": "string", "description": "The authorization qualifier." }, "authorizationValue": { "type": "string", "description": "The authorization value." }, "securityQualifier": { "type": "string", "description": "The security qualifier." }, "passwordValue": { "type": "string", "description": "The password value." } }, "description": "The X12 agreement security settings." }, "X12ProcessingSettings": { "type": "object", "required": [ "maskSecurityInfo", "convertImpliedDecimal", "preserveInterchange", "suspendInterchangeOnError", "createEmptyXmlTagsForTrailingSeparators", "useDotAsDecimalSeparator" ], "properties": { "maskSecurityInfo": { "type": "boolean", "description": "The value indicating whether to mask security information." }, "convertImpliedDecimal": { "type": "boolean", "description": "The value indicating whether to convert numerical type to implied decimal." }, "preserveInterchange": { "type": "boolean", "description": "The value indicating whether to preserve interchange." }, "suspendInterchangeOnError": { "type": "boolean", "description": "The value indicating whether to suspend interchange on error." }, "createEmptyXmlTagsForTrailingSeparators": { "type": "boolean", "description": "The value indicating whether to create empty xml tags for trailing separators." }, "useDotAsDecimalSeparator": { "type": "boolean", "description": "The value indicating whether to use dot as decimal separator." } }, "description": "The X12 processing settings." }, "X12EnvelopeOverride": { "type": "object", "required": [ "targetNamespace", "protocolVersion", "messageId", "responsibleAgencyCode", "headerVersion", "senderApplicationId", "receiverApplicationId", "dateFormat", "timeFormat" ], "properties": { "targetNamespace": { "type": "string", "description": "The target namespace on which this envelope settings has to be applied." }, "protocolVersion": { "type": "string", "description": "The protocol version on which this envelope settings has to be applied." }, "messageId": { "type": "string", "description": "The message id on which this envelope settings has to be applied." }, "responsibleAgencyCode": { "type": "string", "description": "The responsible agency code." }, "headerVersion": { "type": "string", "description": "The header version." }, "senderApplicationId": { "type": "string", "description": "The sender application id." }, "receiverApplicationId": { "type": "string", "description": "The receiver application id." }, "functionalIdentifierCode": { "type": "string", "description": "The functional identifier code." }, "dateFormat": { "$ref": "#/definitions/X12DateFormat", "description": "The date format." }, "timeFormat": { "$ref": "#/definitions/X12TimeFormat", "description": "The time format." } }, "description": "The X12 envelope override settings." }, "X12ValidationOverride": { "type": "object", "required": [ "messageId", "validateEDITypes", "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "validateCharacterSet", "trimLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy" ], "properties": { "messageId": { "type": "string", "description": "The message id on which the validation settings has to be applied." }, "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to validate EDI types." }, "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to validate XSD types." }, "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, "validateCharacterSet": { "type": "boolean", "description": "The value indicating whether to validate character Set." }, "trimLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to trim leading and trailing spaces and zeroes." }, "trailingSeparatorPolicy": { "$ref": "#/definitions/TrailingSeparatorPolicy", "description": "The trailing separator policy." } }, "description": "The X12 validation override settings." }, "X12MessageIdentifier": { "type": "object", "required": [ "messageId" ], "properties": { "messageId": { "type": "string", "description": "The message id." } }, "description": "The X12 message identifier." }, "X12SchemaReference": { "type": "object", "required": [ "messageId", "schemaVersion", "schemaName" ], "properties": { "messageId": { "type": "string", "description": "The message id." }, "senderApplicationId": { "type": "string", "description": "The sender application id." }, "schemaVersion": { "type": "string", "description": "The schema version." }, "schemaName": { "type": "string", "description": "The schema name." } }, "description": "The X12 schema reference." }, "X12DelimiterOverrides": { "type": "object", "required": [ "dataElementSeparator", "componentSeparator", "segmentTerminator", "segmentTerminatorSuffix", "replaceCharacter", "replaceSeparatorsInPayload" ], "properties": { "protocolVersion": { "type": "string", "description": "The protocol version." }, "messageId": { "type": "string", "description": "The message id." }, "dataElementSeparator": { "type": "integer", "format": "int32", "description": "The data element separator." }, "componentSeparator": { "type": "integer", "format": "int32", "description": "The component separator." }, "segmentTerminator": { "type": "integer", "format": "int32", "description": "The segment terminator." }, "segmentTerminatorSuffix": { "$ref": "#/definitions/SegmentTerminatorSuffix", "description": "The segment terminator suffix." }, "replaceCharacter": { "type": "integer", "format": "int32", "description": "The replacement character." }, "replaceSeparatorsInPayload": { "type": "boolean", "description": "The value indicating whether to replace separators in payload." }, "targetNamespace": { "type": "string", "description": "The target namespace on which this delimiter settings has to be applied." } }, "description": "The X12 delimiter override settings." }, "X12CharacterSet": { "type": "string", "description": "The X12 character set.", "enum": [ "NotSpecified", "Basic", "Extended", "UTF8" ], "x-ms-enum": { "name": "X12CharacterSet", "modelAsString": true } }, "SegmentTerminatorSuffix": { "type": "string", "description": "The segment terminator suffix.", "enum": [ "NotSpecified", "None", "CR", "LF", "CRLF" ], "x-ms-enum": { "name": "SegmentTerminatorSuffix", "modelAsString": false } }, "X12DateFormat": { "type": "string", "description": "The x12 date format.", "enum": [ "NotSpecified", "CCYYMMDD", "YYMMDD" ], "x-ms-enum": { "name": "X12DateFormat", "modelAsString": true } }, "X12TimeFormat": { "type": "string", "description": "The x12 time format.", "enum": [ "NotSpecified", "HHMM", "HHMMSS", "HHMMSSdd", "HHMMSSd" ], "x-ms-enum": { "name": "X12TimeFormat", "modelAsString": true } }, "UsageIndicator": { "type": "string", "description": "The usage indicator.", "enum": [ "NotSpecified", "Test", "Information", "Production" ], "x-ms-enum": { "name": "UsageIndicator", "modelAsString": true } }, "MessageFilterType": { "type": "string", "description": "The message filter type.", "enum": [ "NotSpecified", "Include", "Exclude" ], "x-ms-enum": { "name": "MessageFilterType", "modelAsString": true } }, "HashingAlgorithm": { "type": "string", "description": "The signing or hashing algorithm.", "enum": [ "NotSpecified", "None", "MD5", "SHA1", "SHA2256", "SHA2384", "SHA2512" ], "x-ms-enum": { "name": "HashingAlgorithm", "modelAsString": true } }, "EncryptionAlgorithm": { "type": "string", "description": "The encryption algorithm.", "enum": [ "NotSpecified", "None", "DES3", "RC2", "AES128", "AES192", "AES256" ], "x-ms-enum": { "name": "EncryptionAlgorithm", "modelAsString": true } }, "SigningAlgorithm": { "type": "string", "description": "The signing or hashing algorithm.", "enum": [ "NotSpecified", "Default", "SHA1", "SHA2256", "SHA2384", "SHA2512" ], "x-ms-enum": { "name": "SigningAlgorithm", "modelAsString": true } }, "TrailingSeparatorPolicy": { "type": "string", "description": "The trailing separator policy.", "enum": [ "NotSpecified", "NotAllowed", "Optional", "Mandatory" ], "x-ms-enum": { "name": "TrailingSeparatorPolicy", "modelAsString": true } }, "EdifactAgreementContent": { "type": "object", "required": [ "receiveAgreement", "sendAgreement" ], "properties": { "receiveAgreement": { "$ref": "#/definitions/EdifactOneWayAgreement", "description": "The EDIFACT one-way receive agreement." }, "sendAgreement": { "$ref": "#/definitions/EdifactOneWayAgreement", "description": "The EDIFACT one-way send agreement." } }, "description": "The Edifact agreement content." }, "EdifactOneWayAgreement": { "type": "object", "required": [ "senderBusinessIdentity", "receiverBusinessIdentity", "protocolSettings" ], "properties": { "senderBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The sender business identity" }, "receiverBusinessIdentity": { "$ref": "#/definitions/BusinessIdentity", "description": "The receiver business identity" }, "protocolSettings": { "$ref": "#/definitions/EdifactProtocolSettings", "description": "The EDIFACT protocol settings." } }, "description": "The Edifact one way agreement." }, "EdifactProtocolSettings": { "type": "object", "required": [ "validationSettings", "framingSettings", "envelopeSettings", "acknowledgementSettings", "messageFilter", "processingSettings", "schemaReferences" ], "properties": { "validationSettings": { "$ref": "#/definitions/EdifactValidationSettings", "description": "The EDIFACT validation settings." }, "framingSettings": { "$ref": "#/definitions/EdifactFramingSettings", "description": "The EDIFACT framing settings." }, "envelopeSettings": { "$ref": "#/definitions/EdifactEnvelopeSettings", "description": "The EDIFACT envelope settings." }, "acknowledgementSettings": { "$ref": "#/definitions/EdifactAcknowledgementSettings", "description": "The EDIFACT acknowledgement settings." }, "messageFilter": { "$ref": "#/definitions/EdifactMessageFilter", "description": "The EDIFACT message filter." }, "processingSettings": { "$ref": "#/definitions/EdifactProcessingSettings", "description": "The EDIFACT processing Settings." }, "envelopeOverrides": { "type": "array", "items": { "$ref": "#/definitions/EdifactEnvelopeOverride" }, "x-ms-identifiers": [ "messageId" ], "description": "The EDIFACT envelope override settings." }, "messageFilterList": { "type": "array", "items": { "$ref": "#/definitions/EdifactMessageIdentifier" }, "x-ms-identifiers": [ "messageId" ], "description": "The EDIFACT message filter list." }, "schemaReferences": { "type": "array", "items": { "$ref": "#/definitions/EdifactSchemaReference" }, "x-ms-identifiers": [ "messageId" ], "description": "The EDIFACT schema references." }, "validationOverrides": { "type": "array", "items": { "$ref": "#/definitions/EdifactValidationOverride" }, "x-ms-identifiers": [ "messageId" ], "description": "The EDIFACT validation override settings." }, "edifactDelimiterOverrides": { "type": "array", "items": { "$ref": "#/definitions/EdifactDelimiterOverride" }, "x-ms-identifiers": [ "messageId" ], "description": "The EDIFACT delimiter override settings." } }, "description": "The Edifact agreement protocol settings." }, "EdifactValidationSettings": { "type": "object", "required": [ "validateCharacterSet", "checkDuplicateInterchangeControlNumber", "interchangeControlNumberValidityDays", "checkDuplicateGroupControlNumber", "checkDuplicateTransactionSetControlNumber", "validateEDITypes", "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trimLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy" ], "properties": { "validateCharacterSet": { "type": "boolean", "description": "The value indicating whether to validate character set in the message." }, "checkDuplicateInterchangeControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate interchange control number." }, "interchangeControlNumberValidityDays": { "type": "integer", "format": "int32", "description": "The validity period of interchange control number." }, "checkDuplicateGroupControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate group control number." }, "checkDuplicateTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to check for duplicate transaction set control number." }, "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate EDI types." }, "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate XSD types." }, "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, "trimLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to trim leading and trailing spaces and zeroes." }, "trailingSeparatorPolicy": { "$ref": "#/definitions/TrailingSeparatorPolicy", "description": "The trailing separator policy." } }, "description": "The Edifact agreement validation settings." }, "EdifactFramingSettings": { "type": "object", "required": [ "protocolVersion", "dataElementSeparator", "componentSeparator", "segmentTerminator", "releaseIndicator", "repetitionSeparator", "characterSet", "decimalPointIndicator", "segmentTerminatorSuffix" ], "properties": { "serviceCodeListDirectoryVersion": { "type": "string", "description": "The service code list directory version." }, "characterEncoding": { "type": "string", "description": "The character encoding." }, "protocolVersion": { "type": "integer", "format": "int32", "description": "The protocol version." }, "dataElementSeparator": { "type": "integer", "format": "int32", "description": "The data element separator." }, "componentSeparator": { "type": "integer", "format": "int32", "description": "The component separator." }, "segmentTerminator": { "type": "integer", "format": "int32", "description": "The segment terminator." }, "releaseIndicator": { "type": "integer", "format": "int32", "description": "The release indicator." }, "repetitionSeparator": { "type": "integer", "format": "int32", "description": "The repetition separator." }, "characterSet": { "$ref": "#/definitions/EdifactCharacterSet", "description": "The EDIFACT frame setting characterSet." }, "decimalPointIndicator": { "$ref": "#/definitions/EdifactDecimalIndicator", "description": "The EDIFACT frame setting decimal indicator." }, "segmentTerminatorSuffix": { "$ref": "#/definitions/SegmentTerminatorSuffix", "description": "The EDIFACT frame setting segment terminator suffix." } }, "description": "The Edifact agreement framing settings." }, "EdifactEnvelopeSettings": { "type": "object", "required": [ "applyDelimiterStringAdvice", "createGroupingSegments", "enableDefaultGroupHeaders", "interchangeControlNumberLowerBound", "interchangeControlNumberUpperBound", "rolloverInterchangeControlNumber", "groupControlNumberLowerBound", "groupControlNumberUpperBound", "rolloverGroupControlNumber", "overwriteExistingTransactionSetControlNumber", "transactionSetControlNumberLowerBound", "transactionSetControlNumberUpperBound", "rolloverTransactionSetControlNumber", "isTestInterchange" ], "properties": { "groupAssociationAssignedCode": { "type": "string", "description": "The group association assigned code." }, "communicationAgreementId": { "type": "string", "description": "The communication agreement id." }, "applyDelimiterStringAdvice": { "type": "boolean", "description": "The value indicating whether to apply delimiter string advice." }, "createGroupingSegments": { "type": "boolean", "description": "The value indicating whether to create grouping segments." }, "enableDefaultGroupHeaders": { "type": "boolean", "description": "The value indicating whether to enable default group headers." }, "recipientReferencePasswordValue": { "type": "string", "description": "The recipient reference password value." }, "recipientReferencePasswordQualifier": { "type": "string", "description": "The recipient reference password qualifier." }, "applicationReferenceId": { "type": "string", "description": "The application reference id." }, "processingPriorityCode": { "type": "string", "description": "The processing priority code." }, "interchangeControlNumberLowerBound": { "type": "integer", "format": "int64", "description": "The interchange control number lower bound." }, "interchangeControlNumberUpperBound": { "type": "integer", "format": "int64", "description": "The interchange control number upper bound." }, "rolloverInterchangeControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover interchange control number." }, "interchangeControlNumberPrefix": { "type": "string", "description": "The interchange control number prefix." }, "interchangeControlNumberSuffix": { "type": "string", "description": "The interchange control number suffix." }, "senderReverseRoutingAddress": { "type": "string", "description": "The sender reverse routing address." }, "receiverReverseRoutingAddress": { "type": "string", "description": "The receiver reverse routing address." }, "functionalGroupId": { "type": "string", "description": "The functional group id." }, "groupControllingAgencyCode": { "type": "string", "description": "The group controlling agency code." }, "groupMessageVersion": { "type": "string", "description": "The group message version." }, "groupMessageRelease": { "type": "string", "description": "The group message release." }, "groupControlNumberLowerBound": { "type": "integer", "format": "int64", "description": "The group control number lower bound." }, "groupControlNumberUpperBound": { "type": "integer", "format": "int64", "description": "The group control number upper bound." }, "rolloverGroupControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover group control number." }, "groupControlNumberPrefix": { "type": "string", "description": "The group control number prefix." }, "groupControlNumberSuffix": { "type": "string", "description": "The group control number suffix." }, "groupApplicationReceiverQualifier": { "type": "string", "description": "The group application receiver qualifier." }, "groupApplicationReceiverId": { "type": "string", "description": "The group application receiver id." }, "groupApplicationSenderQualifier": { "type": "string", "description": "The group application sender qualifier." }, "groupApplicationSenderId": { "type": "string", "description": "The group application sender id." }, "groupApplicationPassword": { "type": "string", "description": "The group application password." }, "overwriteExistingTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to overwrite existing transaction set control number." }, "transactionSetControlNumberPrefix": { "type": "string", "description": "The transaction set control number prefix." }, "transactionSetControlNumberSuffix": { "type": "string", "description": "The transaction set control number suffix." }, "transactionSetControlNumberLowerBound": { "type": "integer", "format": "int64", "description": "The transaction set control number lower bound." }, "transactionSetControlNumberUpperBound": { "type": "integer", "format": "int64", "description": "The transaction set control number upper bound." }, "rolloverTransactionSetControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover transaction set control number." }, "isTestInterchange": { "type": "boolean", "description": "The value indicating whether the message is a test interchange." }, "senderInternalIdentification": { "type": "string", "description": "The sender internal identification." }, "senderInternalSubIdentification": { "type": "string", "description": "The sender internal sub identification." }, "receiverInternalIdentification": { "type": "string", "description": "The receiver internal identification." }, "receiverInternalSubIdentification": { "type": "string", "description": "The receiver internal sub identification." } }, "description": "The Edifact agreement envelope settings." }, "EdifactAcknowledgementSettings": { "type": "object", "required": [ "needTechnicalAcknowledgement", "batchTechnicalAcknowledgements", "needFunctionalAcknowledgement", "batchFunctionalAcknowledgements", "needLoopForValidMessages", "sendSynchronousAcknowledgement", "acknowledgementControlNumberLowerBound", "acknowledgementControlNumberUpperBound", "rolloverAcknowledgementControlNumber" ], "properties": { "needTechnicalAcknowledgement": { "type": "boolean", "description": "The value indicating whether technical acknowledgement is needed." }, "batchTechnicalAcknowledgements": { "type": "boolean", "description": "The value indicating whether to batch the technical acknowledgements." }, "needFunctionalAcknowledgement": { "type": "boolean", "description": "The value indicating whether functional acknowledgement is needed." }, "batchFunctionalAcknowledgements": { "type": "boolean", "description": "The value indicating whether to batch functional acknowledgements." }, "needLoopForValidMessages": { "type": "boolean", "description": "The value indicating whether a loop is needed for valid messages." }, "sendSynchronousAcknowledgement": { "type": "boolean", "description": "The value indicating whether to send synchronous acknowledgement." }, "acknowledgementControlNumberPrefix": { "type": "string", "description": "The acknowledgement control number prefix." }, "acknowledgementControlNumberSuffix": { "type": "string", "description": "The acknowledgement control number suffix." }, "acknowledgementControlNumberLowerBound": { "type": "integer", "format": "int32", "description": "The acknowledgement control number lower bound." }, "acknowledgementControlNumberUpperBound": { "type": "integer", "format": "int32", "description": "The acknowledgement control number upper bound." }, "rolloverAcknowledgementControlNumber": { "type": "boolean", "description": "The value indicating whether to rollover acknowledgement control number." } }, "description": "The Edifact agreement acknowledgement settings." }, "EdifactMessageFilter": { "type": "object", "required": [ "messageFilterType" ], "properties": { "messageFilterType": { "$ref": "#/definitions/MessageFilterType", "description": "The message filter type." } }, "description": "The Edifact message filter for odata query." }, "EdifactProcessingSettings": { "type": "object", "required": [ "maskSecurityInfo", "preserveInterchange", "suspendInterchangeOnError", "createEmptyXmlTagsForTrailingSeparators", "useDotAsDecimalSeparator" ], "properties": { "maskSecurityInfo": { "type": "boolean", "description": "The value indicating whether to mask security information." }, "preserveInterchange": { "type": "boolean", "description": "The value indicating whether to preserve interchange." }, "suspendInterchangeOnError": { "type": "boolean", "description": "The value indicating whether to suspend interchange on error." }, "createEmptyXmlTagsForTrailingSeparators": { "type": "boolean", "description": "The value indicating whether to create empty xml tags for trailing separators." }, "useDotAsDecimalSeparator": { "type": "boolean", "description": "The value indicating whether to use dot as decimal separator." } }, "description": "The Edifact agreement protocol settings." }, "EdifactEnvelopeOverride": { "type": "object", "properties": { "messageId": { "type": "string", "description": "The message id on which this envelope settings has to be applied." }, "messageVersion": { "type": "string", "description": "The message version on which this envelope settings has to be applied." }, "messageRelease": { "type": "string", "description": "The message release version on which this envelope settings has to be applied." }, "messageAssociationAssignedCode": { "type": "string", "description": "The message association assigned code." }, "targetNamespace": { "type": "string", "description": "The target namespace on which this envelope settings has to be applied." }, "functionalGroupId": { "type": "string", "description": "The functional group id." }, "senderApplicationQualifier": { "type": "string", "description": "The sender application qualifier." }, "senderApplicationId": { "type": "string", "description": "The sender application id." }, "receiverApplicationQualifier": { "type": "string", "description": "The receiver application qualifier." }, "receiverApplicationId": { "type": "string", "description": "The receiver application id." }, "controllingAgencyCode": { "type": "string", "description": "The controlling agency code." }, "groupHeaderMessageVersion": { "type": "string", "description": "The group header message version." }, "groupHeaderMessageRelease": { "type": "string", "description": "The group header message release." }, "associationAssignedCode": { "type": "string", "description": "The association assigned code." }, "applicationPassword": { "type": "string", "description": "The application password." } }, "description": "The Edifact envelope override settings." }, "EdifactMessageIdentifier": { "type": "object", "required": [ "messageId" ], "properties": { "messageId": { "type": "string", "description": "The message id on which this envelope settings has to be applied." } }, "description": "The Edifact message identifier." }, "EdifactSchemaReference": { "type": "object", "required": [ "messageId", "messageVersion", "messageRelease", "schemaName" ], "properties": { "messageId": { "type": "string", "description": "The message id." }, "messageVersion": { "type": "string", "description": "The message version." }, "messageRelease": { "type": "string", "description": "The message release version." }, "senderApplicationId": { "type": "string", "description": "The sender application id." }, "senderApplicationQualifier": { "type": "string", "description": "The sender application qualifier." }, "associationAssignedCode": { "type": "string", "description": "The association assigned code." }, "schemaName": { "type": "string", "description": "The schema name." } }, "description": "The Edifact schema reference." }, "EdifactValidationOverride": { "type": "object", "required": [ "messageId", "enforceCharacterSet", "validateEDITypes", "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy", "trimLeadingAndTrailingSpacesAndZeroes" ], "properties": { "messageId": { "type": "string", "description": "The message id on which the validation settings has to be applied." }, "enforceCharacterSet": { "type": "boolean", "description": "The value indicating whether to validate character Set." }, "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to validate EDI types." }, "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to validate XSD types." }, "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, "trailingSeparatorPolicy": { "$ref": "#/definitions/TrailingSeparatorPolicy", "description": "The trailing separator policy." }, "trimLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to trim leading and trailing spaces and zeroes." } }, "description": "The Edifact validation override settings." }, "EdifactDelimiterOverride": { "type": "object", "required": [ "dataElementSeparator", "componentSeparator", "segmentTerminator", "repetitionSeparator", "segmentTerminatorSuffix", "decimalPointIndicator", "releaseIndicator" ], "properties": { "messageId": { "type": "string", "description": "The message id." }, "messageVersion": { "type": "string", "description": "The message version." }, "messageRelease": { "type": "string", "description": "The message release." }, "dataElementSeparator": { "type": "integer", "format": "int32", "description": "The data element separator." }, "componentSeparator": { "type": "integer", "format": "int32", "description": "The component separator." }, "segmentTerminator": { "type": "integer", "format": "int32", "description": "The segment terminator." }, "repetitionSeparator": { "type": "integer", "format": "int32", "description": "The repetition separator." }, "segmentTerminatorSuffix": { "$ref": "#/definitions/SegmentTerminatorSuffix", "description": "The segment terminator suffix." }, "decimalPointIndicator": { "$ref": "#/definitions/EdifactDecimalIndicator", "description": "The decimal point indicator." }, "releaseIndicator": { "type": "integer", "format": "int32", "description": "The release indicator." }, "messageAssociationAssignedCode": { "type": "string", "description": "The message association assigned code." }, "targetNamespace": { "type": "string", "description": "The target namespace on which this delimiter settings has to be applied." } }, "description": "The Edifact delimiter override settings." }, "EdifactCharacterSet": { "type": "string", "description": "The edifact character set.", "enum": [ "NotSpecified", "UNOB", "UNOA", "UNOC", "UNOD", "UNOE", "UNOF", "UNOG", "UNOH", "UNOI", "UNOJ", "UNOK", "UNOX", "UNOY", "KECA" ], "x-ms-enum": { "name": "EdifactCharacterSet", "modelAsString": true } }, "EdifactDecimalIndicator": { "type": "string", "description": "The edifact decimal indicator.", "enum": [ "NotSpecified", "Comma", "Decimal" ], "x-ms-enum": { "name": "EdifactDecimalIndicator", "modelAsString": false } }, "IntegrationAccountCertificateListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountCertificate" }, "description": "The list of integration account certificates." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account certificates." }, "IntegrationAccountCertificate": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountCertificateProperties", "description": "The integration account certificate properties." } }, "description": "The integration account certificate.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "IntegrationAccountCertificateProperties": { "type": "object", "properties": { "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "metadata": { "type": "object", "description": "The metadata.", "properties": {} }, "key": { "$ref": "#/definitions/KeyVaultKeyReference", "description": "The key details in the key vault." }, "publicCertificate": { "type": "string", "description": "The public certificate." } }, "description": "The integration account certificate properties." }, "KeyVaultKeyReference": { "type": "object", "required": [ "keyVault", "keyName" ], "properties": { "keyVault": { "type": "object", "description": "The key vault reference.", "properties": { "id": { "type": "string", "description": "The resource id." }, "name": { "type": "string", "readOnly": true, "description": "The resource name." }, "type": { "type": "string", "readOnly": true, "description": "The resource type." } } }, "keyName": { "type": "string", "description": "The private key name in key vault." }, "keyVersion": { "type": "string", "description": "The private key version in key vault." } }, "description": "The reference to the key vault key." }, "IntegrationAccountSessionFilter": { "type": "object", "required": [ "changedTime" ], "properties": { "changedTime": { "type": "string", "format": "date-time", "description": "The changed time of integration account sessions." } }, "description": "The integration account session filter." }, "IntegrationAccountSessionListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/IntegrationAccountSession" }, "description": "The list of integration account sessions." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of integration account sessions." }, "IntegrationAccountSession": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IntegrationAccountSessionProperties", "description": "The integration account session properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ], "description": "The integration account session." }, "IntegrationAccountSessionProperties": { "type": "object", "properties": { "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The changed time." }, "content": { "$ref": "#/definitions/Object", "description": "The session content." } }, "description": "The integration account session properties." }, "Operation": { "description": "Logic REST API operation", "type": "object", "properties": { "origin": { "description": "Operation: origin", "type": "string" }, "name": { "description": "Operation name: {provider}/{resource}/{operation}", "type": "string" }, "display": { "type": "object", "description": "The object that represents the operation.", "properties": { "provider": { "description": "Service provider: Microsoft.Logic", "type": "string" }, "resource": { "description": "Resource on which the operation is performed: Profile, endpoint, etc.", "type": "string" }, "operation": { "description": "Operation type: Read, write, delete, etc.", "type": "string" }, "description": { "description": "Operation: description.", "type": "string" } } }, "properties": { "x-ms-client-flatten": true, "description": "The properties.", "$ref": "#/definitions/Object" } } }, "OperationListResult": { "description": "Result of the request to list Logic operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Operation" }, "x-ms-identifiers": [ "name" ], "description": "List of Logic operations supported by the Logic resource provider." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "ErrorResponse": { "description": "Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.", "type": "object", "properties": { "error": { "$ref": "#/definitions/ErrorProperties", "description": "The error properties." } } }, "ErrorProperties": { "description": "Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { "description": "Error code.", "type": "string" }, "message": { "description": "Error message indicating why the operation failed.", "type": "string" } } }, "ListKeyVaultKeysDefinition": { "type": "object", "description": "The list key vault keys definition.", "additionalProperties": false, "required": [ "keyVault" ], "properties": { "keyVault": { "$ref": "#/definitions/KeyVaultReference", "description": "The key vault reference." }, "skipToken": { "type": "string", "description": "The skip token." } } }, "KeyVaultReference": { "type": "object", "description": "The key vault reference.", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The key vault name." } }, "allOf": [ { "$ref": "#/definitions/ResourceReference" } ] }, "KeyVaultKeyCollection": { "type": "object", "description": "Collection of key vault keys.", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/KeyVaultKey" }, "x-ms-identifiers": [ "kid" ], "description": "The key vault keys." }, "skipToken": { "type": "string", "description": "The skip token." } } }, "KeyVaultKey": { "type": "object", "description": "The key vault key.", "properties": { "kid": { "type": "string", "description": "The key id." }, "attributes": { "type": "object", "description": "The key attributes.", "properties": { "enabled": { "type": "boolean", "description": "Whether the key is enabled or not." }, "created": { "type": "integer", "format": "int64", "description": "When the key was created." }, "updated": { "type": "integer", "format": "int64", "description": "When the key was updated." } } } } }, "TrackingEventsDefinition": { "type": "object", "description": "The tracking events definition.", "additionalProperties": false, "required": [ "sourceType", "events" ], "properties": { "sourceType": { "description": "The source type.", "type": "string" }, "trackEventsOptions": { "description": "The track events options.", "$ref": "#/definitions/TrackEventsOperationOptions" }, "events": { "type": "array", "description": "The events.", "items": { "$ref": "#/definitions/TrackingEvent" }, "x-ms-identifiers": [] } } }, "TrackEventsOperationOptions": { "type": "string", "enum": [ "None", "DisableSourceInfoEnrich" ], "x-ms-enum": { "name": "TrackEventsOperationOptions", "modelAsString": true }, "description": "The track events operation options." }, "TrackingEvent": { "type": "object", "description": "The tracking event.", "additionalProperties": false, "required": [ "eventLevel", "eventTime", "recordType" ], "properties": { "eventLevel": { "description": "The event level.", "$ref": "#/definitions/EventLevel" }, "eventTime": { "type": "string", "description": "The event time.", "format": "date-time" }, "recordType": { "description": "The record type.", "$ref": "#/definitions/TrackingRecordType" }, "record": { "description": "The record.", "$ref": "#/definitions/Object" }, "error": { "description": "The error.", "$ref": "#/definitions/TrackingEventErrorInfo" } } }, "EventLevel": { "type": "string", "enum": [ "LogAlways", "Critical", "Error", "Warning", "Informational", "Verbose" ], "x-ms-enum": { "name": "EventLevel", "modelAsString": false }, "description": "The event level." }, "TrackingRecordType": { "type": "string", "enum": [ "NotSpecified", "Custom", "AS2Message", "AS2MDN", "X12Interchange", "X12FunctionalGroup", "X12TransactionSet", "X12InterchangeAcknowledgment", "X12FunctionalGroupAcknowledgment", "X12TransactionSetAcknowledgment", "EdifactInterchange", "EdifactFunctionalGroup", "EdifactTransactionSet", "EdifactInterchangeAcknowledgment", "EdifactFunctionalGroupAcknowledgment", "EdifactTransactionSetAcknowledgment" ], "x-ms-enum": { "name": "TrackingRecordType", "modelAsString": true }, "description": "The tracking record type." }, "TrackingEventErrorInfo": { "type": "object", "description": "The tracking event error info.", "additionalProperties": false, "properties": { "message": { "description": "The message.", "type": "string" }, "code": { "description": "The code.", "type": "string" } } }, "SetTriggerStateActionDefinition": { "type": "object", "description": "The set trigger state action definition.", "additionalProperties": false, "required": [ "source" ], "properties": { "source": { "description": "The source.", "$ref": "#/definitions/WorkflowTriggerReference" } } }, "ExpressionTraces": { "description": "The expression traces.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/ExpressionRoot" }, "x-ms-identifiers": [ "path" ] } } }, "ExpressionRoot": { "description": "The expression root.", "type": "object", "properties": { "path": { "type": "string", "description": "The path." } }, "allOf": [ { "$ref": "#/definitions/Expression" } ] }, "Expression": { "description": "The expression.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "The text.", "type": "string" }, "value": {}, "subexpressions": { "type": "array", "description": "The sub expressions.", "items": { "$ref": "#/definitions/Expression" }, "x-ms-identifiers": [] }, "error": { "$ref": "#/definitions/AzureResourceErrorInfo" } } }, "AzureResourceErrorInfo": { "type": "object", "description": "The azure resource error info.", "additionalProperties": false, "required": [ "message" ], "properties": { "message": { "type": "string", "description": "The error message." }, "details": { "type": "array", "items": { "$ref": "#/definitions/AzureResourceErrorInfo" }, "x-ms-identifiers": [ "code" ], "description": "The error details." } }, "allOf": [ { "$ref": "#/definitions/ErrorInfo" } ] }, "ErrorInfo": { "type": "object", "description": "The error info.", "additionalProperties": false, "required": [ "code" ], "properties": { "code": { "type": "string", "description": "The error code." } } }, "WorkflowRunActionRepetitionDefinitionCollection": { "type": "object", "description": "A collection of workflow run action repetitions.", "properties": { "nextLink": { "description": "The link used to get the next page of recommendations.", "type": "string" }, "value": { "type": "array", "items": { "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" } } } }, "WorkflowRunActionRepetitionDefinition": { "type": "object", "description": "The workflow run action repetition definition.", "additionalProperties": false, "required": [ "properties" ], "properties": { "properties": { "$ref": "#/definitions/WorkflowRunActionRepetitionProperties", "description": "The workflow run action repetition properties definition.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "WorkflowRunActionRepetitionProperties": { "type": "object", "description": "The workflow run action repetition properties definition.", "additionalProperties": false, "properties": { "repetitionIndexes": { "type": "array", "description": "The repetition indexes.", "items": { "$ref": "#/definitions/RepetitionIndex" }, "x-ms-identifiers": [ "itemIndex" ] } }, "allOf": [ { "$ref": "#/definitions/OperationResult" } ] }, "RepetitionIndex": { "type": "object", "description": "The workflow run action repetition index.", "additionalProperties": false, "required": [ "itemIndex" ], "properties": { "scopeName": { "type": "string", "description": "The scope." }, "itemIndex": { "type": "integer", "format": "int32", "description": "The index." } } }, "OperationResult": { "type": "object", "description": "The operation result definition.", "additionalProperties": false, "properties": { "trackingId": { "type": "string", "readOnly": true, "description": "Gets the tracking id." }, "inputs": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the inputs." }, "inputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to inputs." }, "outputs": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the outputs." }, "outputsLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, "description": "Gets the link to outputs." }, "trackedProperties": { "$ref": "#/definitions/Object", "readOnly": true, "description": "Gets the tracked properties." }, "retryHistory": { "type": "array", "items": { "$ref": "#/definitions/RetryHistory" }, "x-ms-identifiers": [], "description": "Gets the retry histories." }, "iterationCount": { "type": "integer", "format": "int32" } }, "allOf": [ { "$ref": "#/definitions/OperationResultProperties" } ] }, "OperationResultProperties": { "type": "object", "x-abstract": true, "description": "The run operation result properties.", "additionalProperties": false, "properties": { "startTime": { "type": "string", "format": "date-time", "description": "The start time of the workflow scope repetition." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the workflow scope repetition." }, "correlation": { "$ref": "#/definitions/RunActionCorrelation", "description": "The correlation properties." }, "status": { "$ref": "#/definitions/WorkflowStatus", "description": "The status of the workflow scope repetition." }, "code": { "type": "string", "description": "The workflow scope repetition code." }, "error": {} } }, "RunActionCorrelation": { "type": "object", "description": "The workflow run action correlation properties.", "additionalProperties": false, "properties": { "actionTrackingId": { "type": "string", "description": "The action tracking identifier." } }, "allOf": [ { "$ref": "#/definitions/RunCorrelation" } ] }, "RunCorrelation": { "type": "object", "description": "The correlation properties.", "additionalProperties": false, "properties": { "clientTrackingId": { "type": "string", "description": "The client tracking identifier." }, "clientKeywords": { "type": "array", "description": "The client keywords.", "items": { "type": "string" } } } }, "JsonSchema": { "type": "object", "description": "The JSON schema.", "properties": { "title": { "type": "string", "description": "The JSON title." }, "content": { "type": "string", "description": "The JSON content." } } }, "AssemblyCollection": { "type": "object", "description": "A collection of assembly definitions.", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AssemblyDefinition" } } } }, "AssemblyDefinition": { "type": "object", "description": "The assembly definition.", "additionalProperties": false, "required": [ "properties" ], "properties": { "properties": { "$ref": "#/definitions/AssemblyProperties", "description": "The assembly properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "AssemblyProperties": { "type": "object", "description": "The assembly properties definition.", "additionalProperties": false, "required": [ "assemblyName" ], "properties": { "assemblyName": { "type": "string", "description": "The assembly name." }, "assemblyVersion": { "type": "string", "description": "The assembly version." }, "assemblyCulture": { "type": "string", "description": "The assembly culture." }, "assemblyPublicKeyToken": { "type": "string", "description": "The assembly public key token." } }, "allOf": [ { "$ref": "#/definitions/ArtifactContentPropertiesDefinition" } ] }, "ArtifactContentPropertiesDefinition": { "type": "object", "additionalProperties": false, "description": "The artifact content properties definition.", "properties": { "content": {}, "contentType": { "type": "string", "description": "The content type." }, "contentLink": { "$ref": "#/definitions/ContentLink", "description": "The content link." } }, "allOf": [ { "$ref": "#/definitions/ArtifactProperties" } ] }, "ArtifactProperties": { "type": "object", "additionalProperties": false, "description": "The artifact properties definition.", "properties": { "createdTime": { "type": "string", "format": "date-time", "description": "The artifact creation time." }, "changedTime": { "type": "string", "format": "date-time", "description": "The artifact changed time." }, "metadata": {} } }, "BatchConfigurationCollection": { "type": "object", "description": "A collection of batch configurations.", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/BatchConfiguration" } } } }, "BatchConfiguration": { "type": "object", "description": "The batch configuration resource definition.", "additionalProperties": false, "required": [ "properties" ], "properties": { "properties": { "$ref": "#/definitions/BatchConfigurationProperties", "description": "The batch configuration properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "BatchConfigurationProperties": { "type": "object", "description": "The batch configuration properties definition.", "additionalProperties": false, "required": [ "batchGroupName", "releaseCriteria" ], "properties": { "batchGroupName": { "type": "string", "description": "The name of the batch group." }, "releaseCriteria": { "$ref": "#/definitions/BatchReleaseCriteria", "description": "The batch release criteria." }, "createdTime": { "type": "string", "format": "date-time", "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", "description": "The changed time." } }, "allOf": [ { "$ref": "#/definitions/ArtifactProperties" } ] }, "BatchReleaseCriteria": { "type": "object", "additionalProperties": false, "description": "The batch release criteria.", "properties": { "messageCount": { "type": "integer", "format": "int32", "description": "The message count." }, "batchSize": { "type": "integer", "format": "int32", "description": "The batch size in bytes." }, "recurrence": { "$ref": "#/definitions/WorkflowTriggerRecurrence", "description": "The recurrence." } } }, "RequestHistoryListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RequestHistory" }, "description": "A list of workflow request histories." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "The list of workflow request histories." }, "RequestHistory": { "type": "object", "additionalProperties": false, "description": "The request history.", "properties": { "properties": { "$ref": "#/definitions/RequestHistoryProperties", "description": "The request history properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } ] }, "RequestHistoryProperties": { "type": "object", "additionalProperties": false, "description": "The request history.", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "The time the request started." }, "endTime": { "type": "string", "format": "date-time", "description": "The time the request ended." }, "request": { "$ref": "#/definitions/Request", "description": "The request." }, "response": { "$ref": "#/definitions/Response", "description": "The response." } } }, "Request": { "type": "object", "additionalProperties": false, "description": "A request.", "properties": { "headers": { "$ref": "#/definitions/Object", "description": "A list of all the headers attached to the request." }, "uri": { "type": "string", "description": "The destination for the request." }, "method": { "type": "string", "description": "The HTTP method used for the request." } } }, "Response": { "type": "object", "additionalProperties": false, "description": "A response.", "properties": { "headers": { "$ref": "#/definitions/Object", "description": "A list of all the headers attached to the response." }, "statusCode": { "type": "integer", "format": "int32", "description": "The status code of the response." }, "bodyLink": { "$ref": "#/definitions/ContentLink", "description": "Details on the location of the body content." } } } }, "parameters": { "subscriptionId": { "name": "subscriptionId", "description": "The subscription id.", "in": "path", "required": true, "type": "string" }, "api-version": { "name": "api-version", "description": "The API version.", "in": "query", "required": true, "type": "string" } } }