Updating swagger files.

This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2025-10-14 22:06:53 +00:00
1 parent a3bc880946
commit e644a91be6
4 files changed
+137 -6

No files matched your search

@@ -10,8 +10,7 @@
"description": "Create managed private endpoint request payload.",
"required": [
"name",
"targetPrivateLinkResourceId",
"targetSubresourceType"
"targetPrivateLinkResourceId"
],
"properties": {
"name": {
@@ -33,6 +32,14 @@
"description": "Message to approve private endpoint request. Should not be more than 140 characters.",
"type": "string",
"readOnly": false
},
"targetFQDNs": {
"description": "Fully qualified domain names (FQDNs) to be associated with the private endpoint. Should not be more than 20 FQDNs.",
"type": "array",
"items": {
"type": "string"
},
"readOnly": false
}
}
},
@@ -160,6 +167,24 @@
}
]
}
},
"ManagedPrivateEndpointTargetFQDNs":{
"required": ["value"],
"type": "object",
"properties": {
"value": {
"description": "A list of FQDNs in the managed private endpoints.",
"type": "array",
"items": {
"type": "string"
}
}
},
"allOf": [
{
"$ref": "../../common/definitions.json#/definitions/PaginatedResponse"
}
]
}
}
}
@@ -0,0 +1,27 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"createManagedPrivateEndpointRequest": {
"name": "testprivatendpoint2",
"targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Network/privatelinkservice/pls1",
"requestMessage": "Request message to approve private endpoint",
"targetFQDNs": [
"database1.cloudprovider.net",
"database2.cloudprovider.net"
]
}
},
"responses": {
"201": {
"body": {
"id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
"name": "testprivateendpoint2",
"targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Network/privatelinkservice/pls1",
"provisioningState": "Provisioning"
},
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3"
}
}
}
}
@@ -0,0 +1,16 @@
{
"parameters": {
"workspaceId": "47482db6-4583-4672-86dd-999d0f8f4d7a",
"managedPrivateEndpointId": "59a92b06-6e5a-468c-b748-e28c8ff28da3"
},
"responses": {
"200": {
"body": {
"value": [
"database1.cloudprovider.net",
"database2.cloudprovider.net"
]
}
}
}
}
+67 -4
View File
@@ -5500,7 +5500,7 @@
"/workspaces/{workspaceId}/managedPrivateEndpoints": {
"get": {
"summary": "Returns a list of managed private endpoints associated with the specified workspace.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\n The caller must have *viewer* or higher 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",
"description": "## Permissions\n\n The caller must have *viewer* or higher 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": [
"ManagedPrivateEndpoints"
],
@@ -5553,7 +5553,7 @@
},
"post": {
"summary": "Creates a managed private endpoint in the specified workspace.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint 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",
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.ReadWrite.All.\n\n## Limitations \n- To create managed private endpoint 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": [
"ManagedPrivateEndpoints"
],
@@ -5606,6 +5606,9 @@
"x-ms-examples": {
"Create a managed private endpoint example": {
"$ref": "./examples/managedPrivateEndpoint/CreateManagedPrivateEndpoint.json"
},
"Create a managed private endpont with FQDNs example": {
"$ref": "./examples/managedPrivateEndpoint/CreateManagedPrivateEndpointWithFQDNs.json"
}
}
}
@@ -5613,7 +5616,7 @@
"/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}": {
"delete": {
"summary": "Deletes the specified managed private endpoint.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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",
"description": "## Permissions\n\nThe caller must have *admin* workspace role.\n\n## Required Delegated Scopes \n\nWorkspace.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": [
"ManagedPrivateEndpoints"
],
@@ -5658,7 +5661,7 @@
},
"get": {
"summary": "Gets the specified managed private endpoint.",
"description": "> [!NOTE]\n> This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\n## Permissions\n\nThe caller must have *viewer* or higher 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",
"description": "## Permissions\n\nThe caller must have *viewer* or higher 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": [
"ManagedPrivateEndpoints"
],
@@ -7018,6 +7021,66 @@
}
}
}
},
"/workspaces/{workspaceId}/managedPrivateEndpoints/{managedPrivateEndpointId}/targetFQDNs": {
"get": {
"summary": "Returns a list of fully qualified domain names (FQDNs) associated with the specified managed private endpoint.",
"description": "## Permissions\n\n The caller must have *viewer* or higher 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": [
"ManagedPrivateEndpoints"
],
"operationId": "ManagedPrivateEndpoints_ListFQDNs",
"x-ms-pageable": {
"nextLinkName": "continuationUri"
},
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "managedPrivateEndpointId",
"description": "The managed private endpoint ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "continuationToken",
"description": "A token for retrieving the next page of results.",
"type": "string",
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully.",
"schema": {
"$ref": "./definitions/managedPrivateEndpoint.json#/definitions/ManagedPrivateEndpointTargetFQDNs"
}
},
"default": {
"description": "Common error codes:\n\n* UnknownError - An error occurred.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List managed private endpoints in workspace example": {
"$ref": "./examples/managedPrivateEndpoint/ListFQDNsInManagedPrivateEndpoint.json"
}
}
}
}
},
"responses": {},