Updating swagger files.

common/definitions.json

@@ -55,6 +55,14 @@
                     "description": "The error related resource details.",
                     "$ref": "#/definitions/ErrorRelatedResource",
                     "readOnly": true
+                },
+                "parameters": {
+                    "description": "Structured parameters providing additional machine-readable context about the error.",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ErrorParameter"
+                    },
+                    "readOnly": true
                 }
             }
         },
@@ -1146,6 +1154,12 @@
                     "items": {
                         "type": "string"
                     }
+                },
+                "predicateExpression": {
+                    "description": "The predicate expression that determines whether an audit event is processed. Specify only the `<predicate_expression>` value; don't include the `WHERE` keyword. The expression uses the following syntax from [CREATE SERVER AUDIT (Transact-SQL)](https://learn.microsoft.com/sql/t-sql/statements/create-server-audit-transact-sql?view=sql-server-ver17):\n\n```syntaxsql\n<predicate_expression> ::=\n    { [ NOT ] <predicate_factor>\n    [ { AND | OR } [ NOT ] { <predicate_factor> } ] [ ,... n ] }\n\n<predicate_factor> ::=\n    event_field_name { = | < > | != | > | >= | < | <= | LIKE }\n    { number | 'string' }\n```\n\nEvent field names correspond to the audit record columns documented in [sys.fn_get_audit_file (Transact-SQL)](https://learn.microsoft.com/sql/relational-databases/system-functions/sys-fn-get-audit-file-transact-sql?view=sql-server-ver17&tabs=sqlserver). All documented fields can be used except `file_name`, `audit_file_offset`, and `event_time`. Although `action_id` and `class_type` are returned as strings, they can only be compared with numeric values in a predicate. String comparisons don't perform implicit type conversion. The maximum expression length is 3,000 characters. An empty string means that no predicate is applied.",
+                    "type": "string",
+                    "maxLength": 3000,
+                    "readOnly": true
                 }
             }
         },
@@ -1161,6 +1175,12 @@
                     "description": "Retention days.",
                     "type": "integer",
                     "default": 0
+                },
+                "predicateExpression": {
+                    "description": "The predicate expression that determines whether an audit event is processed. Specify only the `<predicate_expression>` value; don't include the `WHERE` keyword. The expression uses the following syntax from [CREATE SERVER AUDIT (Transact-SQL)](https://learn.microsoft.com/sql/t-sql/statements/create-server-audit-transact-sql?view=sql-server-ver17):\n\n```syntaxsql\n<predicate_expression> ::=\n    { [ NOT ] <predicate_factor>\n    [ { AND | OR } [ NOT ] { <predicate_factor> } ] [ ,... n ] }\n\n<predicate_factor> ::=\n    event_field_name { = | < > | != | > | >= | < | <= | LIKE }\n    { number | 'string' }\n```\n\nEvent field names correspond to the audit record columns documented in [sys.fn_get_audit_file (Transact-SQL)](https://learn.microsoft.com/sql/relational-databases/system-functions/sys-fn-get-audit-file-transact-sql?view=sql-server-ver17&tabs=sqlserver). All documented fields can be used except `file_name`, `audit_file_offset`, and `event_time`. Although `action_id` and `class_type` are returned as strings, they can only be compared with numeric values in a predicate. String comparisons don't perform implicit type conversion. The maximum expression length is 3,000 characters. When SQL auditing is enabled for the first time, omitting this property applies no predicate. On subsequent updates, omitting this property leaves the existing predicate unchanged. Specify an empty string to remove the existing predicate.",
+                    "type": "string",
+                    "maxLength": 3000,
+                    "readOnly": false
                 }
             }
         },
@@ -1233,6 +1253,63 @@
                     }
                 ]
             }
