ServiceEndpointRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

ServiceEndpointRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)	Agregue registros de ejecución del punto de conexión de servicio.
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createOAuthConfiguration(OAuthConfigurationParams)
createServiceEndpoint(ServiceEndpoint)	Crea un nuevo punto de conexión de servicio
deleteOAuthConfiguration(string)
deleteServiceEndpoint(string, string[], boolean)	Eliminación de un punto de conexión de servicio
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)	Proxy para una solicitud GET definida por un punto de conexión de servicio.
getAzureManagementGroups()	Devuelve la lista de suscripciones de Azure.
getAzureSubscriptions()	Devuelve la lista de suscripciones de Azure.
getOAuthConfiguration(string)
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)	Obtenga los detalles del punto de conexión de servicio.
getServiceEndpointExecutionRecords(string, string, number, number)	Obtiene los registros de ejecución del punto de conexión de servicio.
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)	Obtenga los puntos de conexión de servicio.
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)	Obtenga los puntos de conexión de servicio por nombre.
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])	Obtiene los puntos de conexión de servicio y revisa los nuevos parámetros de autorización.
getServiceEndpointTypes(string, string)	Obtiene los tipos de punto de conexión de servicio.
getVstsAadTenantId()
queryServiceEndpoint(DataSourceBinding, string)	Proxy para una solicitud GET definida por un punto de conexión de servicio. La solicitud está autorizada mediante un origen de datos en el punto de conexión de servicio. La respuesta se filtra mediante un selector basado en XPath/Json.
querySharedProjects(string, string)
shareEndpointWithProject(string, string, string)
shareServiceEndpoint(ServiceEndpointProjectReference[], string)	Uso compartido del punto de conexión de servicio entre proyectos
updateOAuthConfiguration(OAuthConfigurationParams, string)
updateServiceEndpoint(ServiceEndpoint, string, string)	Actualización del punto de conexión de servicio
updateServiceEndpoints(ServiceEndpoint[])	Actualice los puntos de conexión de servicio.

Detalles del constructor

ServiceEndpointRestClient(IVssRestClientOptions)

new ServiceEndpointRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Agregue registros de ejecución del punto de conexión de servicio.

function addServiceEndpointExecutionRecords(input: ServiceEndpointExecutionRecordsInput, project: string): Promise<ServiceEndpointExecutionRecord[]>

Parámetros

input

ServiceEndpointExecutionRecordsInput

Registros de ejecución del punto de conexión de servicio que se van a agregar.

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

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

Devoluciones

Promise<string>

createOAuthConfiguration(OAuthConfigurationParams)

function createOAuthConfiguration(configurationParams: OAuthConfigurationParams): Promise<OAuthConfiguration>

Parámetros

configurationParams

OAuthConfigurationParams

Devoluciones

Promise<OAuthConfiguration>

createServiceEndpoint(ServiceEndpoint)

Crea un nuevo punto de conexión de servicio

function createServiceEndpoint(endpoint: ServiceEndpoint): Promise<ServiceEndpoint>

Parámetros

endpoint

ServiceEndpoint

Punto de conexión de servicio que se va a crear

Devoluciones

Promise<ServiceEndpoint>

deleteOAuthConfiguration(string)

function deleteOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parámetros

configurationId

string

Devoluciones

Promise<OAuthConfiguration>

deleteServiceEndpoint(string, string[], boolean)

Eliminación de un punto de conexión de servicio

function deleteServiceEndpoint(endpointId: string, projectIds: string[], deep?: boolean): Promise<void>

Parámetros

endpointId

string

Identificador de punto de conexión del punto de conexión que se va a eliminar

projectIds

string[]

identificadores de proyecto desde los que se debe eliminar el punto de conexión

deep

boolean

eliminar el spn creado por el punto de conexión

Devoluciones

Promise<void>

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Proxy para una solicitud GET definida por un punto de conexión de servicio.

