Microsoft.AzureDataTransfer (preview:2025-03-01)

2025/03/22 • 38 new methods

AzureDataTransfer_validateSchema (new)
Description :  Validates a schema for Azure Data Transfer.
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 schema to validate ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Validation status of the schema ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
AzureDataTransfer_listApprovedSchemas (new)
Description :  Lists approved schemas for Azure Data Transfer.
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 to list 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: No description available. ,
Receive: No description available. ,
}
,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
Flows_Get (new)
Description :  Gets flow resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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}
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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)

{
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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}
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location response header ,
}
string ,
}

⚐ 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_Update (new)
Description :  Updates the flow resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
flow:
{
Description: Flow body ,
Required: True ,
}
{
identity:
{
Description: The managed identity of the flow resource, if configured. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
string ,
}
,
$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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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_Enable (new)
Description :  Enables the specified flow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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_Disable (new)
Description :  Disables the specified flow
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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_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
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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_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
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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_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
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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_GetDestinationEndpoints (new)
Description :  Get the destination endpoints for the specified flow and stream ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpoints
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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_SetDestinationEndpoints (new)
Description :  Set the destination endpoints for the specified flow and stream ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpoints
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
streamDestinationEndpoints:
{
Description: Stream ID destination endpoints wanted ,
Required: True ,
}
{
endpoints:
{
Description: The specified stream ID 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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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_GetDestinationEndpointPorts (new)
Description :  Get the destination endpoint ports for the specified flow and stream ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpointPorts
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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_SetDestinationEndpointPorts (new)
Description :  Set the destination endpoint ports for the specified flow and stream ID.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpointPorts
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
streamDestinationEndpointPorts:
{
Description: Stream ID destination endpoint ports wanted ,
Required: True ,
}
{
ports:
{
Description: The specified stream ID 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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Location response header ,
}
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
{
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 that is to be requested. ,
Required: True ,
}
string ,
flowName:
{
Description: The name for the flow that is to be onboarded. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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_ListByConnection (new)
Description :  Gets flows in a connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name for the connection that is to be requested. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Flows array. ,
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: AME, PME, or TORUS only! AKV Chain Containing SAS Token ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current flow ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedFlowId:
{
Description: Resource ID of the linked flow ,
Required: False ,
}
string ,
status:
{
Description: Status of the current flow ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
serviceBusQueueId:
{
Description: Service Bus Queue ID ,
Format: arm-id ,
Required: False ,
}
string ,
flowType:
{
Description: The flow type for this flow ,
Enum:
{
Unknown: No description available. ,
Complex: No description available. ,
DevSecOps: No description available. ,
Messaging: No description available. ,
Mission: No description available. ,
MicrosoftInternal: No description available. ,
BasicFiles: No description available. ,
Data: No description available. ,
Standard: No description available. ,
StreamingVideo: No description available. ,
Opaque: No description available. ,
MissionOpaqueXML: No description available. ,
DiskImages: No description available. ,
}
,
Required: False ,
}
enum ,
dataType:
{
Description: Transfer Storage Blobs or Tables ,
Enum:
{
Blob: No description available. ,
Table: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the flow ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this flow ,
Required: False ,
}
[
string ,
]
,
schema:
{
Description: The selected schema for this flow ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
messagingOptions:
{
Description: The messaging options for this flow ,
Required: False ,
}
{
billingTier:
{
Description: Billing tier for this messaging flow ,
Enum:
{
BlobTransport: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customerManagedKeyVaultUri:
{
Description: The URI to the customer managed key for this flow ,
Format: url ,
Required: False ,
}
string ,
streamId:
{
Description: The flow stream identifier ,
Required: False ,
}
string ,
streamProtocol:
{
Description: The protocol of the stream ,
Enum:
{
UDP: No description available. ,
SRT: No description available. ,
RTP: No description available. ,
}
,
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 ,
]
,
}
,
plan:
{
Description: Plan for the resource. ,
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 identity of the flow resource, if configured. ,
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: Link to next results ,
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}
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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}
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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)

{
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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}
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location response header ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Connections_Update (new)
Description :  Updates the connection resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connection:
{
Description: Connection body ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: Location response header ,
}
string ,
}
,
$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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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 ,
}
,
]
,
}
,
}
ListPendingConnections_List (new)
Description :  Lists all pending connections for a connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Connections array. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription ID of the pending connection. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next results ,
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 pending flows for a connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows
{
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 that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: flows array. ,
Required: False ,
}
[
{
subscriptionId:
{
Description: Subscription ID of the pending flow. ,
Required: False ,
}
string ,
connectionId:
{
Description: Connection ID of the pending flow. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to next results ,
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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Connections array. ,
Required: False ,
}
[
{
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: Link to next results ,
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
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Connections array. ,
Required: False ,
}
[
{
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: Link to next results ,
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 :  Gets pipeline resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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 or updates the pipeline resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
pipeline:
{
Description: Pipeline body ,
Required: True ,
}
{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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 pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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)

{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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 pipeline resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location response header ,
}
string ,
}

⚐ 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_Update (new)
Description :  Updates the pipeline resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
pipeline:
{
Description: Pipeline body ,
Required: True ,
}
{
properties:
{
Description: Properties of pipelines patch body. ,
Required: False ,
}
{
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: No description available. ,
Succeeded: No description available. ,
}
,
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 ,
}
,
}
,
}
,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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 pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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: Location response header ,
}
string ,
}
,
$schema:
{
Description: The pipeline resource definition. ,
}
{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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_ApproveConnection (new)
Description :  Approves the specified connection in a pipeline.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connection:
{
Description: Connection body ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: Location response header ,
}
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_RejectConnection (new)
Description :  Rejects the specified connection in a pipeline.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connection:
{
Description: Connection body ,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
justification:
{
Description: Justification for the connection request ,
Required: False ,
}
string ,
status:
{
Description: Status of the connection ,
Enum:
{
InReview: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
statusReason:
{
Description: Reason for status ,
Required: False ,
}
string ,
linkStatus:
{
Description: Link status of the current connection ,
Enum:
{
Linked: No description available. ,
Unlinked: No description available. ,
}
,
Required: False ,
}
enum ,
linkedConnectionId:
{
Description: Resource ID of the linked connection ,
Required: False ,
}
string ,
flowTypes:
{
Description: The flow types being requested for this connection ,
Required: False ,
}
[
string ,
]
,
requirementId:
{
Description: Requirement ID of the connection ,
Required: False ,
}
string ,
remoteSubscriptionId:
{
Description: Subscription ID to link cloud subscriptions together ,
Required: False ,
}
string ,
approver:
{
Description: Approver of this connection request ,
Required: False ,
}
string ,
pin:
{
Description: PIN to link requests together ,
Required: False ,
}
string ,
dateSubmitted:
{
Description: The timestamp that this connection request was submitted at ,
Format: date-time ,
Required: False ,
}
string ,
primaryContact:
{
Description: The primary contact for this connection request ,
Required: False ,
}
string ,
secondaryContacts:
{
Description: The secondary contacts for this connection request ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the connection ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this connection ,
Required: False ,
}
[
string ,
]
,
schemas:
{
Description: The schemas for this connection ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
schemaUris:
{
Description: The schema URIs for this connection ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the connection resource, if configured. ,
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: Location response header ,
}
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 ,
}
,
]
,
}
,
}
ListSchemas_List (new)
Description :  Lists the schemas for the specified connection in a pipeline.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas
{
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 for the pipeline that is to be requested. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
schema:
{
Description: Schema(s) to retrieve ,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
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: No description available. ,
Approved: No description available. ,
}
,
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: No description available. ,
Receive: No description available. ,
}
,
Required: False ,
}
enum ,
schemaUri:
{
Description: Uri containing SAS token for the zipped schema ,
Format: url ,
Required: False ,
}
string ,
schemaType:
{
Description: The Schema Type ,
Enum:
{
Xsd: No description available. ,
Zip: No description available. ,
}
,
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_ListByResourceGroup (new)
Description :  Gets pipelines in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Pipelines array. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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: Link to next results ,
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 :  Gets pipelines in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Pipelines array. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of pipeline ,
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: No description available. ,
Succeeded: No description available. ,
}
,
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:
{
Failed: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: The policies for this pipeline ,
Required: False ,
}
[
string ,
]
,
flowTypes:
{
Description: The flow types allowed for this pipeline ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: The managed identity of the pipeline resource, if configured. ,
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: Link to next results ,
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Microsoft.AzureDataTransfer REST API operations.
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 ,
}
,
]
,
}
,
}