+        },
+        "ErrorParameter": {
+            "description": "A structured parameter providing additional machine-readable context about an error.",
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "The parameter identifier.",
+                    "readOnly": true
+                },
+                "value": {
+                    "type": "string",
+                    "description": "The parameter value.",
+                    "readOnly": true
+                },
+                "message": {
+                    "type": "string",
+                    "description": "A human-readable description of the parameter's meaning.",
+                    "readOnly": true
+                }
+            }
+        },
+        "ItemOptionsByLogicalIdEntry": {
+            "description": "A per-item options entry that targets its item by logical ID. Each targeted item may appear at most once.",
+            "type": "object",
+            "required": ["logicalId", "options"],
+            "properties": {
+                "logicalId": {
+                    "type": "string",
+                    "format": "uuid",
+                    "description": "The logical ID of the target item.",
+                    "readOnly": false
+                },
+                "options": {
+                    "description": "The options for the targeted item. Property names are option names valid for the item type; values are the option values. For the options supported by a specific item type, see that item type's `Update-Definition` API documentation.",
+                    "type": "object",
+                    "readOnly": false
+                }
+            }
+        },
+        "ItemOptionsBySourceItemIdEntry": {
+            "description": "A per-item options entry that targets its item by source item ID. Each targeted item may appear at most once.",
+            "type": "object",
+            "required": ["sourceItemId", "options"],
+            "properties": {
+                "sourceItemId": {
+                    "type": "string",
+                    "format": "uuid",
+                    "description": "The source item ID of the target item.",
+                    "readOnly": false
+                },
+                "options": {
+                    "description": "The options for the targeted item. Property names are option names valid for the item type; values are the option values. For the options supported by a specific item type, see that item type's `Update-Definition` API documentation.",
+                    "type": "object",
+                    "readOnly": false
+                }
+            }
         }
     }
 }

platform/definitions/deploymentPipelines.json

@@ -696,6 +696,14 @@
                     "type": "boolean",
                     "description": "Indicates whether cross region deployment is enabled. True - enabled, False - disabled. Default value is false.",
                     "readOnly": false
+                },
+                "itemOptionsBySourceItemId": {
+                    "description": "Per-item deployment options. Each entry targets its item by source item ID and applies its options to that item.",
+                    "type": "array",
+                    "items": {
+                        "$ref": "../../common/definitions.json#/definitions/ItemOptionsBySourceItemIdEntry"
+                    },
+                    "readOnly": false
                 }
             }
         },

platform/definitions/gitIntegration.json

@@ -181,6 +181,14 @@
                 "allowOverrideItems": {
                     "type": "boolean",
                     "description": "User consent to override incoming items during the update from Git process.\nWhen incoming items are present and the allow override items is not specified or is provided as false, the update operation will not start.\nDefault value is false."
+                },
+                "itemOptionsByLogicalId": {
+                    "description": "Per-item update options. Each entry targets its item by logical ID and applies its options to that item.",
+                    "type": "array",
+                    "items": {
+                        "$ref": "../../common/definitions.json#/definitions/ItemOptionsByLogicalIdEntry"
+                    },
+                    "readOnly": false
                 }
             }
         },

platform/definitions/platform.json

@@ -741,6 +741,14 @@
                     "allowPairingByName": {
                         "type": "boolean",
                         "description": "Specifies how to handle an imported item without a Logical ID when an item with the same display name and item type already exists in the workspace.\n\nTrue – The imported item will be paired with the existing workspace item based on display name and type.\n\nFalse – Name-based pairing is disabled. If a workspace item with the same display name and type exists, the import fails due to a name duplication conflict.\n\nDefault value is false"
+                    },
+                    "itemOptionsByLogicalId": {
+                        "description": "Per-item options. Each entry targets its item by logical ID and applies its options to that item.",
+                        "type": "array",
+                        "items": {
+                            "$ref": "../../common/definitions.json#/definitions/ItemOptionsByLogicalIdEntry"
+                        },
+                        "readOnly": false
                     }
                 }
             }
@@ -927,6 +935,11 @@
           "description": "The sensitivity label settings for the item.",
           "$ref": "../../common/definitions.json#/definitions/SensitivityLabelSettings",
           "readOnly": false
+        },
+        "options": {
+          "description": "Options for the item being created. Only honored when a `definition` is also provided; supplying `options` without `definition` results in a `BadRequest` error. Property names are option names valid for the item type; values are the option values. For the options supported by a specific item type, see that item type's `Update-Definition` API documentation.",
+          "type": "object",
+          "readOnly": false
         }
       }
     },
@@ -936,6 +949,11 @@
       "properties": {
         "definition": {
           "$ref": "#/definitions/ItemDefinition"
+        },
+        "options": {
+          "description": "Options for the item whose definition is being updated. Property names are option names valid for the item type; values are the option values. For the options supported by a specific item type, see that item type's `Update-Definition` API documentation.",
+          "type": "object",
+          "readOnly": false
         }
       }
     },