function executeServiceEndpointRequest(serviceEndpointRequest: ServiceEndpointRequest, project: string, endpointId: string): Promise<ServiceEndpointRequestResult>

Parámetros

serviceEndpointRequest

ServiceEndpointRequest

Solicitud de punto de conexión de servicio.

project

string

Id. de proyecto o nombre del proyecto

endpointId

string

Id. del punto de conexión de servicio.

Devoluciones

Promise<ServiceEndpointRequestResult>

getAzureManagementGroups()

Devuelve la lista de suscripciones de Azure.

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Devoluciones

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Devuelve la lista de suscripciones de Azure.

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Devoluciones

Promise<AzureSubscriptionQueryResult>

getOAuthConfiguration(string)

function getOAuthConfiguration(configurationId: string): Promise<OAuthConfiguration>

Parámetros

configurationId

string

Devoluciones

Promise<OAuthConfiguration>

getOAuthConfigurations(string, OAuthConfigurationActionFilter)

function getOAuthConfigurations(endpointType?: string, actionFilter?: OAuthConfigurationActionFilter): Promise<OAuthConfiguration[]>

Parámetros

endpointType

string

actionFilter

OAuthConfigurationActionFilter

Devoluciones

Promise<OAuthConfiguration[]>

getServiceEndpointDetails(string, string, ServiceEndpointActionFilter)

Obtenga los detalles del punto de conexión de servicio.

function getServiceEndpointDetails(project: string, endpointId: string, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

endpointId

string

Id. del punto de conexión de servicio.

actionFilter

ServiceEndpointActionFilter

Filtro de acción para la conexión de servicio. Especifica la acción que se puede realizar en la conexión de servicio.

Devoluciones

Promise<ServiceEndpoint>

getServiceEndpointExecutionRecords(string, string, number, number)

Obtiene los registros de ejecución del punto de conexión de servicio.

function getServiceEndpointExecutionRecords(project: string, endpointId: string, top?: number, continuationToken?: number): Promise<PagedList<ServiceEndpointExecutionRecord>>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

endpointId

string

Id. del punto de conexión de servicio.

top

number

Número de registros de ejecución del punto de conexión de servicio que se van a obtener.

continuationToken

number

Un token de continuación, devuelto por una llamada anterior a este método, que se puede usar para devolver el siguiente conjunto de registros.

Devoluciones

Promise<PagedList<ServiceEndpointExecutionRecord>>

getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)

Obtenga los puntos de conexión de servicio.

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. de proyecto o nombre del proyecto

type

string

Tipo de los puntos de conexión de servicio.

authSchemes

string[]

Esquemas de autorización usados para puntos de conexión de servicio.

endpointIds

string[]

Identificadores de los puntos de conexión de servicio.

owner

string

Propietario de los puntos de conexión de servicio.

includeFailed

boolean

Marca con error para los puntos de conexión de servicio.

includeDetails

boolean

Marca para incluir más detalles para los puntos de conexión de servicio. Esto es solo para uso interno y la marca se tratará como false para todas las demás solicitudes.

actionFilter

ServiceEndpointActionFilter

El parámetro "actionFilter" permite a los usuarios evaluar los permisos del solicitante y recuperar una lista de puntos de conexión que coincidan con las condiciones especificadas, lo que garantiza que solo se devuelvan los puntos de conexión pertinentes en función de sus permisos.

Devoluciones

Promise<ServiceEndpoint[]>

getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)

Obtenga los puntos de conexión de servicio por nombre.

function getServiceEndpointsByNames(project: string, endpointNames: string[], type?: string, authSchemes?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean): Promise<ServiceEndpoint[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

endpointNames

string[]

Nombres de los puntos de conexión de servicio.

type

string

Tipo de los puntos de conexión de servicio.

authSchemes

string[]

Esquemas de autorización usados para puntos de conexión de servicio.

owner

string

Propietario de los puntos de conexión de servicio.

includeFailed

boolean

Marca con error para los puntos de conexión de servicio.

includeDetails

boolean

Marca para incluir más detalles para los puntos de conexión de servicio. Esto es solo para uso interno y la marca se tratará como false para todas las demás solicitudes.

Devoluciones

Promise<ServiceEndpoint[]>

getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])

