Partilhar via


@azure-rest/health-deidentification package

Interfaces

CancelJob
CancelJob200Headers
CancelJob200Response

O pedido foi bem-sucedido.

CancelJobDefaultHeaders
CancelJobDefaultResponse
CancelJobHeaderParam
CancelJobHeaders
DeidentificationClientOptions

Os parâmetros opcionais para o cliente

DeidentificationContent

Órgão solicitante para operação de desidentificação.

DeidentificationCustomizationOptions

Opções de personalização para substituir comportamentos de serviço padrão para uso síncrono.

DeidentificationDocumentDetailsOutput

Detalhes de um único documento em um trabalho.

DeidentificationDocumentLocationOutput

Localização de um documento.

DeidentificationJob

Um trabalho que contém um lote de documentos para desidentificar.

DeidentificationJobCustomizationOptions

Opções de personalização para substituir comportamentos de serviço padrão para uso de trabalho.

DeidentificationJobCustomizationOptionsOutput

Opções de personalização para substituir comportamentos de serviço padrão para uso de trabalho.

DeidentificationJobOutput

Um trabalho que contém um lote de documentos para desidentificar.

DeidentificationJobSummary

Métricas resumidas de um trabalho.

DeidentificationJobSummaryOutput

Métricas resumidas de um trabalho.

DeidentificationResultOutput

Organismo de resposta para a operação de desidentificação.

DeidentifyDocuments200Headers
DeidentifyDocuments200Response

O pedido foi bem-sucedido.

DeidentifyDocuments201Headers
DeidentifyDocuments201Response

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

DeidentifyDocumentsBodyParam
DeidentifyDocumentsDefaultHeaders
DeidentifyDocumentsDefaultResponse
DeidentifyDocumentsHeaderParam
DeidentifyDocumentsHeaders
DeidentifyDocumentsLogicalResponse

A resposta final para a operação de longa duração deidentifyDocuments

DeidentifyText
DeidentifyText200Headers
DeidentifyText200Response

O pedido foi bem-sucedido.

DeidentifyTextBodyParam
DeidentifyTextDefaultHeaders
DeidentifyTextDefaultResponse
DeidentifyTextHeaderParam
DeidentifyTextHeaders
DeleteJob204Headers
DeleteJob204Response

Não há conteúdo para enviar para esta solicitação, mas os cabeçalhos podem ser úteis.

DeleteJobDefaultHeaders
DeleteJobDefaultResponse
DeleteJobHeaderParam
DeleteJobHeaders
GetJob
GetJob200Headers
GetJob200Response

O pedido foi bem-sucedido.

GetJobDefaultHeaders
GetJobDefaultResponse
GetJobHeaderParam
GetJobHeaders
ListJobDocuments
ListJobDocuments200Headers
ListJobDocuments200Response

O pedido foi bem-sucedido.

ListJobDocumentsDefaultHeaders
ListJobDocumentsDefaultResponse
ListJobDocumentsHeaderParam
ListJobDocumentsHeaders
ListJobDocumentsQueryParam
ListJobDocumentsQueryParamProperties
ListJobs
ListJobs200Headers
ListJobs200Response

O pedido foi bem-sucedido.

ListJobsDefaultHeaders
ListJobsDefaultResponse
ListJobsHeaderParam
ListJobsHeaders
ListJobsQueryParam
ListJobsQueryParamProperties
PageSettings

Uma interface que rastreia as configurações para iteração paginada

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

PagedDeidentificationDocumentDetailsOutput

Coleção paginada de itens DeidentificationDocumentDetails

PagedDeidentificationJobOutput

Coleção paginada de itens DeidentificationJob

PagingOptions

Opções para o auxiliar de paginação

PhiEntityOutput

Tag PHI Entity na entrada.

PhiTaggerResultOutput

Resultado da operação "Tag".

Routes
SimplePollerLike

Um poller simples que pode ser usado para sondar uma operação de longa duração.

SourceStorageLocation

Local de armazenamento.

SourceStorageLocationOutput

Local de armazenamento.

