diff --git a/graphQLApi/swagger.json b/graphQLApi/swagger.json index bcdc1a1..9f8771a 100644 --- a/graphQLApi/swagger.json +++ b/graphQLApi/swagger.json @@ -63,7 +63,7 @@ }, "post": { "summary": "Creates a API for GraphQL item in the specified workspace.", - "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create GraphQLApi item with a public definition, refer to [GraphQLApi definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a GraphQLApi the workspace must be on a supported Fabric capacity. 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, except for definition payload with SQL analytics endpoint |\n\n## Interface", + "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo create GraphQLApi item with a public definition, refer to [GraphQLApi definition](/rest/api/fabric/articles/item-management/definitions/graphql-api-definition).\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a GraphQLApi the workspace must be on a supported Fabric capacity. 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" ], @@ -369,8 +369,8 @@ }, "/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition": { "post": { - "summary": "Overrides the definition for the specified .", - "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the GraphQLApi's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi. \n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.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, except for definition payload with SQL analytics endpoint |\n\n## Interface", + "summary": "Overrides the definition for the specified API for GraphQL.", + "description": "\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the GraphQLApi's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the GraphQLApi. \n## Required Delegated Scopes\n\n GraphQLApi.ReadWrite.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" ], diff --git a/platform/swagger.json b/platform/swagger.json index 4fdefe8..22d8ce6 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -2376,56 +2376,66 @@ ], "x-ms-fabric-sdk-long-running-operation": true, "parameters": [ - { - "in": "path", - "name": "workspaceId", - "description": "The ID of the workspace.", - "type": "string", - "format": "uuid", - "required": true - }, - { - "in": "path", - "name": "itemId", - "description": "The ID of the data item.", - "type": "string", - "format": "uuid", - "required": true - }, - { - "in": "query", - "name": "shortcutConflictPolicy", - "description": "When provided, it defines the action to take when a shortcut with the same name and path already exists. The default action is 'Abort'. Additional ShortcutConflictPolicy types may be added over time.", - "type": "string", - "enum": [ - "Abort", - "GenerateUniqueName" - ], - "x-ms-enum": { - "name": "ShortcutConflictPolicy", - "modelAsString": true, - "values": [ - { - "value": "Abort", - "description": "When a shortcut with the same name and path already exists the shortcut creation is cancelled." + { + "in": "path", + "name": "workspaceId", + "description": "The ID of the workspace.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "itemId", + "description": "The ID of the data item.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "shortcutConflictPolicy", + "description": "When provided, it defines the action to take when a shortcut with the same name and path already exists. The default action is 'Abort'. Additional ShortcutConflictPolicy types may be added over time.", + "type": "string", + "enum": [ + "Abort", + "GenerateUniqueName", + "CreateOrOverwrite", + "OverwriteOnly" + ], + "x-ms-enum": { + "name": "ShortcutConflictPolicy", + "modelAsString": true, + "values": [ + { + "value": "Abort", + "description": "When a shortcut with the same name and path already exists the shortcut creation will be cancelled." + }, + { + "value": "GenerateUniqueName", + "description": "When a shortcut with the same name and path already exists the shortcut creation will continue with a new unique shortcut name." + }, + { + "value": "CreateOrOverwrite", + "description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut. Create shortcut if it does not exist." + }, + { + "value": "OverwriteOnly", + "description": "When a shortcut with the same name and path already exists the shortcut creation will overwrite the existing shortcut." + } + ] }, - { - "value": "GenerateUniqueName", - "description": "When a shortcut with the same name and path already exists, the shortcut is created with a new unique name." - } - ] + "required": false }, - "required": false - }, - { - "in": "body", - "name": "bulkCreateShortcutsRequest", - "description": "A shortcut bulk create request includes an array of shortcut objects, each representing a reference pointing to internal or external storage locations within OneLake.", - "schema": { - "$ref": "./definitions/platform.json#/definitions/BulkCreateShortcutsRequest" - }, - "required": true - } + { + "in": "body", + "name": "bulkCreateShortcutsRequest", + "description": "A shortcut bulk create request includes an array of shortcut objects, each representing a reference pointing to internal or external storage locations within OneLake.", + "schema": { + "$ref": "./definitions/platform.json#/definitions/BulkCreateShortcutsRequest" + }, + "required": true + } ], "responses": { "202": { @@ -6456,4 +6466,4 @@ "responses": {}, "security": [], "tags": [] -} \ No newline at end of file +} diff --git a/sqlEndpoint/definitions.json b/sqlEndpoint/definitions.json index 64bfa45..e71a486 100644 --- a/sqlEndpoint/definitions.json +++ b/sqlEndpoint/definitions.json @@ -124,6 +124,17 @@ } ] } + }, + "ConnectionStringResponse": { + "description": "The SQL connection string for the workspace containing this SQL endpoint.", + "type": "object", + "properties": { + "connectionString": { + "description": "The SQL connection string for the workspace containing this SQL endpoint.", + "type": "string", + "readOnly": false + } + } } } } diff --git a/sqlEndpoint/examples/GetConnectionString.json b/sqlEndpoint/examples/GetConnectionString.json new file mode 100644 index 0000000..9d6b918 --- /dev/null +++ b/sqlEndpoint/examples/GetConnectionString.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "sqlEndpointId": "5b218778-e7a5-4d73-8187-f10824047715", + "guestTenantId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765", + "privateLinkType": "Workspace" + }, + "responses": { + "200": { + "body": { + "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com" + } + } + } +} \ No newline at end of file diff --git a/sqlEndpoint/swagger.json b/sqlEndpoint/swagger.json index 5f8946a..6f15997 100644 --- a/sqlEndpoint/swagger.json +++ b/sqlEndpoint/swagger.json @@ -62,7 +62,7 @@ } } }, - "/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata": { + "/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata": { "post": { "summary": "Refreshes all tables within a SQL analytics endpoint.", "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\nItem.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", @@ -141,6 +141,89 @@ } } } + }, + "/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString": { + "get": { + "summary": "Returns the SQL connection string of the specified warehouse.", + "description": "## Permissions\n\n The caller must have *read* permissions for the warehouse. The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n SqlEndpoint.Read.All or SqlEndpoint.ReadWrite.All or 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" + ], + "operationId": "Items_GetConnectionString", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "sqlEndpointId", + "description": "The SQL endpoint ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "guestTenantId", + "description": "The guest tenant ID if the end user's tenant is different from the SQL endpoint's tenant.", + "type": "string", + "format": "uuid", + "required": false + }, + { + "in": "query", + "name": "privateLinkType", + "description": "Indicates the type of private link this connection string uses. Additional `privateLinkType` types may be added over time.", + "type": "string", + "enum": [ + "None", + "Workspace" + ], + "x-ms-enum": { + "name": "PrivateLinkType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No private link (default)." + }, + { + "value": "Workspace", + "description": "Workspace private Link." + } + ] + }, + "required": false + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/ConnectionStringResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidGuestTenantId - The provided ID does not exist.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection string example": { + "$ref": "./examples/GetConnectionString.json" + } + } + } } }, "responses": {}, diff --git a/warehouse/definitions.json b/warehouse/definitions.json index 36f55ec..039c6cc 100644 --- a/warehouse/definitions.json +++ b/warehouse/definitions.json @@ -199,6 +199,17 @@ "readOnly": false } } + }, + "ConnectionStringResponse": { + "description": "The SQL connection string for the workspace containing this warehouse.", + "type": "object", + "properties": { + "connectionString": { + "description": "The SQL connection string for the workspace containing this warehouse.", + "type": "string", + "readOnly": false + } + } } } } diff --git a/warehouse/examples/GetConnectionString.json b/warehouse/examples/GetConnectionString.json new file mode 100644 index 0000000..3e50302 --- /dev/null +++ b/warehouse/examples/GetConnectionString.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229", + "warehouseId": "5b218778-e7a5-4d73-8187-f10824047715", + "guestTenantId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765", + "privateLinkSetting": "Workspace" + }, + "responses": { + "200": { + "body": { + "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com" + } + } + } +} \ No newline at end of file diff --git a/warehouse/swagger.json b/warehouse/swagger.json index af4b69f..b377185 100644 --- a/warehouse/swagger.json +++ b/warehouse/swagger.json @@ -290,6 +290,89 @@ } } } + }, + "/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString": { + "get": { + "summary": "Returns the SQL connection string of the specified warehouse.", + "description": "## Permissions\n\n The caller must have *read* permissions for the warehouse. The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n Warehouse.Read.All or Warehouse.ReadWrite.All or 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" + ], + "operationId": "Items_GetConnectionString", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "path", + "name": "warehouseId", + "description": "The warehouse ID.", + "type": "string", + "format": "uuid", + "required": true + }, + { + "in": "query", + "name": "guestTenantId", + "description": "The guest tenant ID if the end user's tenant is different from the warehouse tenant.", + "type": "string", + "format": "uuid", + "required": false + }, + { + "in": "query", + "name": "privateLinkType", + "description": "Indicates the type of private link this connection string uses. Additional `privateLinkType` types may be added over time.", + "type": "string", + "enum": [ + "None", + "Workspace" + ], + "x-ms-enum": { + "name": "PrivateLinkType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No private link (default)." + }, + { + "value": "Workspace", + "description": "Workspace private Link." + } + ] + }, + "required": false + } + ], + "responses": { + "200": { + "description": "Request completed successfully.", + "schema": { + "$ref": "./definitions.json#/definitions/ConnectionStringResponse" + } + }, + "default": { + "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidGuestTenantId - The provided guest tenant ID does not exist.", + "schema": { + "$ref": "../common/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection string example": { + "$ref": "./examples/GetConnectionString.json" + } + } + } } }, "responses": {},