Microsoft.AzureDataTransfer (stable:2025-05-21)

2025/08/12 • 33 updated methods

AzureDataTransfer_listApprovedSchemas (updated)
Description :  Retrieves the list of approved schemas available for Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AzureDataTransfer_listApprovedSchemas",
  "Description": {
    "new": "Retrieves the list of approved schemas available for Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.",
    "old": "Lists approved schemas for Azure Data Transfer."
  },
  "$parameters": [
    {
      "#name": "pipeline",
      "Description": {
        "new": "The request payload for listing approved schemas.",
        "old": "The request to list approved schemas."
      },
      "$schema": {
        "Description": {
          "new": "The request used to list approved schemas within the resource provider. ListApprovedSchemaRequest has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
          "old": "The request used to list approved schemas within the resource provider. ListApprovedSchemaRequest will be deprecated after from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The schemas list result. SchemaListResults has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
        "old": "The schemas list result. SchemaListResults will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
      },
      "$properties": {
        "value": {
          "Description": {
            "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
            "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.AzureDataTransfer/listApprovedSchemas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
pipeline:
{
Description: The request payload for listing approved schemas. ,
Required: True ,
}
{
pipeline:
{
Description: The name of the pipeline to filter approved schemas. ,
Required: False ,
}
string ,
direction:
{
Description: The direction pipeline to filter approved schemas. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Schemas array. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AzureDataTransfer_validateSchema (updated)
Description :  Validates the structure and content of a schema for use in Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AzureDataTransfer_validateSchema",
  "Description": {
    "new": "Validates the structure and content of a schema for use in Azure Data Transfer. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.",
    "old": "Validates a schema for Azure Data Transfer."
  },
  "$parameters": {
    "schema": {
      "Description": {
        "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
        "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
      }
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Result of the schema validation. ValidateSchemaResult has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
        "old": "Result of the schema validation. ValidateSchemaResult will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.AzureDataTransfer/validateSchema
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
schema:
{
Description: The request body ,
Required: True ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Validation status of the schema ,
Enum:
{
Succeeded: Validation of the schema was successful. ,
Failed: The schema failed validation, whether due to error or an invalid schema. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message describing the schema validation ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connections_ListBySubscription (updated)
Description :  Gets connections in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connections_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "flowTypes",
                "Description": {
                  "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
                  "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
                }
              },
              {
                "#name": "policies",
                "Description": {
                  "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The policies for this connection"
                }
              },
              {
                "#name": "schemas",
                "Description": {
                  "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The schemas for this connection"
                },
                "$items": {
                  "Description": {
                    "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                    "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
                  }
                }
              },
              {
                "#name": "schemaUris",
                "Description": {
                  "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The schema URIs for this connection"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Connection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_ListBySubscription (updated)
Description :  Lists all Pipeline resources within the current subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_ListBySubscription",
  "Description": {
    "new": "Lists all Pipeline resources within the current subscription.",
    "old": "Gets pipelines in a subscription."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
            "old": "The pipeline resource definition."
          },
          "$properties": [
            {
              "#name": "properties",
              "Description": {
                "new": "The set of configurable properties for the Pipeline resource.",
                "old": "Properties of pipeline"
              },
              "$properties": [
                {
                  "#name": "policies",
                  "Description": {
                    "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                    "old": "The policies for this pipeline"
                  }
                },
                {
                  "#name": "flowTypes",
                  "Description": {
                    "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                    "old": "The flow type for this flow"
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pipeline items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connections_ListByResourceGroup (updated)
Description :  Gets connections in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connections_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "flowTypes",
                "Description": {
                  "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
                  "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
                }
              },
              {
                "#name": "policies",
                "Description": {
                  "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The policies for this connection"
                }
              },
              {
                "#name": "schemas",
                "Description": {
                  "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The schemas for this connection"
                },
                "$items": {
                  "Description": {
                    "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                    "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
                  }
                }
              },
              {
                "#name": "schemaUris",
                "Description": {
                  "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The schema URIs for this connection"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Connection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connections_Get (updated)
Description :  Gets connection resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connections_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connections_CreateOrUpdate (updated)
Description :  Creates or updates the connection resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connections_CreateOrUpdate",
  "$parameters": {
    "connection": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
connection:
{
Description: Connection body ,
Required: True ,
}
{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The connection resource definition. ,
}
{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Connections_Update (updated)
Description :  Updates the connection resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Connections_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
connection:
{
Description: Connection body ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The connection resource definition. ,
}
{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_ListByConnection (updated)
Description :  Gets flows in a connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_ListByConnection",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "flowType",
                "Description": {
                  "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The flow type for this flow"
                }
              },
              {
                "#name": "dataType",
                "Description": {
                  "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "Type of data to transfer via the flow."
                }
              },
              {
                "#name": "policies",
                "Description": {
                  "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The policies for this flow"
                }
              },
              {
                "#name": "schema",
                "Description": {
                  "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The selected schema for this flow"
                }
              },
              {
                "apiFlowOptions": [
                  {
                    "#name": "remoteEndpoint",
                    "Description": {
                      "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                      "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                    }
                  },
                  {
                    "#name": "identityTranslation",
                    "Description": {
                      "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                      "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                    }
                  },
                  {
                    "#name": "senderClientId",
                    "Description": {
                      "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                      "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                    }
                  },
                  {
                    "#name": "remoteCallingModeClientId",
                    "Description": {
                      "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                      "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                    }
                  },
                  {
                    "#name": "audienceOverride",
                    "Description": {
                      "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                      "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Flow items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_Get (updated)
Description :  Gets flow resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_CreateOrUpdate (updated)
Description :  Creates or updates the flow resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_CreateOrUpdate",
  "$parameters": {
    "flow": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
flow:
{
Description: Flow body ,
Required: True ,
}
{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The flow resource definition. ,
}
{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_Update (updated)
Description :  Updates the flow resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
flow:
{
Description: Flow body ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The flow resource definition. ,
}
{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_Disable (updated)
Description :  Disables the specified flow
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_Disable",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_Enable (updated)
Description :  Enables the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_Enable",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_GeneratePassphrase (updated)
Description :  Generate a compliant passphrase for the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_GeneratePassphrase",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/generatePassphrase
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_SetDestinationEndpointPorts (updated)
Description :  Set the destination endpoint ports for the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_SetDestinationEndpointPorts",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpointPorts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
streamDestinationEndpointPorts:
{
Description: The destination endpoint ports wanted ,
Required: True ,
}
{
ports:
{
Description: The specified flow destination endpoint ports ,
Required: False ,
}
[
integer ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_SetDestinationEndpoints (updated)
Description :  Set the destination endpoints for the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_SetDestinationEndpoints",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
streamDestinationEndpoints:
{
Description: Destination endpoints wanted. ,
Required: True ,
}
{
endpoints:
{
Description: The specified flow destination endpoints. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_SetPassphrase (updated)
Description :  Sets the passphrase of the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_SetPassphrase",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
passphrase:
{
Description: Passphrase to set ,
Required: True ,
}
{
value:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Flows_SetSourceAddresses (updated)
Description :  Set the source addresses for the specified flow.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Flows_SetSourceAddresses",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowType",
            "Description": {
              "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The flow type for this flow"
            }
          },
          {
            "#name": "dataType",
            "Description": {
              "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "Type of data to transfer via the flow."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this flow"
            }
          },
          {
            "#name": "schema",
            "Description": {
              "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The selected schema for this flow"
            }
          },
          {
            "apiFlowOptions": [
              {
                "#name": "remoteEndpoint",
                "Description": {
                  "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                  "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "identityTranslation",
                "Description": {
                  "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "senderClientId",
                "Description": {
                  "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "remoteCallingModeClientId",
                "Description": {
                  "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                }
              },
              {
                "#name": "audienceOverride",
                "Description": {
                  "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                  "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setSourceAddresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow to perform the operation on. ,
Required: True ,
}
string ,
sourceAddresses:
{
Description: Source addresses wanted ,
Required: True ,
}
{
values:
{
Description: Source addresses ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListPendingConnections_List (updated)
Description :  Lists all pending remote connections that are linkable to this connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListPendingConnections_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
                "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
              }
            },
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this connection"
              }
            },
            {
              "#name": "schemas",
              "Description": {
                "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The schemas for this connection"
              },
              "$items": {
                "Description": {
                  "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                  "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
                }
              }
            },
            {
              "#name": "schemaUris",
              "Description": {
                "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The schema URIs for this connection"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on this page ,
Required: True ,
}
[
{
subscriptionId:
{
Description: Subscription ID of the pending connection. ,
Required: False ,
}
string ,
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListPendingFlows_List (updated)
Description :  Lists all remote flows that have not yet been linked to local flows
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListPendingFlows_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "flowType",
              "Description": {
                "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            },
            {
              "#name": "dataType",
              "Description": {
                "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "Type of data to transfer via the flow."
              }
            },
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this flow"
              }
            },
            {
              "#name": "schema",
              "Description": {
                "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The selected schema for this flow"
              }
            },
            {
              "apiFlowOptions": [
                {
                  "#name": "remoteEndpoint",
                  "Description": {
                    "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                    "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                  }
                },
                {
                  "#name": "identityTranslation",
                  "Description": {
                    "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                    "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                  }
                },
                {
                  "#name": "senderClientId",
                  "Description": {
                    "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                    "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                  }
                },
                {
                  "#name": "remoteCallingModeClientId",
                  "Description": {
                    "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                    "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                  }
                },
                {
                  "#name": "audienceOverride",
                  "Description": {
                    "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                    "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection to perform the operation on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on this page ,
Required: True ,
}
[
{
subscriptionId:
{
Description: Subscription ID of the pending flow. ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID of the pending flow. ,
Required: False ,
}
string ,
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
id:
{
Description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_ListByResourceGroup (updated)
Description :  Lists all Pipeline resources within the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_ListByResourceGroup",
  "Description": {
    "new": "Lists all Pipeline resources within the specified resource group.",
    "old": "Gets pipelines in a resource group."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
            "old": "The pipeline resource definition."
          },
          "$properties": [
            {
              "#name": "properties",
              "Description": {
                "new": "The set of configurable properties for the Pipeline resource.",
                "old": "Properties of pipeline"
              },
              "$properties": [
                {
                  "#name": "policies",
                  "Description": {
                    "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                    "old": "The policies for this pipeline"
                  }
                },
                {
                  "#name": "flowTypes",
                  "Description": {
                    "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                    "old": "The flow type for this flow"
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Pipeline items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_Get (updated)
Description :  Retrieves the specified Pipeline resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_Get",
  "Description": {
    "new": "Retrieves the specified Pipeline resource.",
    "old": "Gets pipeline resource."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_CreateOrUpdate (updated)
Description :  Creates a new Pipeline resource or updates an existing one. This operation is asynchronous and returns the resulting Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_CreateOrUpdate",
  "Description": {
    "new": "Creates a new Pipeline resource or updates an existing one. This operation is asynchronous and returns the resulting Pipeline.",
    "old": "Creates or updates the pipeline resource."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "pipeline",
      "Description": {
        "new": "The request body containing the Pipeline definition.",
        "old": "Pipeline body"
      },
      "$schema": {
        "Description": {
          "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
          "old": "The pipeline resource definition."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "The set of configurable properties for the Pipeline resource.",
              "old": "Properties of pipeline"
            },
            "$properties": [
              {
                "#name": "policies",
                "Description": {
                  "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The policies for this pipeline"
                }
              },
              {
                "#name": "flowTypes",
                "Description": {
                  "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                  "old": "The flow type for this flow"
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    },
    "201": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
pipeline:
{
Description: The request body containing the Pipeline definition. ,
Required: True ,
}
{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed. ,
}
{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_Update (updated)
Description :  Applies partial updates to an existing Pipeline resource. This operation supports patch semantics and returns the updated Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_Update",
  "Description": {
    "new": "Applies partial updates to an existing Pipeline resource. This operation supports patch semantics and returns the updated Pipeline.",
    "old": "Updates the pipeline resource."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "pipeline",
      "Description": {
        "new": "The request body containing the updated Pipeline properties.",
        "old": "Pipeline body"
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow types allowed for this pipeline. FlowTypes has reached end of life support starting version 2025-05-30-preview. Please create and use the FlowProfile property instead.",
                "old": "The flow types allowed for this pipeline"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    },
    "202": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
pipeline:
{
Description: The request body containing the updated Pipeline properties. ,
Required: True ,
}
{
properties:
{
Description: Properties of pipelines patch body. ,
Required: False ,
}
{
flowTypes:
{
Description: The flow types allowed for this pipeline. FlowTypes has reached end of life support starting version 2025-05-30-preview. Please create and use the FlowProfile property instead. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed. ,
}
{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_Delete (updated)
Description :  Deletes the specified Pipeline resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_Delete",
  "Description": {
    "new": "Deletes the specified Pipeline resource.",
    "old": "Deletes the pipeline resource."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_ApproveConnection (updated)
Description :  Approves a pending connection request associated with the specified Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_ApproveConnection",
  "Description": {
    "new": "Approves a pending connection request associated with the specified Pipeline.",
    "old": "Approves the specified connection request in a pipeline."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "connection",
      "Description": {
        "new": "The request body containing the connection to approve.",
        "old": "Connection body"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
connection:
{
Description: The request body containing the connection to approve. ,
Required: True ,
}
{
id:
{
Description: ID of the resource. ,
Required: True ,
}
string ,
statusReason:
{
Description: Reason for resource operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_ExecuteAction (updated)
Description :  Executes a privileged or administrative action on the specified Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_ExecuteAction",
  "Description": {
    "new": "Executes a privileged or administrative action on the specified Pipeline.",
    "old": "Executes a privileged action for a pipeline."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "action",
      "Description": {
        "new": "The action to be executed on the Pipeline.",
        "old": "Action to execute"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The pipeline resource definition. A Pipeline defines the scope and identity under which data replication scenarios are managed.",
        "old": "The pipeline resource definition."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "The set of configurable properties for the Pipeline resource.",
            "old": "Properties of pipeline"
          },
          "$properties": [
            {
              "#name": "policies",
              "Description": {
                "new": "The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The policies for this pipeline"
              }
            },
            {
              "#name": "flowTypes",
              "Description": {
                "new": "The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                "old": "The flow type for this flow"
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/executeAction
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
action:
{
Description: The action to be executed on the Pipeline. ,
Required: True ,
}
{
actionType:
{
Description: Type of action to be executed ,
Enum:
{
AllowUpdates: Allow a pipeline, connection, or flow to be updated. ,
ForceDisable: Force disable a pipeline, connection, or flow. ,
}
,
Required: True ,
}
enum ,
targetType:
{
Description: Type of target to execute the action on ,
Enum:
{
Pipeline: The action executing is targeting a pipeline. ,
Connection: The action executing is targeting a connection. ,
FlowType: The action executing is targeting a flow type. ,
}
,
Required: True ,
}
enum ,
targets:
{
Description: Targets for the action ,
Required: True ,
}
[
string ,
]
,
justification:
{
Description: Business justification for the action ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of configurable properties for the Pipeline resource. ,
Required: False ,
}
{
remoteCloud:
{
Description: Remote cloud of the data to be transferred or received ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of this pipeline ,
Required: False ,
}
string ,
connections:
{
Description: Connections associated with pipeline ,
Required: False ,
}
[
{
id:
{
Description: Connection id inside pipeline ,
Required: True ,
}
string ,
name:
{
Description: Connection name inside pipeline ,
Required: False ,
}
string ,
type:
{
Description: Connection type inside pipeline ,
Required: False ,
}
string ,
location:
{
Description: Connection location inside pipeline ,
Required: False ,
}
string ,
etag:
{
Description: Connection etag inside pipeline ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Connection properties inside pipeline ,
Required: False ,
}
{
internalMetadata:
{
Description: Internal metadata of the connection inside pipeline. ,
Required: False ,
}
{
operationStatus:
{
Description: Operation status associated with the last patch request ,
Required: False ,
}
{
status:
{
Description: Operation status for the last patch request for this connection. ,
Enum:
{
Failed: The last patch request for this connection completed with an error. ,
Succeeded: The last patch request for this connection completed. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Operation status ID of the last patch request for this connection. ,
Required: False ,
}
string ,
message:
{
Description: Message for the operation for the last patch request for this connection. ,
Required: False ,
}
string ,
}
,
statusSetBy:
{
Description: User that last set the approved status for this connection ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
subscribers:
{
Description: Subscribers of this resource ,
Required: False ,
}
[
{
email:
{
Description: Email of the subscriber ,
Required: False ,
}
string ,
notifications:
{
Description: Number specifying what notifications to receive ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the pipeline ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow type for this flow. The flowTypes property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
disabledFlowTypes:
{
Description: The flow types that are disabled for this pipeline ,
Required: False ,
}
[
string ,
]
,
quarantineDownloadStorageAccount:
{
Description: Quarantine Download Storage Account ,
Required: False ,
}
string ,
quarantineDownloadStorageContainer:
{
Description: Quarantine Download Storage Container ,
Required: False ,
}
string ,
status:
{
Description: Status of the current pipeline ,
Enum:
{
Enabled: The pipeline is currently enabled and all child connection and flow resources below able to send or receive data. ,
Disabled: The pipeline is currently disabled and all child connection and flow resources below are unable to send or receive data. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListFlowsByPipeline_List (updated)
Description :  Lists all Flows associated with the specified Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListFlowsByPipeline_List",
  "Description": {
    "new": "Lists all Flows associated with the specified Pipeline.",
    "old": "Lists the flows in a pipeline."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "connections",
      "Description": {
        "new": "A list of connection identifiers used to filter the Flows to be retrieved.",
        "old": "Connection(s) to retrieve flows of"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "flows": {
              "$properties": {
                "properties": [
                  {
                    "#name": "flowType",
                    "Description": {
                      "new": "The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                      "old": "The flow type for this flow"
                    }
                  },
                  {
                    "#name": "dataType",
                    "Description": {
                      "new": "Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                      "old": "Type of data to transfer via the flow."
                    }
                  },
                  {
                    "#name": "policies",
                    "Description": {
                      "new": "The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                      "old": "The policies for this flow"
                    }
                  },
                  {
                    "#name": "schema",
                    "Description": {
                      "new": "The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
                      "old": "The selected schema for this flow"
                    }
                  },
                  {
                    "apiFlowOptions": [
                      {
                        "#name": "remoteEndpoint",
                        "Description": {
                          "new": "Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead.",
                          "old": "Remote host to which communication needs to be made. Deprecated starting 2025-05-30-preview."
                        }
                      },
                      {
                        "#name": "identityTranslation",
                        "Description": {
                          "new": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                          "old": "Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. Deprecated starting 2025-05-30-preview."
                        }
                      },
                      {
                        "#name": "senderClientId",
                        "Description": {
                          "new": "Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                          "old": "Sender's app user assigned Manage Identity client ID. Deprecated starting 2025-05-30-preview."
                        }
                      },
                      {
                        "#name": "remoteCallingModeClientId",
                        "Description": {
                          "new": "Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                          "old": "Remote stub app registration Client ID. Deprecated starting 2025-05-30-preview."
                        }
                      },
                      {
                        "#name": "audienceOverride",
                        "Description": {
                          "new": "Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead.",
                          "old": "Optional field to override the audience of the remote endpoint. Deprecated starting 2025-05-30-preview."
                        }
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listFlows
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
connections:
{
Description: A list of connection identifiers used to filter the Flows to be retrieved. ,
Required: False ,
}
{
value:
{
Description: Connection ID to target ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List flows by pipeline result by connection ,
Required: False ,
}
[
{
id:
{
Description: ID of the connection. ,
Required: False ,
}
string ,
flows:
{
Description: List of flows associated with the connection. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of flow ,
Required: False ,
}
{
connection:
{
Description: The connection associated with this flow ,
Required: False ,
}
{
name:
{
Description: Name of the connection ,
Required: False ,
}
string ,
id:
{
Description: Id of the connection ,
Required: True ,
}
string ,
location:
{
Description: Location of the connection ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Name of the subscription with the connection ,
Required: False ,
}
string ,
}
,
flowId:
{
Description: Dataflow GUID associated with this flow ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: URI to a Key Vault Secret containing a SAS token. ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: The flow is currently enabled and able to send or receive data. ,
Disabled: The flow is currently disabled and cannot send or receive data. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current flow ,
Required: False ,
}
[
string ,
]
,
storageAccountName:
{
Description: Storage Account ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Storage Account ID ,
Format: arm-id ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Storage Container Name ,
Required: False ,
}
string ,
storageTableName:
{
Description: Storage Table Name ,
Required: False ,
}
string ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Unknown: This type of flow is not set. ,
Complex: This flow sends complex documents, such as Microsoft Office documents of Portable document format files. ,
DevSecOps: This flow sends source code files and artifacts. ,
Messaging: This flow over the Azure Data Transfer low latency messaging subsystem. ,
Mission: This flow sends standard data but is subject to strict cloud owner approval. ,
MicrosoftInternal: This flow is assigned to internal Microsoft use cases. ,
BasicFiles: This flow sends blobs that can be used for multiple use cases. ,
Data: This flow sends blobs that can be used for multiple use cases. ,
Standard: This flow sends blobs that can be used for multiple use cases. ,
StreamingVideo: This flow sends video streams. ,
Opaque: This flow sends blobs but is subject to cloud owner approval. ,
MissionOpaqueXML: This flow sends Extensible Markup Language that is subject to strict cloud owner approval ,
DiskImages: This flow sends blobs that can be used for Virtual Machines. ,
API: This flow sends data via an Application Programmer Interface. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Enum:
{
Blob: The flow uses Azure Storage blobs to send or receive data. ,
Table: The flow uses Azure Storage tables to send or receive data. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: Billing tier for messaging processing that charges based on how much data is transferred. ,
Standard: Billing tier for standard messaging processing that charges based on having the messaging resource allocated. ,
Premium: Billing tier for premium messaging processing that charges based on having the messaging resource allocated. ,
}
,
Required: False ,
}
enum ,
}
,
apiFlowOptions:
{
Description: The API Flow configuration options for Azure Data Transfer API Flow type. ,
Required: False ,
}
{
remoteEndpoint:
{
Description: Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. ,
Required: False ,
}
string ,
cname:
{
Description: Unique CNAME to represent the Azure Data Transfer API Flow instance ,
Required: False ,
}
string ,
apiMode:
{
Description: Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked ,
Enum:
{
SDK: The API flow will forward calls to a custom Software Development Kit implementation. ,
Endpoint: The API flow will forward calls to a specified endpoint. ,
}
,
Required: False ,
}
enum ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Enum:
{
UserIdentity: The API flow will make use of the user identity that called this API flow, and pass that token through the boundary. ,
ServiceIdentity: The API flow will make use of the Azure Data Transfer Flow managed identity on the other side of the boundary. ,
}
,
Required: False ,
}
enum ,
senderClientId:
{
Description: Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
remoteCallingModeClientId:
{
Description: Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
audienceOverride:
{
Description: Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. ,
Required: False ,
}
string ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: uri ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: This Flow is using User Datagram Protocol for the video stream. ,
SRT: This Flow is using Secure Reliable Transfer for the video stream. ,
RTP: This Flow is using Real-time Transport Protocol for the video stream. ,
}
,
Required: False ,
}
enum ,
streamLatency:
{
Description: The latency of the stream in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
passphrase:
{
Description: The passphrase used for SRT streams ,
Required: False ,
}
string ,
sourceAddresses:
{
Description: The source IP address and CIDR ranges of the stream ,
Required: False ,
}
{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
Required: False ,
}
[
string ,
]
,
}
,
destinationEndpoints:
{
Description: The destination endpoints of the stream ,
Required: False ,
}
[
string ,
]
,
destinationEndpointPorts:
{
Description: The destination endpoint ports of the stream ,
Required: False ,
}
[
integer ,
]
,
eventHubId:
{
Description: Event Hub ID ,
Format: arm-id ,
Required: False ,
}
string ,
consumerGroup:
{
Description: Event Hub Consumer Group ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListSchemas_List (updated)
Description :  Lists the schemas associated with a specific connection in the Pipeline. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListSchemas_List",
  "Description": {
    "new": "Lists the schemas associated with a specific connection in the Pipeline. This operation has reached end of life support starting version 2025-05-30-preview. For schema support please create and use a FlowProfile resource.",
    "old": "Lists the schemas for the specified connection in a pipeline."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "schema",
      "Description": {
        "new": "The schema(s) to retrieve for the specified connection.",
        "old": "Schema(s) to retrieve"
      },
      "$schema": {
        "Description": {
          "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
          "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The schemas list result. SchemaListResults has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
        "old": "The schemas list result. SchemaListResults will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
      },
      "$properties": {
        "value": {
          "Description": {
            "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
            "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
schema:
{
Description: The schema(s) to retrieve for the specified connection. ,
Required: True ,
}
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Schemas array. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Pipelines_RejectConnection (updated)
Description :  Rejects a pending connection request associated with the specified Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pipelines_RejectConnection",
  "Description": {
    "new": "Rejects a pending connection request associated with the specified Pipeline.",
    "old": "Rejects the specified connection request in a pipeline."
  },
  "$parameters": [
    {
      "#name": "pipelineName",
      "Description": {
        "new": "The name of the pipeline on which to operate.",
        "old": "The name for the pipeline to perform the operation on."
      }
    },
    {
      "#name": "connection",
      "Description": {
        "new": "The request body containing the connection to reject.",
        "old": "Connection body"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "flowTypes",
            "Description": {
              "new": "The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead.",
              "old": "The flow types being requested for this connection. This FlowType property is deprecated starting from version 2025_05_30_preview - please create a FlowProfile resource instead."
            }
          },
          {
            "#name": "policies",
            "Description": {
              "new": "The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The policies for this connection"
            }
          },
          {
            "#name": "schemas",
            "Description": {
              "new": "The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schemas for this connection"
            },
            "$items": {
              "Description": {
                "new": "The schema object. Schemas has reached end of life support starting version 2025-05-30-preview. Please manage schemas with a FlowProfile resource instead.",
                "old": "The schema object. Schemas will be deprecated starting from version 2025_05_30_preview - please manage schemas with a FlowProfile resource instead."
              }
            }
          },
          {
            "#name": "schemaUris",
            "Description": {
              "new": "The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead.",
              "old": "The schema URIs for this connection"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
connection:
{
Description: The request body containing the connection to reject. ,
Required: True ,
}
{
id:
{
Description: ID of the resource. ,
Required: True ,
}
string ,
statusReason:
{
Description: Reason for resource operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of connection ,
Required: False ,
}
{
pipeline:
{
Description: Pipeline to use to transfer data ,
Required: True ,
}
string ,
direction:
{
Description: Direction of data movement ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: This connection has been created but is under review by the pipeline owner. ,
Approved: This connection has been approved by the pipeline owner and is ready for use. ,
Rejected: This connection has been rejected by the pipeline owner and cannot be used. ,
Accepted: Creation of the connection has been accepted. ,
}
,
Required: False ,
}
enum ,
forceDisabledStatus:
{
Description: Force disablement status of the current connection ,
Required: False ,
}
[
string ,
]
,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: The pipeline, connection, or flow is currently linked with another corresponding pipeline, connection, or flow, and can be used. ,
Unlinked: The pipeline, connection, or flow is not linked with another corresponding pipeline, connection, or flow, and cannot be used. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection. This FlowType property has reached end of life support starting version 2025-05-30-preview. Please create a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection. The policies property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection. The schemas property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
{
id:
{
Description: ID associated with this schema ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID associated with this schema ,
Required: False ,
}
string ,
status:
{
Description: Status of the schema ,
Enum:
{
New: A schema that has not been approved and is awaiting review. ,
Approved: A schema that has been approved and is ready for use. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the schema ,
Required: False ,
}
string ,
content:
{
Description: Content of the schema ,
Required: False ,
}
string ,
direction:
{
Description: The direction of the schema. ,
Enum:
{
Send: The direction is on the sending side of a pipeline, connection, or flow. ,
Receive: The direction is on the receiving side side of a pipeline, connection, or flow. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: uri ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: The schema represents a single XML schema definition file. ,
Zip: The schema represents a ZIP file with multiple XML schema definition files within it. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection. The schemaUris property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}