ServiceEndpointRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

ServiceEndpointRestClient(IVssRestClientOptions)

Proprietà

RESOURCE_AREA_ID

Metodi

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)	Aggiungere record di esecuzione dell'endpoint di servizio.
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createOAuthConfiguration(OAuthConfigurationParams)
createServiceEndpoint(ServiceEndpoint)	Crea un nuovo endpoint di servizio
deleteOAuthConfiguration(string)
deleteServiceEndpoint(string, string[], boolean)	Eliminare un endpoint di servizio
executeServiceEndpointRequest(ServiceEndpointRequest, string, string)	Proxy per una richiesta GET definita da un endpoint di servizio.
getAzureManagementGroups()	Restituisce l'elenco delle sottoscrizioni di Azure
getAzureSubscriptions()	Restituisce l'elenco delle sottoscrizioni di Azure
getOAuthConfiguration(string)
getOAuthConfigurations(string, OAuthConfigurationActionFilter)
getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)	Ottenere i dettagli dell'endpoint di servizio.
getServiceEndpointExecutionRecords(string, string, number, number)	Ottenere i record di esecuzione dell'endpoint di servizio.
getServiceEndpoints(string, string, string[], string[], string, boolean, boolean, ServiceEndpointActionFilter)	Ottenere gli endpoint di servizio.
getServiceEndpointsByNames(string, string[], string, string[], string, boolean, boolean)	Ottenere gli endpoint di servizio in base al nome.
getServiceEndpointsByTypeAndOwner(string, string)	Ottenere gli endpoint di servizio per l'organizzazione in base al tipo e al proprietario. Restituisce solo id, nome e url e viene utilizzato solo internamente dal servizio di licenza
getServiceEndpointsWithRefreshedAuthentication(RefreshAuthenticationParameters[], string, string[])	Ottiene gli endpoint di servizio e applicare patch ai nuovi parametri di autorizzazione
getServiceEndpointTypes(string, string)	Ottenere i tipi di endpoint di servizio.
getVstsAadTenantId()
queryServiceEndpoint(DataSourceBinding, string)	Proxy per una richiesta GET definita da un endpoint di servizio. La richiesta è autorizzata usando un'origine dati nell'endpoint di servizio. La risposta viene filtrata usando un selettore basato su XPath/Json.
querySharedProjects(string, string)
shareEndpointWithProject(string, string, string)
shareServiceEndpoint(ServiceEndpointProjectReference[], string)	Condividere l'endpoint di servizio tra progetti
updateOAuthConfiguration(OAuthConfigurationParams, string)
updateServiceEndpoint(ServiceEndpoint, string, string)	Aggiornare l'endpoint del servizio
updateServiceEndpoints(ServiceEndpoint[])	Aggiornare gli endpoint di servizio.

Dettagli costruttore

ServiceEndpointRestClient(IVssRestClientOptions)

new ServiceEndpointRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli proprietà

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valore della proprietà

string

Dettagli metodo

addServiceEndpointExecutionRecords(ServiceEndpointExecutionRecordsInput, string)

Aggiungere record di esecuzione dell'endpoint di servizio.

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

Parametri

input

ServiceEndpointExecutionRecordsInput

Record di esecuzione dell'endpoint di servizio da aggiungere.

project

string

ID progetto o nome progetto

Restituisce

Promise<ServiceEndpointExecutionRecord[]>

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

Parametri

tenantId

string

redirectUri

string

promptOption

AadLoginPromptOption

completeCallbackPayload

string

completeCallbackByAuthCode

boolean

Restituisce

Promise<string>

createOAuthConfiguration(OAuthConfigurationParams)

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

Parametri

configurationParams

OAuthConfigurationParams

Restituisce

Promise<OAuthConfiguration>

createServiceEndpoint(ServiceEndpoint)

Crea un nuovo endpoint di servizio

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

Parametri

endpoint

ServiceEndpoint