Obtiene los puntos de conexión de servicio y revisa los nuevos parámetros de autorización.

function getServiceEndpointsWithRefreshedAuthentication(refreshAuthenticationParameters: RefreshAuthenticationParameters[], project: string, endpointIds: string[]): Promise<ServiceEndpoint[]>

Parámetros

refreshAuthenticationParameters

RefreshAuthenticationParameters[]

Ámbito, validez del token solicitado.

project

string

Id. de proyecto o nombre del proyecto

endpointIds

string[]

Identificadores de los puntos de conexión de servicio.

Devoluciones

Promise<ServiceEndpoint[]>

getServiceEndpointTypes(string, string)

Obtiene los tipos de punto de conexión de servicio.

function getServiceEndpointTypes(type?: string, scheme?: string): Promise<ServiceEndpointType[]>

Parámetros

type

string

Tipo de punto de conexión de servicio.

scheme

string

Esquema del punto de conexión de servicio.

Devoluciones

Promise<ServiceEndpointType[]>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Devoluciones

Promise<string>

queryServiceEndpoint(DataSourceBinding, string)

Proxy para una solicitud GET definida por un punto de conexión de servicio. La solicitud está autorizada mediante un origen de datos en el punto de conexión de servicio. La respuesta se filtra mediante un selector basado en XPath/Json.

function queryServiceEndpoint(binding: DataSourceBinding, project: string): Promise<string[]>

Parámetros

binding

DataSourceBinding

Describe el origen de datos que se va a capturar.

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<string[]>

querySharedProjects(string, string)

function querySharedProjects(endpointId: string, project: string): Promise<ProjectReference[]>

Parámetros

endpointId

string

project

string

Devoluciones

Promise<ProjectReference[]>

shareEndpointWithProject(string, string, string)

function shareEndpointWithProject(endpointId: string, fromProject: string, withProject: string): Promise<void>

Parámetros

endpointId

string

fromProject

string

withProject

string

Devoluciones

Promise<void>

shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Uso compartido del punto de conexión de servicio entre proyectos

function shareServiceEndpoint(endpointProjectReferences: ServiceEndpointProjectReference[], endpointId: string): Promise<void>

Parámetros

endpointProjectReferences

ServiceEndpointProjectReference[]

Detalles de referencia del proyecto de destino

endpointId

string

Identificador de punto de conexión del punto de conexión que se va a compartir

Devoluciones

Promise<void>

updateOAuthConfiguration(OAuthConfigurationParams, string)

function updateOAuthConfiguration(configurationParams: OAuthConfigurationParams, configurationId: string): Promise<OAuthConfiguration>

Parámetros

configurationParams

OAuthConfigurationParams

configurationId

string

Devoluciones

Promise<OAuthConfiguration>

updateServiceEndpoint(ServiceEndpoint, string, string)

Actualización del punto de conexión de servicio

function updateServiceEndpoint(endpoint: ServiceEndpoint, endpointId: string, operation?: string): Promise<ServiceEndpoint>

Parámetros

endpoint

ServiceEndpoint

Datos actualizados para el punto de conexión

endpointId

string

Identificador de punto de conexión del punto de conexión que se va a actualizar

operation

string

tipo de operación

Devoluciones

Promise<ServiceEndpoint>

updateServiceEndpoints(ServiceEndpoint[])

Actualice los puntos de conexión de servicio.

function updateServiceEndpoints(endpoints: ServiceEndpoint[]): Promise<ServiceEndpoint[]>

Parámetros

endpoints

ServiceEndpoint[]

Nombres de los puntos de conexión de servicio que se van a actualizar.

Devoluciones

Promise<ServiceEndpoint[]>