CosmosDbKeyEscape.EscapeKey 方法

定義

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

EscapeKey(String)	將金鑰轉換成可安全地搭配 Cosmos DB 使用的 DocumentID。下列字元受到限制，無法用於 Id 屬性：'/'、''、'？' 和 '#'。如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.documents.resource.id?view=azure-dotnet 。
EscapeKey(String, String, Boolean)	將金鑰轉換成可安全地搭配 Cosmos DB 使用的 DocumentID。下列字元受到限制，無法用於 Id 屬性：'/'、''、'？' 和 '#'。如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.documents.resource.id?view=azure-dotnet 。

將金鑰轉換成可安全地搭配 Cosmos DB 使用的 DocumentID。下列字元受到限制，無法用於 Id 屬性：'/'、''、'？' 和 '#'。如需詳細資訊，請參閱 https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.documents.resource.id?view=azure-dotnet 。

public static string EscapeKey (string key);

static member EscapeKey : string -> string

Public Shared Function EscapeKey (key As String) As String

要逸出的索引鍵。

String

可以安全地搭配 CosmosDB 使用的逸出金鑰。

public static string EscapeKey (string key, string suffix, bool compatibilityMode);

static member EscapeKey : string * string * bool -> string

Public Shared Function EscapeKey (key As String, suffix As String, compatibilityMode As Boolean) As String

要逸出的索引鍵。

要加入于所有資料列索引鍵結尾的字串。

True 是表示如果應該截斷以相容性模式和金鑰執行，以支援先前的 CosmosDb 金鑰長度上限為 255。您可以將設定 CompatibilityMode 為 false 來覆寫此行為。

String

可以安全地搭配 CosmosDB 使用的逸出金鑰。