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

2025/08/21 • 4 updated methods

FlowProfiles_ListByPipeline (updated)
Description :  Lists all FlowProfiles under a given Pipeline.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FlowProfiles_ListByPipeline",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "rulesets": [
                  {
                    "mimeFilters": [
                      {
                        "#name": "filters",
                        "Type": {
                          "new": "array",
                          "old": "object"
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚶ Changes

{
  "#id": "FlowProfiles_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the pipeline on which to operate. ,
Required: True ,
}
string ,
flowProfileName:
{
Description: The name of the FlowProfile resource to operate on. Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FlowProfiles_CreateOrUpdate (updated)
Description :  Creates a new FlowProfile or updates an existing one.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FlowProfiles_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents a FlowProfile Azure resource, which defines a data replication scenario with a specific data classification and a set of configurable policy rules. ,
}
{
properties:
{
Description: The set of configuration properties that define the behavior and rules of the FlowProfile. ,
Required: False ,
}
{
provisioningState:
{
Description: The current provisioning state of the FlowProfile. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted for creation. ,
}
,
Required: False ,
}
enum ,
flowProfileId:
{
Description: A guid represented as a string for the FlowProfile resource, assigned by the system. ,
Required: False ,
}
string ,
replicationScenario:
{
Description: The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. ,
Enum:
{
Messaging: Represents standard message-based data, including Azure Service and Event Hub, used in message replication. ,
API: Represents transactional request/response data types from API endpoints. ,
Stream: Represents data types that require continuous, real-time streaming replication (e.g., video). ,
Files: Represents standard file-based data, including Azure Blob and Table Storage, used in general-purpose replication. ,
SoftwareArtifacts: Represents data related to development, security, and operations workflows such as build artifacts subject to an NCDSMO policy. ,
Complex: Represents rich content types such as documents (e.g., Word, PDF) and images that require specialized replication handling. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The operational status of the FlowProfile. ,
Enum:
{
Obsolete: Defines a FlowProfile that can no longer be selected. ,
Enabled: Defines a FlowProfile that is enabled. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: A user-defined description of the FlowProfile. ,
Required: True ,
}
string ,
rulesets:
{
Description: A set of configurable rulesets applied to this FlowProfile. ,
Required: False ,
}
{
antivirus:
{
Description: Antivirus scanning rules for replicated data. ,
Required: False ,
}
{
avSolutions:
{
Description: Optional. The list of antiviruses to be used as a scanning solution for replicating data. ,
Required: False ,
}
[
string ,
]
,
}
,
archives:
{
Description: Rules for handling archive files during replication. ,
Required: False ,
}
{
minimumSizeForExpansion:
{
Description: Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumExpansionSizeLimit:
{
Description: Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumDepthLimit:
{
Description: Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumCompressionRatioLimit:
{
Description: Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). ,
Format: double ,
Required: False ,
}
number ,
}
,
dataSize:
{
Description: Rules that enforce minimum and maximum data size limits. ,
Required: False ,
}
{
maximum:
{
Description: Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
minimum:
{
Description: Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
mimeFilters:
{
Description: Rules for filtering files based on MIME types. ,
Required: False ,
}
{
type:
{
Description: Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. ,
Enum:
{
Allow: Defines an allow filter used for allowlist. ,
Deny: Defines a denying filter used for blocklisting. ,
}
,
Required: False ,
}
enum ,
filters:
{
Description: Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. ,
Required: False ,
}
[
{
media:
{
Description: The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml ,
Required: False ,
}
string ,
extensions:
{
Description: A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
xmlFilters:
{
Description: Rules for filtering XML content using XSD schemas. ,
Required: False ,
}
{
defaultNamespace:
{
Description: The default XML namespace used for schema validation. ,
Required: False ,
}
string ,
reference:
{
Description: Defines the method for referencing the xml schema. ,
Enum:
{
Inline: Defines a referencing procedure where the xml schema will be provided inline. ,
}
,
Required: False ,
}
enum ,
schema:
{
Description: The inline XSD schema to be used for validation. ,
Required: False ,
}
string ,
}
,
textMatching:
{
Description: Rules for detecting and blocking specific text patterns. ,
Required: False ,
}
{
deny:
{
Description: A list of text patterns to block, each with matching rules and case sensitivity options. ,
Required: False ,
}
[
{
text:
{
Description: The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. ,
Required: True ,
}
string ,
matchType:
{
Description: Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. ,
Enum:
{
Partial: The option to pattern match substrings within all text content. For example, "hello world" would be found in "chello worlds". ,
Complete: The option to pattern match the entire string explicitly. For example, "hello world" would NOT be found in "chello worlds". ,
}
,
Required: True ,
}
enum ,
caseSensitivity:
{
Description: Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. ,
Enum:
{
Insensitive: Ignores casing when performing pattern matching. For example, "Hello World" would be found in "hello world". ,
Sensitive: Requires exact casing for the pattern match. For example, "Hello World" would NOT not be found in "hello world". ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FlowProfiles_Update (updated)
Description :  Applies partial updates to an existing FlowProfile resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FlowProfiles_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "rulesets": [
              {
                "mimeFilters": [
                  {
                    "#name": "filters",
                    "Type": {
                      "new": "array",
                      "old": "object"
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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