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
256c720a1a
commit
75736fe7bf
4 files changed
+95
-3
No files matched your search
@@ -75,7 +75,7 @@
|
||||
"CredentialType": {
|
||||
"type": "string",
|
||||
"description": "The credential type of the connection. Additional credential types may be added over time.",
|
||||
"enum": ["Windows", "Anonymous", "Basic", "Key", "OAuth2", "WindowsWithoutImpersonation", "SharedAccessSignature", "ServicePrincipal", "WorkspaceIdentity"],
|
||||
"enum": ["Windows", "Anonymous", "Basic", "Key", "OAuth2", "WindowsWithoutImpersonation", "SharedAccessSignature", "ServicePrincipal", "WorkspaceIdentity", "KeyPair"],
|
||||
"x-ms-enum": {
|
||||
"name": "CredentialType",
|
||||
"modelAsString": true,
|
||||
@@ -115,6 +115,10 @@
|
||||
{
|
||||
"value": "WorkspaceIdentity",
|
||||
"description": "Connection uses workspace identity authentication to connect."
|
||||
},
|
||||
{
|
||||
"value": "KeyPair",
|
||||
"description": "Connection uses key pair authentication to connect."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -617,6 +621,31 @@
|
||||
},
|
||||
"x-ms-discriminator-value": "SharedAccessSignature"
|
||||
},
|
||||
"KeyPairCredentials": {
|
||||
"required": ["identifier", "privateKey"],
|
||||
"type": "object",
|
||||
"description": "Credentials for KeyPair CredentialType.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Credentials"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"identifier": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the key."
|
||||
},
|
||||
"privateKey": {
|
||||
"type": "string",
|
||||
"description": "The private key based on PKCS #8 standard."
|
||||
},
|
||||
"passphrase": {
|
||||
"type": "string",
|
||||
"description": "The passphrase for the private key if the private key is encrypted."
|
||||
}
|
||||
},
|
||||
"x-ms-discriminator-value": "KeyPair"
|
||||
},
|
||||
"CredentialDetails": {
|
||||
"type": "object",
|
||||
"description": "The base object of credential details.",
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
{
|
||||
"parameters": {
|
||||
"createConnectionRequest": {
|
||||
"connectivityType": "ShareableCloud",
|
||||
"displayName": "SnowflakeCloudConnection",
|
||||
"connectionDetails": {
|
||||
"type": "SQL",
|
||||
"creationMethod": "SQL",
|
||||
"parameters": [
|
||||
{
|
||||
"dataType": "Text",
|
||||
"name": "server",
|
||||
"value": "contoso.database.windows.net"
|
||||
},
|
||||
{
|
||||
"dataType": "Text",
|
||||
"name": "warehouse",
|
||||
"value": "snowflake-warehouse"
|
||||
}
|
||||
]
|
||||
},
|
||||
"privacyLevel": "Organizational",
|
||||
"credentialDetails": {
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "NotEncrypted",
|
||||
"skipTestConnection": false,
|
||||
"credentials": {
|
||||
"credentialType": "KeyPair",
|
||||
"identifier": "admin",
|
||||
"privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...\\n-----END ENCRYPTED PRIVATE KEY-----",
|
||||
"passphrase": "********"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"201": {
|
||||
"body": {
|
||||
"id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
|
||||
"displayName": "ContosoCloudConnection",
|
||||
"connectivityType": "ShareableCloud",
|
||||
"connectionDetails":{
|
||||
"type": "SQL",
|
||||
"path": "contoso.database.windows.net;snowflake-warehouse"
|
||||
},
|
||||
"privacyLevel": "Organizational",
|
||||
"credentialDetails": {
|
||||
"credentialType": "KeyPair",
|
||||
"singleSignOnType": "None",
|
||||
"connectionEncryption": "NotEncrypted",
|
||||
"skipTestConnection": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4987,7 +4987,7 @@
|
||||
"/workspaces/{workspaceId}/items/{itemId}/applyTags": {
|
||||
"post": {
|
||||
"summary": "Apply tags on an item.",
|
||||
"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 *contributor* or higher role on the workspace. \n\n## Required Delegated Scopes\n\n ItemMetadata.ReadWrite.All or these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n For more information about scopes, see [Scopes article](/rest/api/fabric/articles/scopes).\n\n## Limitations\n\nMaximum 25 requests per hour per principal.\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": "> [!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 *contributor* or higher role on the workspace. \n\n## Required Delegated Scopes\n\n ItemMetadata.ReadWrite.All or these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n For more information about scopes, see [Scopes article](/rest/api/fabric/articles/scopes).\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
|
||||
"Tags"
|
||||
],
|
||||
@@ -5043,7 +5043,7 @@
|
||||
"/workspaces/{workspaceId}/items/{itemId}/unapplyTags": {
|
||||
"post": {
|
||||
"summary": "Unapply tags from an item.",
|
||||
"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 *contributor* or higher role on the workspace. \n\n## Required Delegated Scopes\n\n ItemMetadata.ReadWrite.All or these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n For more information about scopes, see [Scopes article](/rest/api/fabric/articles/scopes).\n\n## Limitations\n\nMaximum 25 requests per hour per principal.\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": "> [!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 *contributor* or higher role on the workspace. \n\n## Required Delegated Scopes\n\n ItemMetadata.ReadWrite.All or these scope types: \n- Generic scope: Item.ReadWrite.All \n- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All) \n\n For more information about scopes, see [Scopes article](/rest/api/fabric/articles/scopes).\n\n## Limitations\n\nMaximum 25 requests per one minute per principal.\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": [
|
||||
"Tags"
|
||||
],
|
||||
@@ -5867,6 +5867,9 @@
|
||||
},
|
||||
"Cloud example": {
|
||||
"$ref": "./examples/connections/CreateCloudConnection.json"
|
||||
},
|
||||
"Cloud example with KeyPair credentials": {
|
||||
"$ref": "./examples/connections/CreateCloudConnectionWithKeyPair.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,6 +41,10 @@
|
||||
"timeout": {
|
||||
"description": "The request duration before timing out. The default value is 15 minutes.",
|
||||
"$ref": "../common/definitions.json#/definitions/Duration"
|
||||
},
|
||||
"recreateTables": {
|
||||
"description": "When set to true, this property instructs the system to drop and recreate all tables on SQL analytics endpoint during the refresh process. Use this option if you need to fully rebuild tables from their source definitions, for example to resolve inconsistencies or ensure a clean refresh. The default value is false.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Reference in new issue
Block a user