Microsoft.AzureDataTransfer (preview:2025-05-30)

2025/08/12 • 46 new methods

AzureDataTransfer_listApprovedSchemas (new)
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 ¶

⚼ 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_ListFlowProfiles (new)
Description :  Retrieves a list of FlowProfile resources associated with a specified pipeline.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.AzureDataTransfer/listFlowProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
pipeline:
{
Description: The name of the pipeline for which to retrieve associated FlowProfiles. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureDataTransfer/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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 ,
}
,
]
,
}
,
}
AzureDataTransfer_validateSchema (new)
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 ¶

⚼ 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 (new)
Description :  Gets connections in a subscription.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Lists all Pipeline resources within the current subscription.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 (new)
Description :  Gets connections in a resource group.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Gets connection resource.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Creates or updates the connection resource.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Updates the connection resource.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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_Delete (new)
Description :  Deletes the connection resource.
Reference :  Link ¶

⚼ Request

DELETE:  /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 (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 ,
}
,
]
,
}
,
}
Flows_ListByConnection (new)
Description :  Gets flows in a connection.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Gets flow resource.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Creates or updates the flow resource.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Updates the flow resource.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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_Delete (new)
Description :  Deletes the flow resource.
Reference :  Link ¶

⚼ Request

DELETE:  /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 (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 ,
}
,
]
,
}
,
}
Flows_Disable (new)
Description :  Disables the specified flow
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Enables the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Generate a compliant passphrase for the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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_GetDestinationEndpointPorts (new)
Description :  Get the destination endpoint ports for the specified flow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpointPorts
{
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)