platform/examples/deploymentPipelines/DeployWithOptions.json

@@ -0,0 +1,37 @@
+{
+    "parameters": {
+        "deploymentPipelineId": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
+        "deployRequest": {
+            "sourceStageId": "db1577e0-0132-4d6d-92b9-952c359988f2",
+            "targetStageId": "f1c39546-6282-4590-8af3-847a6226ad16",
+            "items": [
+                {
+                    "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
+                    "itemType": "Report"
+                }
+            ],
+            "note": "Deploying with options",
+            "options": {
+                "allowCrossRegionDeployment": false,
+                "itemOptionsBySourceItemId": [
+                    {
+                        "sourceItemId": "6bfe235c-6d7b-41b7-98a6-2b8276b3e82b",
+                        "options": {
+                            "validateOnly": true
+                        }
+                    }
+                ]
+            }
+        }
+    },
+    "responses": {
+        "202": {
+            "headers": {
+                "Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "deployment-id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
+                "Retry-After": 30
+            }
+        }
+    }
+}

platform/examples/gitIntegration/UpdateFromGitWithOptions.json

@@ -0,0 +1,35 @@
+{
+    "parameters": {
+        "workspaceId": "1565e6a3-c020-4c0c-dda7-92bafe99eec5",
+        "updateFromGitRequest": {
+            "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
+            "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
+            "conflictResolution": {
+                "conflictResolutionType": "Workspace",
+                "conflictResolutionPolicy": "PreferWorkspace"
+            },
+            "options": {
+                "allowOverrideItems": true,
+                "itemOptionsByLogicalId": [
+                    {
+                        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
+                        "options": {
+                            "validateOnly": true
+                        }
+                    }
+                ]
+            }
+        }
+    },
+    "responses": {
+        "200": {
+        },
+        "202": {
+            "headers": {
+                "Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "Retry-After": 30
+            }
+        }
+    }
+}

platform/examples/platform/BulkImportItemDefinitionsWithOptions.json

@@ -0,0 +1,40 @@
+{
+    "parameters": {
+        "workspaceId": "24d305d1-9db8-4785-b038-714e07e7394f",
+        "beta": true,
+        "bulkImportItemDefinitionsRequest": {
+            "definitionParts": [
+                {
+                    "path": "/Folder1/MyReport.Report/.platform",
+                    "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIlJlcG9ydCIsCiAgICAiZGlzcGxheU5hbWUiOiAiTXlSZXBvcnQiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiODg0MzZlNjUtNmVkMS04MTg1LTQ5ZmYtZjYxMDc3ZmM3M2Q0IgogIH0KfQ==",
+                    "payloadType": "InlineBase64"
+                },
+                {
+                    "path": "/Folder1/MyReport.Report/definition.pbir",
+                    "payload": "QmFzZTY0U3RyaW5n",
+                    "payloadType": "InlineBase64"
+                }
+            ],
+            "options": {
+                "allowPairingByName": true,
+                "itemOptionsByLogicalId": [
+                    {
+                        "logicalId": "88436e65-6ed1-8185-49ff-f61077fc73d4",
+                        "options": {
+                            "validateOnly": true
+                        }
+                    }
+                ]
+            }
+        }
+    },
+    "responses": {
+        "202": {
+            "headers": {
+                "Location": "https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "x-ms-operation-id": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
+                "Retry-After": 30
+            }
+        }
+    }
+}

platform/swagger.json

@@ -1466,6 +1466,9 @@
         "x-ms-examples": {
           "Bulk import item definitions example": {
             "$ref": "./examples/platform/BulkImportItemDefinitions.json"
+          },
+          "Bulk import item definitions with options example": {
+            "$ref": "./examples/platform/BulkImportItemDefinitionsWithOptions.json"
           }
         }
       }
@@ -2773,6 +2776,9 @@
         "x-ms-examples": {
           "Update a workspace using data from a Git example": {
             "$ref": "./examples/gitIntegration/UpdateFromGit.json"
+          },
+          "Update a workspace from Git with options example": {
+            "$ref": "./examples/gitIntegration/UpdateFromGitWithOptions.json"
           }
         }
       }