StringIndexOutput

Modelo de codificação de índice de cadeia de caracteres.

TargetStorageLocation

Local de armazenamento.

TargetStorageLocationOutput

Local de armazenamento.

Aliases de Tipo

CancelJobParameters
DeidentificationClient
DeidentificationOperationType

Alias para DeidentificationOperationType

DeidentificationOperationTypeOutput

Alias para DeidentificationOperationTypeOutput

DeidentifyDocumentsParameters
DeidentifyTextParameters
DeleteJobParameters
GetArrayType

Tipo auxiliar para extrair o tipo de uma matriz

GetJobParameters
GetPage

O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.

ListJobDocumentsParameters
ListJobsParameters
OperationState

Alias para OperationState

OperationStateOutput

Alias para OperationStateOutput

PaginateReturn

Tipo auxiliar para inferir o Tipo dos elementos paginados do tipo de resposta Esse tipo é gerado com base nas informações do swagger para x-ms-pageable, especificamente na propriedade itemName, que indica a propriedade da resposta onde os itens de página são encontrados. O valor predefinido é value. Este tipo nos permitirá fornecer Iterator fortemente tipado com base na resposta que obtemos como segundo parâmetro

PhiCategoryOutput

Alias para PhiCategoryOutput

Funções

default(string, TokenCredential, DeidentificationClientOptions)

Inicializar uma nova instância do DeidentificationClient

getLongRunningPoller<TResult>(Client, DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.

isUnexpected(GetJob200Response | GetJobDefaultResponse)
isUnexpected(DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse)
isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)
isUnexpected(ListJobs200Response | ListJobsDefaultResponse)
isUnexpected(ListJobDocuments200Response | ListJobDocumentsDefaultResponse)
isUnexpected(CancelJob200Response | CancelJobDefaultResponse)
isUnexpected(DeidentifyText200Response | DeidentifyTextDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

Detalhes de Função

default(string, TokenCredential, DeidentificationClientOptions)

Inicializar uma nova instância do DeidentificationClient

function default(endpointParam: string, credentials: TokenCredential, options?: DeidentificationClientOptions): DeidentificationClient

Parâmetros

endpointParam

string

URL do seu Serviço de Desidentificação.

credentials
TokenCredential

identificar exclusivamente a credencial do cliente

options
DeidentificationClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

getLongRunningPoller<TResult>(Client, DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de longa duração.

function getLongRunningPoller<TResult>(client: Client, initialResponse: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parâmetros

client
Client

Cliente a utilizar para enviar o pedido para obter páginas adicionais.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opções para definir um estado de retomada ou intervalo de sondagem personalizado.

Devoluções

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Um poller se opõe a pesquisar atualizações de estado da operação e, eventualmente, obter a resposta final.

isUnexpected(GetJob200Response | GetJobDefaultResponse)

function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse)

function isUnexpected(response: DeidentifyDocuments200Response | DeidentifyDocuments201Response | DeidentifyDocumentsDefaultResponse | DeidentifyDocumentsLogicalResponse): response

Parâmetros

Devoluções

response

isUnexpected(DeleteJob204Response | DeleteJobDefaultResponse)

function isUnexpected(response: DeleteJob204Response | DeleteJobDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListJobs200Response | ListJobsDefaultResponse)

function isUnexpected(response: ListJobs200Response | ListJobsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListJobDocuments200Response | ListJobDocumentsDefaultResponse)

function isUnexpected(response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(CancelJob200Response | CancelJobDefaultResponse)

function isUnexpected(response: CancelJob200Response | CancelJobDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(DeidentifyText200Response | DeidentifyTextDefaultResponse)

function isUnexpected(response: DeidentifyText200Response | DeidentifyTextDefaultResponse): response

Parâmetros

Devoluções

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

O auxiliar para paginar resulta de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parâmetros

client
Client

Cliente a utilizar para enviar os pedidos da página seguinte

initialResponse

TResponse

Resposta inicial contendo o nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

  • PagedAsyncIterableIterator para iterar os elementos