{
ports:
{
Description: The destination endpoint port for the flow stream ,
Required: False ,
}
[
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_GetDestinationEndpoints (new)
Description :  Get the destination endpoints for the specified flow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpoints
{
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)

{
endpoints:
{
Description: The destination endpoints for the flow stream ,
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_GetSourceAddresses (new)
Description :  Get the source addresses for the specified flow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getSourceAddresses
{
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)

{
sourceAddresses:
{
Description: A source IP address or CIDR range ,
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_GetStreamConnectionString (new)
Description :  Get the connection string for the specified flow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getStreamConnectionString
{
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)

{
connectionString:
{
Description: The connection string for the specified streaming flow ,
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_SetDestinationEndpointPorts (new)
Description :  Set the destination endpoint ports for the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Set the destination endpoints for the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Sets the passphrase of the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Set the source addresses for the specified flow.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Lists all pending remote connections that are linkable to this connection.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Lists all remote flows that have not yet been linked to local flows
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
Description :  Lists all Pipeline resources within the specified resource group.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 (new)
Description :  Retrieves the specified Pipeline resource.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 (new)
Description :  Creates a new Pipeline resource or updates an existing one. This operation is asynchronous and returns the resulting Pipeline.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 (new)
Description :  Applies partial updates to an existing Pipeline resource. This operation supports patch semantics and returns the updated Pipeline.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 (new)
Description :  Deletes the specified Pipeline resource.
Reference :  Link ¶

⚼ 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 (new)
Description :  Approves a pending connection request associated with the specified Pipeline.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 (new)
Description :  Executes a privileged or administrative action on the specified Pipeline.
Reference :  Link ¶

⚼ 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 ,
]
,
disabledDataClass:
{
Description: The DataClasses 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 ,
}
,
]
,
}
,
}
FlowProfiles_ListByPipeline (new)
Description :  Lists all FlowProfiles under a given Pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles
{
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)

{
value:
{
Description: The FlowProfile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
FlowProfiles_Get (new)
Description :  Retrieves the specified FlowProfile resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}
{
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 ,
flowProfileName:
{
Description: The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
FlowProfiles_CreateOrUpdate (new)
Description :  Creates a new FlowProfile or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}
{
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 ,
flowProfileName:
{
Description: The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. ,
Required: True ,
}
string ,
resource:
{
Description: The FlowProfile resource definition to create or update. ,
Required: True ,
}
{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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 configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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: Represents a FlowProfile Azure resource, which defines a data replication scenario with a specific data classification and a set of configurable policy rules. ,
}
{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
FlowProfiles_Update (new)
Description :  Applies partial updates to an existing FlowProfile resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}
{
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 ,
flowProfileName:
{
Description: The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. ,
Required: True ,
}
string ,
properties:
{
Description: The FlowProfile patch definition containing the properties to update. ,
Required: True ,
}
{
properties:
{
Description: Properties of FlowProfile patch body. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile resource. ,
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 ,
description:
{
Description: A description of the FlowProfile that defines the replication scenario. ,
Required: False ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
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 ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
FlowProfiles_Delete (new)
Description :  Deletes the specified FlowProfile resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}
{
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 ,
flowProfileName:
{
Description: The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. ,
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 ,
}
,
]
,
}
,
}
ListFlowsByPipeline_List (new)
Description :  Lists all Flows associated with the specified Pipeline.
Reference :  Link ¶

⚼ 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 ,
flowProfile:
{
Description: Type of FlowProfile to use for transfer via the flow. ,
Required: False ,
}
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
string ,
}
,
flowDataType:
{
Description: The Flow's data class. ,
Enum:
{
ServiceBus: (Messaging) Replicates messages from Azure Service Bus for downstream processing or analysis. ,
EventHub: (Messaging) Replicates messages from Azure Event Hub for downstream processing or analysis. ,
ApiEndpoint: (API) Replicates request/response data through RESTful API endpoints. ,
ApiSDK: (API) Replicates request/response data through SDK-based integrations. ,
Video: (Stream) Enables replication of real-time video streaming data. ,
Blob: (Files/DevSecOps/Complex/Mission) Replicates generic blobs data using Azure Blob Storage. ,
Table: (Files) Replicates structured NoSQL data using Azure Table Storage. ,
}
,
Required: False ,
}
enum ,
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 ,
performancePriority:
{
Description: Field indicating whether to enable guaranteed delivery on the flow or not. The default disabled option chooses speed over consistency. When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions ,
Enum:
{
Enabled: Represents an enabled status. ,
Disabled: Represents a disabled status. ,
}
,
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 ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the Azure Data Transfer API Flow. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
remoteEndpointSettings:
{
Description: Defines the destination remote endpoint for the API calls. ,
Required: False ,
}
{
endpoint:
{
Description: The remote endpoint uri all API calls. ,
Required: True ,
}
string ,
authentication:
{
Description: Optional and for advanced used only. A list of authentication methods to use when accessing the remote endpoint. If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. ,
Required: False ,
}
[
{
type:
{
Description: Type of authentication mechanism. JWT by default. ,
Enum:
{
JWT: Option to use a JWT Bearer Authentication Token. ,
None: Option to not use any form of Authentication. ,
}
,
Required: False ,
}
enum ,
instance:
{
Description: The identity provider's token service instance. ,
Required: False ,
}
string ,
tenantId:
{
Description: A unique identifier representing the tenant of the identity provider's token service. ,
Required: False ,
}
string ,
authority:
{
Description: The full URL endpoint used to acquire tokens, typically combining the instance and tenant ID to target a specific authentication context. ,
Required: False ,
}
string ,
applicationIds:
{
Description: List of applicationIds allowed to authorize to this flow. This is used as an alternative to the RBAC authorization check. ,
Required: False ,
}
[
string ,
]
,
audience:
{
Description: Audience of the identity of the remote endpoint service. By default, remoteEndpointSettings.endpoint will be used if a value is not provided. ,
Required: False ,
}
string ,
clientIdOverride:
{
Description: The Flow can use an Entra app identity that is provided by the Flow user to obtain the token to call the remote endpoint. This field specifies the user provided app's clientId. ,
Required: False ,
}
string ,
identityTranslation:
{
Description: Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. ,
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 ,
}
,
]
,
}
,
}
,
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 (new)
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 ¶

⚼ 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 (new)
Description :  Rejects a pending connection request associated with the specified Pipeline.
Reference :  Link ¶

⚼ 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 ,
]
,
flowProfileList:
{
Description: Provides a list of FlowProfiles . ,
Required: False ,
}
[
{
pipeline:
{
Description: The name of the parent Pipeline Azure resource associated with this FlowProfile. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FlowProfile. ,
Required: True ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
DevSecOps: Represents data related to development, security, and operations workflows subject to two-person cryptographic integrity validations. ,
}
,
Required: True ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: True ,
}
string ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. ,
Required: True ,
}
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 ,
]
,
apiHostname:
{
Description: Hostname specific to API Flows ,
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 ,
}
,
]
,
}
,
}