PurviewGlossaries.ImportGlossaryTermsViaCsvByGlossaryNameAsync Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Catalog

Assembly:: Azure.Analytics.Purview.Catalog.dll

Package:: Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:: PurviewGlossaries.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Import Glossary Terms from local csv file by glossaryName.

public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> ImportGlossaryTermsViaCsvByGlossaryNameAsync (Azure.WaitUntil waitUntil, string glossaryName, Azure.Core.RequestContent content, bool? includeTermHierarchy = default, Azure.RequestContext context = default);

abstract member ImportGlossaryTermsViaCsvByGlossaryNameAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.ImportGlossaryTermsViaCsvByGlossaryNameAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>

Public Overridable Function ImportGlossaryTermsViaCsvByGlossaryNameAsync (waitUntil As WaitUntil, glossaryName As String, content As RequestContent, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

glossaryName: String

The name of the glossary.

content: RequestContent

The content to send as the body of the request.

includeTermHierarchy: Nullable<Boolean>

Whether include term hierarchy.

context: RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Task<Operation<BinaryData>>

Exceptions

ArgumentNullException

glossaryName or content is null.

ArgumentException

glossaryName is an empty string, and was expected to be non-empty.

Remarks

Schema for Response Body:

{
              id: string,
              status: "NotStarted" | "Succeeded" | "Failed" | "Running",
              createTime: string,
              lastUpdateTime: string,
              properties: {
                importedTerms: string,
                totalTermsDetected: string
              },
              error: {
                errorCode: number,
                errorMessage: string
              }
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }

Applies to

Dela via