mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
Updating swagger files.
This commit is contained in:
1 parent
7d78f6975d
commit
a5d166d117
3 files changed
+21
-14
No files matched your search
@@ -1408,6 +1408,13 @@
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "withAssignedWorkspacesOnly",
|
||||
"description": "When true, only return domains that have at least one workspace assigned to them, or to any of their subdomains. Default: false.",
|
||||
"type": "boolean",
|
||||
"required": false
|
||||
},
|
||||
{
|
||||
"name": "preview",
|
||||
"in": "query",
|
||||
|
||||
+7
-7
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/orgApps": {
|
||||
"get": {
|
||||
"summary": "Returns a list of OrgApps from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -91,7 +91,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an OrgApp in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgApp with a public definition, refer to [OrgApp](/rest/api/fabric/articles/item-management/definitions/orgapp-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgApp, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgApp with a public definition, refer to [OrgApp](/rest/api/fabric/articles/item-management/definitions/orgapp-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgApp, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -180,7 +180,7 @@
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -241,7 +241,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgApp.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgApp.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -314,7 +314,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified OrgApp.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -374,7 +374,7 @@
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified OrgApp public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgApp's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgApp's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -463,7 +463,7 @@
|
||||
"/workspaces/{workspaceId}/orgApps/{orgAppId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified OrgApp.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgApp's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgApp's definition does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgApp. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"/workspaces/{workspaceId}/orgAppAudiences": {
|
||||
"get": {
|
||||
"summary": "Returns a list of OrgAppAudiences from the specified workspace.",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -91,7 +91,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates an OrgAppAudience in the specified workspace.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgAppAudience with a public definition, refer to [OrgAppAudience](/rest/api/fabric/articles/item-management/definitions/orgappaudience-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgAppAudience, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types). \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an OrgAppAudience with a public definition, refer to [OrgAppAudience](/rest/api/fabric/articles/item-management/definitions/orgappaudience-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an OrgAppAudience, the user must have the appropriate license. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types). \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -180,7 +180,7 @@
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}": {
|
||||
"get": {
|
||||
"summary": "Returns properties of the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -241,7 +241,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Updates the properties of the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience.\n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -314,7 +314,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes the specified OrgAppAudience.",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "## Permissions\n\n The caller must have *write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -374,7 +374,7 @@
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}/getDefinition": {
|
||||
"post": {
|
||||
"summary": "Returns the specified OrgAppAudience public definition.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgAppAudience's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get an OrgAppAudience's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
@@ -463,7 +463,7 @@
|
||||
"/workspaces/{workspaceId}/orgAppAudiences/{orgAppAudienceId}/updateDefinition": {
|
||||
"post": {
|
||||
"summary": "Overrides the definition for the specified OrgAppAudience.",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgAppAudience's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
||||
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the OrgAppAudience's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the OrgAppAudience. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
||||
"tags": [
|
||||
"Items"
|
||||
],
|
||||
|
||||
Reference in new issue
Block a user