@azure/arm-selfhelp package

Classes

HelpRP

Interfaces

AutomatedCheckResult

Somente para o tipo AutomatedStep

CheckNameAvailabilityCheckAvailabilityOptionalParams

Parâmetros opcionais.

CheckNameAvailabilityOperations

Interface representando uma operação CheckNameAvailability.

CheckNameAvailabilityRequest

O corpo da solicitação de disponibilidade de verificação.

CheckNameAvailabilityResponse

Resposta para saber se o nome do recurso solicitado está disponível ou não.

ClassificationService

Objeto de resultado de Classificação de Serviço.

ContinueRequestBody

Corpo continueRequest da solução de problemas.

Diagnostic

Propriedades retornadas com em um insight.

DiagnosticInvocation

Invocação de solução com parâmetros adicionais necessários para invocação.

DiagnosticResource

Recurso de diagnóstico

DiagnosticResourceProperties

Propriedades de recursos diagnósticos.

DiagnosticsCreateOptionalParams

Parâmetros opcionais.

DiagnosticsGetOptionalParams

Parâmetros opcionais.

DiagnosticsOperations

Interface que representa uma operação de diagnóstico.

DiscoveryNlpRequest

Descubra a solicitação NLP.

DiscoveryNlpResponse

Lista buscada com êxito de metadados da solução.

DiscoverySolutionListOptionalParams

Parâmetros opcionais.

DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams

Parâmetros opcionais.

DiscoverySolutionNLPDiscoverSolutionsOptionalParams

Parâmetros opcionais.

DiscoverySolutionNLPOperations

Interface representando operações DiscoverySolutionNLP.

DiscoverySolutionOperations

Interface representando operações do DiscoverySolution.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorModel

Definição de erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha.

ExtensionResource

O recurso de extensão base.

Filter

Critério de filtro

FilterGroup

Grupo de filtros

HelpRPOptionalParams

Parâmetros opcionais para o cliente.

Insight

Insights detalhados obtidos por meio da invocação de um diagnóstico de insight

MetricsBasedChart

Gráfico baseado em métricas de soluções

NlpSolutions

Metadados de NPL.

Operation

Detalhes de uma operação de API REST, retornada da API de Operações do Provedor de Recursos

OperationDisplay

Informações localizadas de exibição para uma operação.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface representando uma operação de operações.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

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

ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

ReplacementMaps

Mapas de substituição de solução.

ReplacementMapsSelfHelp

Mapas de substituição de solução.

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

ResponseOption

O status do recurso.

ResponseValidationProperties

Propriedades de validação de resposta de entrada da etapa da solução de problemas

RestartTroubleshooterResponse

Resposta de reinicialização da solução de problemas

RestorePollerOptions
SearchResult

Detalhes de um resultado de pesquisa do AzureKB.

Section

Parte da solução e são divisores na renderização da solução.

SectionSelfHelp

Parte da solução e são divisores na renderização da solução.

SimplePollerLike

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

SimplifiedSolutionsCreateOptionalParams

Parâmetros opcionais.

SimplifiedSolutionsGetOptionalParams

Parâmetros opcionais.

SimplifiedSolutionsOperations

Interface representando uma operação SimplifiedSolutions.

SimplifiedSolutionsResource

Resposta simplificada de Soluções.

SimplifiedSolutionsResourceProperties

Resultado de Soluções Simplificadas

SolutionCreateOptionalParams

Parâmetros opcionais.

SolutionGetOptionalParams

Parâmetros opcionais.

SolutionMetadataProperties

Propriedades de metadados

SolutionMetadataResource

Recurso de metadados

SolutionNlpMetadataResource

Recurso de metadados nlp

SolutionOperations

Interface representando operações de solução.

SolutionPatchRequestBody

Corpo patchRequest da solução

SolutionResource

Resposta da solução.

SolutionResourceProperties

Resultado da solução

SolutionResourceSelfHelp

Resposta da solução de autoajuda.

SolutionSelfHelpGetOptionalParams

Parâmetros opcionais.

SolutionSelfHelpOperations

Interface representando uma operação de SolutionSelfHelp.

