Azure.Search (preview:2025-08-01)

2025/08/29 • 5 updated methods

KnowledgeRetrieval_Retrieve (updated)
Description :  KnowledgeAgent retrieves relevant data from backing stores.
Reference :  Link ¶

⚶ Changes

{
  "#id": "KnowledgeRetrieval_Retrieve",
  "$parameters": {
    "retrievalRequest": {
      "$properties": {
        "knowledgeSourceParams": {
          "$properties": [
            {
              "#name": "kind",
              "Enum": {
                "new": [
                  [
                    "searchIndex",
                    "A knowledge source that reads data from a Search Index."
                  ],
                  [
                    "azureBlob",
                    "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
                  ]
                ],
                "old": [
                  [
                    "searchIndex",
                    "A knowledge source that reads data from a Search Index."
                  ],
                  [
                    "azureBlob",
                    "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
                  ],
                  [
                    "web",
                    "A knowledge source that reads data from the web."
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /retrieve
{
retrievalRequest:
{
Description: The retrieval request to process. ,
Required: True ,
}
{
messages:
{
Required: True ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
knowledgeSourceParams:
{
Required: False ,
}
[
{
knowledgeSourceName:
{
Description: The name of the index the params apply to. ,
Required: True ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-query-source-authorization:
{
Description: Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
response:
{
Required: False ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
activity:
{
Description: The activity records for tracking progress and billing implications. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the activity record. ,
Format: int32 ,
Required: True ,
}
integer ,
type:
{
Description: The type of the activity record. ,
Required: True ,
}
string ,
elapsedMs:
{
Description: The elapsed time in milliseconds for the retrieval activity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
references:
{
Description: The references for the retrieval data used in the response. ,
Required: False ,
}
[
{
type:
{
Description: The type of the reference. ,
Required: True ,
}
string ,
id:
{
Description: The ID of the reference. ,
Required: True ,
}
string ,
activitySource:
{
Description: The source activity ID for the reference. ,
Format: int32 ,
Required: True ,
}
integer ,
sourceData:
{
Required: False ,
}
object ,
rerankerScore:
{
Description: The reranker score for the document reference. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KnowledgeSources_CreateOrUpdate (updated)
Description :  Creates a new knowledge source or updates an knowledge source if it already exists.
Reference :  Link ¶

⚶ Changes

{
  "#id": "KnowledgeSources_CreateOrUpdate",
  "$parameters": {
    "KnowledgeSource": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /knowledgesources('{sourceName}')
{
sourceName:
{
Description: The name of the knowledge source to create or update. ,
Required: True ,
}
string ,
KnowledgeSource:
{
Description: The definition of the knowledge source to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KnowledgeSources_Get (updated)
Description :  Retrieves a knowledge source definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "KnowledgeSources_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /knowledgesources('{sourceName}')
{
sourceName:
{
Description: The name of the knowledge source to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KnowledgeSources_List (updated)
Description :  Lists all knowledge sources available for a search service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "KnowledgeSources_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "kind",
              "Enum": {
                "new": [
                  [
                    "searchIndex",
                    "A knowledge source that reads data from a Search Index."
                  ],
                  [
                    "azureBlob",
                    "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
                  ]
                ],
                "old": [
                  [
                    "searchIndex",
                    "A knowledge source that reads data from a Search Index."
                  ],
                  [
                    "azureBlob",
                    "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
                  ],
                  [
                    "web",
                    "A knowledge source that reads data from the web."
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /knowledgesources
{
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
KnowledgeSources_Create (updated)
Description :  Creates a new knowledge source.
Reference :  Link ¶

⚶ Changes

{
  "#id": "KnowledgeSources_Create",
  "$parameters": {
    "KnowledgeSource": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "201": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ]
            ],
            "old": [
              [
                "searchIndex",
                "A knowledge source that reads data from a Search Index."
              ],
              [
                "azureBlob",
                "A knowledge source that read and ingest data from Azure Blob Storage to a Search Index."
              ],
              [
                "web",
                "A knowledge source that reads data from the web."
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /knowledgesources
{
KnowledgeSource:
{
Description: The definition of the knowledge source to create. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}