@@ -5823,6 +5829,9 @@
           },
           "Example of deploying all Fabric items (such as reports or dashboards) from a deployment pipeline stage": {
             "$ref": "./examples/deploymentPipelines/DeployAll.json"
+          },
+          "Example of deploying with options": {
+            "$ref": "./examples/deploymentPipelines/DeployWithOptions.json"
           }
         }
       }

semanticModel/definitions.json

@@ -88,6 +88,11 @@
           "properties": {
               "definition": {
                   "$ref": "#/definitions/SemanticModelDefinition"
+              },
+              "options": {
+                  "description": "Options for the semantic model whose definition is being updated.",
+                  "$ref": "#/definitions/SemanticModelDefinitionOptions",
+                  "readOnly": false
               }
           }
       },
@@ -142,6 +147,17 @@
               }
           }
       },
+      "SemanticModelDefinitionOptions": {
+          "description": "Options that apply when creating a semantic model with a definition or updating a semantic model's definition.",
+          "type": "object",
+          "properties": {
+              "allowPurgeData": {
+                  "description": "Whether to allow purging the semantic model's existing data when applying the updated definition. Some definition changes require existing data to be cleared; set this to true to allow those changes to proceed, in which case any data that can't be retained under the new definition is purged. After the operation completes, refresh the semantic model to reload the data. Default value is false.",
+                  "type": "boolean",
+                  "readOnly": false
+              }
+          }
+      },
       "BindSemanticModelConnectionRequest": {
           "description": "The payload of a bindConnection request to bind a data source reference of a semantic model to a data connection.",
           "required": ["connectionBinding"],

sqlEndpoint/definitions.json

@@ -39,7 +39,7 @@
       "description": "The request payload for refreshing a SQL analytics endpoint.",
       "properties": {
         "timeout": {
-          "description": "The request duration before timing out. The default value is 15 minutes.",
+          "description": "The amount of time the request can run before timing out. Defaults to 15 minutes, with a maximum of 24 hours.",
           "$ref": "../common/definitions.json#/definitions/Duration"
         },
         "recreateTables": {

sqlEndpoint/examples/GetSqlAuditSettings.json

@@ -10,7 +10,8 @@
         "retentionDays": 10,
         "auditActionsAndGroups": [
           "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
-        ]
+        ],
+        "predicateExpression": "NOT statement LIKE 'SELECT %'"
       }
     }
   }

sqlEndpoint/examples/UpdateSqlAuditSettings.json

@@ -4,16 +4,20 @@
     "itemId": "70bcc992-a346-4f21-afe5-8b9ed1596a2b",
     "updateAuditSettingsRequest": {
       "state": "Enabled",
-      "retentionDays": 10
+      "retentionDays": 10,
+      "predicateExpression": "NOT statement LIKE 'SELECT %'"
     }
   },
   "responses": {
     "200": {
-      "state": "Enabled",
+      "body": {
-      "retentionDays": 10,
+        "state": "Enabled",
-      "auditActionsAndGroups": [
+        "retentionDays": 10,
-        "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
+        "auditActionsAndGroups": [
-      ]
+          "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
+        ],
+        "predicateExpression": "NOT statement LIKE 'SELECT %'"
+      }
     }
   }
 }

warehouse/examples/GetSqlAuditSettings.json

@@ -10,7 +10,8 @@
         "retentionDays": 10,
         "auditActionsAndGroups": [
           "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
-        ]
+        ],
+        "predicateExpression": "NOT statement LIKE 'SELECT %'"
       }
     }
   }

warehouse/examples/UpdateSqlAuditSettings.json

@@ -4,7 +4,8 @@
     "itemId": "70bcc992-a346-4f21-afe5-8b9ed1596a2b",
     "updateAuditSettingsRequest": {
       "state": "Enabled",
-      "retentionDays": 10
+      "retentionDays": 10,
+      "predicateExpression": "NOT statement LIKE 'SELECT %'"
     }
   },
   "responses": {
@@ -14,7 +15,8 @@
         "retentionDays": 10,
         "auditActionsAndGroups": [
           "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP"
-        ]
+        ],
+        "predicateExpression": "NOT statement LIKE 'SELECT %'"
       }
     }
   }