Endpoint di servizio da creare

Restituisce

Promise<ServiceEndpoint>

deleteOAuthConfiguration(string)

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

Parametri

configurationId

string

Restituisce

Promise<OAuthConfiguration>

deleteServiceEndpoint(string, string[], boolean)

Eliminare un endpoint di servizio

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

Parametri

endpointId

string

ID endpoint dell'endpoint da eliminare

projectIds

string[]

ID progetto da cui deve essere eliminato l'endpoint

deep

boolean

eliminare lo spn creato dall'endpoint

Restituisce

Promise<void>

executeServiceEndpointRequest(ServiceEndpointRequest, string, string)

Proxy per una richiesta GET definita da un endpoint di servizio.

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

Parametri

serviceEndpointRequest

ServiceEndpointRequest

Richiesta dell'endpoint di servizio.

project

string

ID progetto o nome progetto

endpointId

string

ID dell'endpoint del servizio.

Restituisce

Promise<ServiceEndpointRequestResult>

getAzureManagementGroups()

Restituisce l'elenco delle sottoscrizioni di Azure

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Restituisce

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

Restituisce l'elenco delle sottoscrizioni di Azure

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Restituisce

Promise<AzureSubscriptionQueryResult>

getOAuthConfiguration(string)

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

Parametri

configurationId

string

Restituisce

Promise<OAuthConfiguration>

getOAuthConfigurations(string, OAuthConfigurationActionFilter)

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

Parametri

endpointType

string

actionFilter

OAuthConfigurationActionFilter

Restituisce

Promise<OAuthConfiguration[]>

getServiceEndpointDetails(string, string, ServiceEndpointActionFilter, boolean)

Ottenere i dettagli dell'endpoint di servizio.

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

Parametri

project

string

ID progetto o nome progetto

endpointId

string

ID dell'endpoint del servizio.

actionFilter

ServiceEndpointActionFilter

Filtro delle azioni per la connessione al servizio. Specifica l'azione che può essere eseguita sulla connessione al servizio.

loadConfidentialData

boolean

Flag per includere i dettagli riservati dell'endpoint di servizio. Questo è solo per uso interno.

Restituisce

Promise<ServiceEndpoint>

getServiceEndpointExecutionRecords(string, string, number, number)

Ottenere i record di esecuzione dell'endpoint di servizio.

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

Parametri

project

string

ID progetto o nome progetto

endpointId

string

ID dell'endpoint del servizio.

top

number

Numero di record di esecuzione dell'endpoint di servizio da ottenere.

continuationToken

number

Token di continuazione, restituito da una chiamata precedente a questo metodo, che può essere usato per restituire il set successivo di record

Restituisce

Promise<PagedList<ServiceEndpointExecutionRecord>>

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

Ottenere gli endpoint di servizio.

function getServiceEndpoints(project: string, type?: string, authSchemes?: string[], endpointIds?: string[], owner?: string, includeFailed?: boolean, includeDetails?: boolean, actionFilter?: ServiceEndpointActionFilter): Promise<ServiceEndpoint[]>

Parametri

project

string

ID progetto o nome progetto

type

string

Tipo di endpoint di servizio.

authSchemes

string[]

Schemi di autorizzazione usati per gli endpoint di servizio.

endpointIds

string[]

ID degli endpoint di servizio.

owner

string

Proprietario per gli endpoint di servizio.

includeFailed

boolean

Flag non riuscito per gli endpoint di servizio.

includeDetails

boolean

Flag per includere altri dettagli per gli endpoint di servizio. Questo vale solo per l'uso interno e il flag verrà considerato false per tutte le altre richieste

actionFilter

ServiceEndpointActionFilter

Il parametro "actionFilter" consente agli utenti di valutare le autorizzazioni del richiedente e recuperare un elenco di endpoint che soddisfano le condizioni specificate, assicurandosi che vengano restituiti solo gli endpoint pertinenti in base alle relative autorizzazioni