SolutionUpdateOptionalParams

Parâmetros opcionais.

SolutionWarmUpOptionalParams

Parâmetros opcionais.

SolutionWarmUpRequestBody

Corpo warmUpRequest da solução

Solutions

Lista de soluções

SolutionsDiagnostic

Diagnóstico de soluções

SolutionsResourcePropertiesSelfHelp

Resultado da solução

SolutionsTroubleshooters

Solucionadores de problemas em soluções

Step

Etapa da solução de problemas

StepInput

Detalhes da entrada da etapa.

SystemData

Metadados relativos à criação e última modificação do recurso.

TriggerCriterion

Critério de gatilho de solicitação de solução. SolutionId/ProblemClassificationId é o único tipo de gatilho com suporte para a solicitação PUT da solução. ReplacementKey é o único tipo de gatilho com suporte para a solicitação patch da solução.

TroubleshooterInstanceProperties

Propriedades da instância da solução de problemas.

TroubleshooterResource

Resposta da solução de problemas.

TroubleshooterResponse

Resposta do usuário para a solicitação de continuação da solução de problemas

TroubleshootersContinueOptionalParams

Parâmetros opcionais.

TroubleshootersCreateOptionalParams

Parâmetros opcionais.

TroubleshootersEndOptionalParams

Parâmetros opcionais.

TroubleshootersGetOptionalParams

Parâmetros opcionais.

TroubleshootersOperations

Interface representando as operações de um Solucionador de Problemas.

TroubleshootersRestartOptionalParams

Parâmetros opcionais.

Video

Detalhes do vídeo

VideoGroup

Detalhes do grupo de vídeo

VideoGroupVideo

Detalhes do vídeo do VideoGroup

WebResult

Resultado da Web do AzureKB

Aliases de tipo

ActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownActionType pode ser usado de forma intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Interno: as ações são para APIs somente internas.

AggregationType

Os valores permitidos são Sum, Avg, Count, Min, Max. Padrão é Soma.
KnownAggregationType pode ser usado de forma intercambiável com AggregationType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Sum
Avg
Count
Minuto
Max

AutomatedCheckResultType

Tipo de resultado.
KnownAutomatedCheckResultType pode ser usado de forma intercambiável com AutomatedCheckResultType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Êxito
Aviso
Erro
Informações

AzureSupportedClouds

Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres

Confidence

Confiança do resultado da pesquisa.
KnownConfidence pode ser usado de forma intercambiável com Confidence, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Baixo
Médio
Alto

ContinuablePage

Uma interface que descreve uma página de resultados.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Usuário: a entidade foi criada por um usuário.
Aplicativo: A entidade foi criada por um aplicativo.
ManagedIdentity: a entidade foi criada por uma identidade gerenciada.
Chave: A entidade foi criada por uma chave.

DiagnosticProvisioningState

Status do provisionamento de diagnóstico.
KnownDiagnosticProvisioningState pode ser usado de forma intercambiável com DiagnosticProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

bem-sucedido: todos os diagnósticos no Lote foram bem-sucedidos.
PartialComplete: alguns diagnósticos ainda estão em execução ou falha.
falha no: todos os diagnósticos não foram executados.
Em execução: todos os diagnósticos ainda estão em execução.
Cancelado: quando a solicitação de diagnóstico é cancelada.

ExecutionStatus

Status da execução da etapa da solução de problemas.
KnownExecutionStatus pode ser usado de forma intercambiável com ExecutionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Sucesso: a execução da etapa foi bem-sucedida.
Executando: Execução de etapa em execução
Falha: Falha na execução da etapa
Aviso: Aviso de execução de etapa

ImportanceLevel

Nível de importância do insight.
KnownImportanceLevel pode ser usado de forma intercambiável com ImportanceLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Crítico: uma visão crítica foi encontrada após a execução do diagnóstico.
Aviso: um insight de aviso foi encontrado após a execução do diagnóstico.
Information: um insight de informações foi encontrado após a execução do diagnóstico.

Name

Nome do critério de gatilho.
KnownName pode ser usado de forma intercambiável com Name, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

