ServiceEndpointRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Service |
Propriedades
| RESOURCE_AREA_ID |
Métodos
Detalhes do construtor
ServiceEndpointRestClient(IVssRestClientOptions)
new ServiceEndpointRestClient(options: IVssRestClientOptions)Parâmetros
- options
- IVssRestClientOptions
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do método
addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)
Adicionar registros de execução do ponto de extremidade de serviço.
function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>Parâmetros
Registros de execução do ponto de extremidade de serviço a serem adicionados.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<ServiceEndpointExecutionRecord[]>
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>Parâmetros
- tenantId
-
string
- redirectUri
-
string
- promptOption
- AadLoginPromptOption
- completeCallbackPayload
-
string
- completeCallbackByAuthCode
-
boolean
Retornos
Promise<string>
createOAuthConfiguration(OAuthConfigurationParams)
function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>Parâmetros
- configurationParams
- OAuthConfigurationParams
Retornos
Promise<OAuthConfiguration>
createServiceEndpoint(ServiceEndpoint)
Cria um novo ponto de extremidade de serviço
function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>Parâmetros
- endpoint
- ServiceEndpoint
Ponto de extremidade de serviço a ser criado
Retornos
Promise<ServiceEndpoint>
deleteOAuthConfiguration(string)
function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parâmetros
- configurationId
-
string
Retornos
Promise<OAuthConfiguration>
deleteServiceEndpoint(string, string[], boolean)
Excluir um ponto de extremidade de serviço
function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>Parâmetros
- endpointId
-
string
ID do ponto de extremidade do ponto de extremidade a ser excluído
- projectIds
-
string[]
IDs de projeto das quais o ponto de extremidade precisa ser excluído
- deep
-
boolean
excluir o spn criado pelo ponto de extremidade
Retornos
Promise<void>
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)
Proxy para uma solicitação GET definida por um ponto de extremidade de serviço.
function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>Parâmetros
- serviceEndpointRequest
- ServiceEndpointRequest
Solicitação de ponto de extremidade de serviço.
- project
-
string
ID do projeto ou nome do projeto
- endpointId
-
string
ID do ponto de extremidade de serviço.
Retornos
Promise<ServiceEndpointRequestResult>
getAzureManagementGroups()
Retorna a lista de assinaturas do Azure
function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>Retornos
Promise<AzureManagementGroupQueryResult>
getAzureSubscriptions()
Retorna a lista de assinaturas do Azure
function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>Retornos
Promise<AzureSubscriptionQueryResult>
getOAuthConfiguration(string)
function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>Parâmetros
- configurationId
-
string
Retornos
Promise<OAuthConfiguration>
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>Parâmetros
- endpointType
-
string
- actionFilter
- OAuthConfigurationActionFilter
Retornos
Promise<OAuthConfiguration[]>
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)
Obtenha os detalhes do ponto de extremidade de serviço.
function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- endpointId
-
string
ID do ponto de extremidade de serviço.
- actionFilter
- ServiceEndpointActionFilter
Filtro de ação para a conexão de serviço. Ele especifica a ação que pode ser executada na conexão de serviço.
Retornos
Promise<ServiceEndpoint>
getServiceEndpointExecutionRecords(string, string, number, number)
Obter registros de execução do ponto de extremidade de serviço.
function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- endpointId
-
string
ID do ponto de extremidade de serviço.
- top
-
number
Número de registros de execução do ponto de extremidade de serviço a serem obtidos.
- continuationToken
-
number
Um token de continuação, retornado por uma chamada anterior a esse método, que pode ser usado para retornar o próximo conjunto de registros
Retornos
Promise<PagedList<ServiceEndpointExecutionRecord>>
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)
Obter os pontos de extremidade de serviço.
function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- type
-
string
Tipo dos pontos de extremidade de serviço.
- authSchemes
-
string[]
Esquemas de autorização usados para pontos de extremidade de serviço.
- endpointIds
-
string[]
IDs dos pontos de extremidade de serviço.
- owner
-
string
Proprietário para pontos de extremidade de serviço.
- includeFailed
-
boolean
Sinalizador com falha para pontos de extremidade de serviço.
- includeDetails
-
boolean
Sinalizador para incluir mais detalhes para pontos de extremidade de serviço. Isso é apenas para uso interno e o sinalizador será tratado como falso para todas as outras solicitações
- actionFilter
- ServiceEndpointActionFilter
O parâmetro "actionFilter" permite que os usuários avaliem as permissões do solicitante e recuperem uma lista de pontos de extremidade que correspondem às condições especificadas, garantindo que apenas pontos de extremidade relevantes sejam retornados com base em suas permissões
Retornos
Promise<ServiceEndpoint[]>
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)
Obtenha os pontos de extremidade de serviço por nome.
function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>Parâmetros
- project
-
string
ID do projeto ou nome do projeto
- endpointNames
-
string[]
Nomes dos pontos de extremidade de serviço.
- type
-
string
Tipo dos pontos de extremidade de serviço.
- authSchemes
-
string[]
Esquemas de autorização usados para pontos de extremidade de serviço.
- owner
-
string
Proprietário para pontos de extremidade de serviço.
- includeFailed
-
boolean
Sinalizador com falha para pontos de extremidade de serviço.
- includeDetails
-
boolean
Sinalizador para incluir mais detalhes para pontos de extremidade de serviço. Isso é apenas para uso interno e o sinalizador será tratado como falso para todas as outras solicitações
Retornos
Promise<ServiceEndpoint[]>
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])
Obtém os pontos de extremidade de serviço e corrija novos parâmetros de autorização
function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>Parâmetros
- refreshAuthenticationParameters
Escopo, validade do token solicitado.
- project
-
string
ID do projeto ou nome do projeto
- endpointIds
-
string[]
IDs dos pontos de extremidade de serviço.
Retornos
Promise<ServiceEndpoint[]>
getServiceEndpointTypes(string, string)
Obter tipos de ponto de extremidade de serviço.
function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>Parâmetros
- type
-
string
Tipo de ponto de extremidade de serviço.
- scheme
-
string
Esquema de ponto de extremidade de serviço.
Retornos
Promise<ServiceEndpointType[]>
getVstsAadTenantId()
function getVstsAadTenantId(): Promise<string>Retornos
Promise<string>
queryServiceEndpoint(DataSourceBinding, string)
Proxy para uma solicitação GET definida por um ponto de extremidade de serviço. A solicitação é autorizada usando uma fonte de dados no ponto de extremidade de serviço. A resposta é filtrada usando um seletor baseado em XPath/Json.
function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>Parâmetros
- binding
- DataSourceBinding
Descreve a fonte de dados a ser buscada.
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<string[]>
querySharedProjects(string, string)
function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>Parâmetros
- endpointId
-
string
- project
-
string
Retornos
Promise<ProjectReference[]>
shareEndpointWithProject(string, string, string)
function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>Parâmetros
- endpointId
-
string
- fromProject
-
string
- withProject
-
string
Retornos
Promise<void>
shareServiceEndpoint(ServiceEndpointProjectReference[], string)
Compartilhar ponto de extremidade de serviço entre projetos
function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>Parâmetros
- endpointProjectReferences
Detalhes de referência do projeto de destino
- endpointId
-
string
ID do ponto de extremidade a ser compartilhado
Retornos
Promise<void>
updateOAuthConfiguration(OAuthConfigurationParams, string)
function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>Parâmetros
- configurationParams
- OAuthConfigurationParams
- configurationId
-
string
Retornos
Promise<OAuthConfiguration>
updateServiceEndpoint(ServiceEndpoint, string, string)
Atualizar o ponto de extremidade de serviço
function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>Parâmetros
- endpoint
- ServiceEndpoint
Dados atualizados para o ponto de extremidade
- endpointId
-
string
ID do ponto de extremidade a ser atualizado
- operation
-
string
tipo de operação
Retornos
Promise<ServiceEndpoint>
updateServiceEndpoints(ServiceEndpoint[])
Atualize os pontos de extremidade de serviço.
function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>Parâmetros
- endpoints
Nomes dos pontos de extremidade de serviço a serem atualizados.
Retornos
Promise<ServiceEndpoint[]>