Restituisce

Promise<ServiceEndpoint[]>

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

Ottenere gli endpoint di servizio in base al nome.

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

Parametri

project

string

ID progetto o nome progetto

endpointNames

string[]

Nomi degli endpoint di servizio.

type

string

Tipo di endpoint di servizio.

authSchemes

string[]

Schemi di autorizzazione usati per gli endpoint di servizio.

owner

string

Proprietario per gli endpoint di servizio.

includeFailed

boolean

Flag non riuscito per gli endpoint di servizio.

includeDetails

boolean

Flag per includere altri dettagli per gli endpoint di servizio. Questo vale solo per l'uso interno e il flag verrà considerato false per tutte le altre richieste

Restituisce

Promise<ServiceEndpoint[]>

getServiceEndpointsByTypeAndOwner(string, string)

Ottenere gli endpoint di servizio per l'organizzazione in base al tipo e al proprietario. Restituisce solo id, nome e url e viene utilizzato solo internamente dal servizio di licenza

function getServiceEndpointsByTypeAndOwner(type: string, owner: string): Promise<ServiceEndpoint[]>

Parametri

type

string

Tipo di endpoint di servizio.

owner

string

Proprietario per gli endpoint di servizio.

Restituisce

Promise<ServiceEndpoint[]>

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

Ottiene gli endpoint di servizio e applicare patch ai nuovi parametri di autorizzazione

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

Parametri

refreshAuthenticationParameters

RefreshAuthenticationParameters[]

Ambito, validità del token richiesto.

project

string

ID progetto o nome progetto

endpointIds

string[]

ID degli endpoint di servizio.

Restituisce

Promise<ServiceEndpoint[]>

getServiceEndpointTypes(string, string)

Ottenere i tipi di endpoint di servizio.

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

Parametri

type

string

Tipo di endpoint di servizio.

scheme

string

Schema dell'endpoint di servizio.

Restituisce

Promise<ServiceEndpointType[]>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Restituisce

Promise<string>

queryServiceEndpoint(DataSourceBinding, string)

Proxy per una richiesta GET definita da un endpoint di servizio. La richiesta è autorizzata usando un'origine dati nell'endpoint di servizio. La risposta viene filtrata usando un selettore basato su XPath/Json.

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

Parametri

binding

DataSourceBinding

Descrive l'origine dati da recuperare.

project

string

ID progetto o nome progetto

Restituisce

Promise<string[]>

querySharedProjects(string, string)

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

Parametri

endpointId

string

project

string

Restituisce

Promise<ProjectReference[]>

shareEndpointWithProject(string, string, string)

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

Parametri

endpointId

string

fromProject

string

withProject

string

Restituisce

Promise<void>

shareServiceEndpoint(ServiceEndpointProjectReference[], string)

Condividere l'endpoint di servizio tra progetti

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

Parametri

endpointProjectReferences

ServiceEndpointProjectReference[]

Dettagli di riferimento del progetto di destinazione

endpointId

string

ID endpoint dell'endpoint da condividere

Restituisce

Promise<void>

updateOAuthConfiguration(OAuthConfigurationParams, string)

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

Parametri

configurationParams

OAuthConfigurationParams

configurationId

string

Restituisce

Promise<OAuthConfiguration>

updateServiceEndpoint(ServiceEndpoint, string, string)

Aggiornare l'endpoint del servizio

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

Parametri

endpoint

ServiceEndpoint

Dati aggiornati per l'endpoint

endpointId

string

ID endpoint dell'endpoint da aggiornare

operation

string

operation type

Restituisce

Promise<ServiceEndpoint>

updateServiceEndpoints(ServiceEndpoint[])

Aggiornare gli endpoint di servizio.

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

Parametri

endpoints

ServiceEndpoint[]

Nomi degli endpoint di servizio da aggiornare.

Restituisce

Promise<ServiceEndpoint[]>