ID da solução
ProblemaClassificaçãoId
Chave de substituição

Origin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

usuário: indica que a operação é iniciada por um usuário.
sistema: indica que a operação é iniciada por um sistema.
usuário,do sistema: indica que a operação é iniciada por um usuário ou sistema.

QuestionContentType

O padrão é Texto.
KnownQuestionContentType pode ser usado de forma intercambiável com QuestionContentType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Texto
Html
Markdown

QuestionType

Tipo de Pergunta
KnownQuestionType pode ser usado de forma intercambiável com QuestionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

RadioButton: botão de opção SingleChoice
Lista suspensa: lista suspensa SingleChoice.
TextInput: Entrada de texto
MultiLineInfoBox: MultiLineInfoBox
DateTimePicker: Seletor de data e hora
Seleção múltipla: Seleção múltipla

ResultType

Tipo de resultado do resultado da pesquisa.
KnownResultType pode ser usado de forma intercambiável com ResultType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Comunidade
Documentação

SolutionProvisioningState

Status do provisionamento de solução.
KnownSolutionProvisioningState pode ser usado de forma intercambiável com SolutionProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Bem-sucedido: todas as soluções no lote foram bem-sucedidas.
PartialComplete: algumas soluções ainda estão em execução ou falharam.
Falha: Todas as soluções não foram executadas.
Em execução: todas as soluções ainda estão em execução.
Cancelado: quando a solicitação de soluções é cancelada.

SolutionType

Tipo de solução.
KnownSolutionType pode ser usado de forma intercambiável com SolutionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Diagnóstico: tipo de recurso de diagnóstico.
Soluções: Tipo de recurso Soluções.
Solucionadores de problemas: tipo de recurso de solucionadores de problemas.
Autoajuda: tipo de recurso de autoajuda.

Status

Indica o status do recurso de diagnóstico.
KnownStatus pode ser usado de forma intercambiável com Status, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

falha no: falha na criação do diagnóstico.
MissingInputs: faltam entradas necessárias para execução.
Executando: o diagnóstico ainda está em execução.
bem-sucedido: criação de diagnóstico bem-sucedida.
tempo limite: o diagnóstico atingiu o tempo limite.

TroubleshooterProvisioningState

Status do provisionamento da solução de problemas.
KnownTroubleshooterProvisioningState pode ser usado de forma intercambiável com TroubleshooterProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Êxito
Com falha
Cancelada
executando
Continuar automaticamente

Type

Tipo de etapa de solução de problemas.
KnownType pode ser usado de forma intercambiável com Type, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Decisão
Solução
Insights
Verificação automatizada
Entrada

ValidationScope

Escopo de validação
KnownValidationScope pode ser usado de forma intercambiável com ValidationScope, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhum
URLFormat
Formato Guid
Formato de endereço IP
NumberOnlyFormat

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.

KnownActionType

Enumeração extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.

KnownAggregationType

Os valores permitidos são Sum, Avg, Count, Min, Max. O padrão é Soma

KnownAutomatedCheckResultType

Tipo de resultado.

KnownConfidence

Confiança do resultado da pesquisa.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownDiagnosticProvisioningState

Status do provisionamento de diagnóstico.

KnownExecutionStatus

Status da execução da etapa da solução de problemas.

KnownImportanceLevel

Nível de importância do insight.

KnownName

Nome do critério de gatilho.

KnownOrigin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"

KnownQuestionContentType

O padrão é Texto.

KnownQuestionType

Tipo de pergunta

KnownResultType

Tipo de resultado do resultado da pesquisa.

KnownSolutionProvisioningState

Status do provisionamento de solução.

KnownSolutionType

Tipo de solução.

KnownStatus

Indica o status do recurso de diagnóstico.

KnownTroubleshooterProvisioningState

Status do provisionamento da solução de problemas.

KnownType

Tipo de etapa de solução de problemas.

KnownValidationScope

Escopo de validação

KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(HelpRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

restorePoller<TResponse, TResult>(HelpRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver no escopo.

function restorePoller<TResponse, TResult>(client: HelpRP, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

client
HelpRP
serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo