azure-devops-extension-api 4.248.0 → 4.248.1

package/src/ServiceEndpoint/ServiceEndpointClient.ts

@@ -1,617 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-import { deserializeVssJsonObject } from "../Common/Util/Serialization";
-
-import * as ServiceEndpoint from "../ServiceEndpoint/ServiceEndpoint";
-import * as WebApi from "../WebApi/WebApi";
-
-export class ServiceEndpointRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    public static readonly RESOURCE_AREA_ID = "1814ab31-2f4f-4a9f-8761-f4d77dc5a5d7";
-
-    /**
-     * Returns list of azure subscriptions
-     * 
-     */
-    public async getAzureManagementGroups(
-        ): Promise<ServiceEndpoint.AzureManagementGroupQueryResult> {
-
-        return this.beginRequest<ServiceEndpoint.AzureManagementGroupQueryResult>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/endpointproxy/azurermmanagementgroups"
-        });
-    }
-
-    /**
-     * Returns list of azure subscriptions
-     * 
-     */
-    public async getAzureSubscriptions(
-        ): Promise<ServiceEndpoint.AzureSubscriptionQueryResult> {
-
-        return this.beginRequest<ServiceEndpoint.AzureSubscriptionQueryResult>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/endpointproxy/azurermsubscriptions"
-        });
-    }
-
-    /**
-     * Proxy for a GET request defined by a service endpoint.
-     * 
-     * @param serviceEndpointRequest - Service endpoint request.
-     * @param project - Project ID or project name
-     * @param endpointId - Id of the service endpoint.
-     */
-    public async executeServiceEndpointRequest(
-        serviceEndpointRequest: ServiceEndpoint.ServiceEndpointRequest,
-        project: string,
-        endpointId: string
-        ): Promise<ServiceEndpoint.ServiceEndpointRequestResult> {
-
-        const queryValues: any = {
-            endpointId: endpointId
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpointRequestResult>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpointproxy",
-            routeValues: {
-                project: project
-            },
-            queryParams: queryValues,
-            body: serviceEndpointRequest
-        });
-    }
-
-    /**
-     * Proxy for a GET request defined by a service endpoint. The request is authorized using a data source in service endpoint. The response is filtered using an XPath/Json based selector.
-     * 
-     * @param binding - Describes the data source to fetch.
-     * @param project - Project ID or project name
-     */
-    public async queryServiceEndpoint(
-        binding: ServiceEndpoint.DataSourceBinding,
-        project: string
-        ): Promise<string[]> {
-
-        return this.beginRequest<string[]>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpointproxy",
-            routeValues: {
-                project: project
-            },
-            body: binding
-        });
-    }
-
-    /**
-     * Creates a new service endpoint
-     * 
-     * @param endpoint - Service endpoint to create
-     */
-    public async createServiceEndpoint(
-        endpoint: ServiceEndpoint.ServiceEndpoint
-        ): Promise<ServiceEndpoint.ServiceEndpoint> {
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint>({
-            apiVersion: "7.2-preview.4",
-            method: "POST",
-            routeTemplate: "_apis/serviceendpoint/endpoints/{endpointId}",
-            body: endpoint
-        });
-    }
-
-    /**
-     * Delete a service endpoint
-     * 
-     * @param endpointId - Endpoint Id of endpoint to delete
-     * @param projectIds - project Ids from which endpoint needs to be deleted
-     * @param deep - delete the spn created by endpoint
-     */
-    public async deleteServiceEndpoint(
-        endpointId: string,
-        projectIds: string[],
-        deep?: boolean
-        ): Promise<void> {
-
-        const queryValues: any = {
-            projectIds: projectIds && projectIds.join(","),
-            deep: deep
-        };
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.4",
-            method: "DELETE",
-            routeTemplate: "_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                endpointId: endpointId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Share service endpoint across projects
-     * 
-     * @param endpointProjectReferences - Project reference details of the target project
-     * @param endpointId - Endpoint Id of the endpoint to share
-     */
-    public async shareServiceEndpoint(
-        endpointProjectReferences: ServiceEndpoint.ServiceEndpointProjectReference[],
-        endpointId: string
-        ): Promise<void> {
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.4",
-            method: "PATCH",
-            routeTemplate: "_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                endpointId: endpointId
-            },
-            body: endpointProjectReferences
-        });
-    }
-
-    /**
-     * Update the service endpoint
-     * 
-     * @param endpoint - Updated data for the endpoint
-     * @param endpointId - Endpoint Id of the endpoint to update
-     * @param operation - operation type
-     */
-    public async updateServiceEndpoint(
-        endpoint: ServiceEndpoint.ServiceEndpoint,
-        endpointId: string,
-        operation?: string
-        ): Promise<ServiceEndpoint.ServiceEndpoint> {
-
-        const queryValues: any = {
-            operation: operation
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint>({
-            apiVersion: "7.2-preview.4",
-            method: "PUT",
-            routeTemplate: "_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                endpointId: endpointId
-            },
-            queryParams: queryValues,
-            body: endpoint
-        });
-    }
-
-    /**
-     * Update the service endpoints.
-     * 
-     * @param endpoints - Names of the service endpoints to update.
-     */
-    public async updateServiceEndpoints(
-        endpoints: ServiceEndpoint.ServiceEndpoint[]
-        ): Promise<ServiceEndpoint.ServiceEndpoint[]> {
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint[]>({
-            apiVersion: "7.2-preview.4",
-            method: "PUT",
-            routeTemplate: "_apis/serviceendpoint/endpoints/{endpointId}",
-            body: endpoints
-        });
-    }
-
-    /**
-     * Get the service endpoint details.
-     * 
-     * @param project - Project ID or project name
-     * @param endpointId - Id of the service endpoint.
-     * @param actionFilter - Action filter for the service connection. It specifies the action which can be performed on the service connection.
-     * @param loadConfidetantialData - Flag to include confidential details of service endpoint. This is for internal use only.
-     */
-    public async getServiceEndpointDetails(
-        project: string,
-        endpointId: string,
-        actionFilter?: ServiceEndpoint.ServiceEndpointActionFilter,
-        loadConfidetantialData?: boolean
-        ): Promise<ServiceEndpoint.ServiceEndpoint> {
-
-        const queryValues: any = {
-            actionFilter: actionFilter,
-            loadConfidetantialData: loadConfidetantialData
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint>({
-            apiVersion: "7.2-preview.4",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                project: project,
-                endpointId: endpointId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Get the service endpoints.
-     * 
-     * @param project - Project ID or project name
-     * @param type - Type of the service endpoints.
-     * @param authSchemes - Authorization schemes used for service endpoints.
-     * @param endpointIds - Ids of the service endpoints.
-     * @param owner - Owner for service endpoints.
-     * @param includeFailed - Failed flag for service endpoints.
-     * @param includeDetails - Flag to include more details for service endpoints. This is for internal use only and the flag will be treated as false for all other requests
-     * @param actionFilter - The "actionFilter" parameter allows users to evaluate requestor permissions and retrieve a list of endpoints that match the specified conditions, ensuring that only relevant endpoints are returned based on their permissions
-     */
-    public async getServiceEndpoints(
-        project: string,
-        type?: string,
-        authSchemes?: string[],
-        endpointIds?: string[],
-        owner?: string,
-        includeFailed?: boolean,
-        includeDetails?: boolean,
-        actionFilter?: ServiceEndpoint.ServiceEndpointActionFilter
-        ): Promise<ServiceEndpoint.ServiceEndpoint[]> {
-
-        const queryValues: any = {
-            type: type,
-            authSchemes: authSchemes && authSchemes.join(","),
-            endpointIds: endpointIds && endpointIds.join(","),
-            owner: owner,
-            includeFailed: includeFailed,
-            includeDetails: includeDetails,
-            actionFilter: actionFilter
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint[]>({
-            apiVersion: "7.2-preview.4",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                project: project
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Get the service endpoints by name.
-     * 
-     * @param project - Project ID or project name
-     * @param endpointNames - Names of the service endpoints.
-     * @param type - Type of the service endpoints.
-     * @param authSchemes - Authorization schemes used for service endpoints.
-     * @param owner - Owner for service endpoints.
-     * @param includeFailed - Failed flag for service endpoints.
-     * @param includeDetails - Flag to include more details for service endpoints. This is for internal use only and the flag will be treated as false for all other requests
-     */
-    public async getServiceEndpointsByNames(
-        project: string,
-        endpointNames: string[],
-        type?: string,
-        authSchemes?: string[],
-        owner?: string,
-        includeFailed?: boolean,
-        includeDetails?: boolean
-        ): Promise<ServiceEndpoint.ServiceEndpoint[]> {
-
-        const queryValues: any = {
-            endpointNames: endpointNames && endpointNames.join(","),
-            type: type,
-            authSchemes: authSchemes && authSchemes.join(","),
-            owner: owner,
-            includeFailed: includeFailed,
-            includeDetails: includeDetails
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint[]>({
-            apiVersion: "7.2-preview.4",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                project: project
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Gets the service endpoints and patch new authorization parameters
-     * 
-     * @param refreshAuthenticationParameters - Scope, Validity of Token requested.
-     * @param project - Project ID or project name
-     * @param endpointIds - Ids of the service endpoints.
-     */
-    public async getServiceEndpointsWithRefreshedAuthentication(
-        refreshAuthenticationParameters: ServiceEndpoint.RefreshAuthenticationParameters[],
-        project: string,
-        endpointIds: string[]
-        ): Promise<ServiceEndpoint.ServiceEndpoint[]> {
-
-        const queryValues: any = {
-            endpointIds: endpointIds && endpointIds.join(",")
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpoint[]>({
-            apiVersion: "7.2-preview.4",
-            method: "POST",
-            routeTemplate: "{project}/_apis/serviceendpoint/endpoints/{endpointId}",
-            routeValues: {
-                project: project
-            },
-            queryParams: queryValues,
-            body: refreshAuthenticationParameters
-        });
-    }
-
-    /**
-     * Get service endpoint execution records.
-     * 
-     * @param project - Project ID or project name
-     * @param endpointId - Id of the service endpoint.
-     * @param top - Number of service endpoint execution records to get.
-     * @param continuationToken - A continuation token, returned by a previous call to this method, that can be used to return the next set of records
-     */
-    public async getServiceEndpointExecutionRecords(
-        project: string,
-        endpointId: string,
-        top?: number,
-        continuationToken?: number
-        ): Promise<WebApi.PagedList<ServiceEndpoint.ServiceEndpointExecutionRecord>> {
-
-        const queryValues: any = {
-            top: top,
-            continuationToken: continuationToken
-        };
-
-        return this.beginRequest<Response>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "{project}/_apis/serviceendpoint/{endpointId}/executionhistory",
-            routeValues: {
-                project: project,
-                endpointId: endpointId
-            },
-            queryParams: queryValues,
-            returnRawResponse: true
-        }).then(async response => {
-            const body = <WebApi.PagedList<ServiceEndpoint.ServiceEndpointExecutionRecord>>await response.text().then(deserializeVssJsonObject);
-            body.continuationToken = response.headers.get("x-ms-continuationtoken");
-            return body;
-        });
-    }
-
-    /**
-     * Add service endpoint execution records.
-     * 
-     * @param input - Service endpoint execution records to add.
-     * @param project - Project ID or project name
-     */
-    public async addServiceEndpointExecutionRecords(
-        input: ServiceEndpoint.ServiceEndpointExecutionRecordsInput,
-        project: string
-        ): Promise<ServiceEndpoint.ServiceEndpointExecutionRecord[]> {
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpointExecutionRecord[]>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "{project}/_apis/serviceendpoint/executionhistory",
-            routeValues: {
-                project: project
-            },
-            body: input
-        });
-    }
-
-    /**
-     * @param configurationParams - 
-     */
-    public async createOAuthConfiguration(
-        configurationParams: ServiceEndpoint.OAuthConfigurationParams
-        ): Promise<ServiceEndpoint.OAuthConfiguration> {
-
-        return this.beginRequest<ServiceEndpoint.OAuthConfiguration>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/serviceendpoint/oauthconfiguration/{configurationId}",
-            body: configurationParams
-        });
-    }
-
-    /**
-     * @param configurationId - 
-     */
-    public async deleteOAuthConfiguration(
-        configurationId: string
-        ): Promise<ServiceEndpoint.OAuthConfiguration> {
-
-        return this.beginRequest<ServiceEndpoint.OAuthConfiguration>({
-            apiVersion: "7.2-preview.1",
-            method: "DELETE",
-            routeTemplate: "_apis/serviceendpoint/oauthconfiguration/{configurationId}",
-            routeValues: {
-                configurationId: configurationId
-            }
-        });
-    }
-
-    /**
-     * @param configurationId - 
-     */
-    public async getOAuthConfiguration(
-        configurationId: string
-        ): Promise<ServiceEndpoint.OAuthConfiguration> {
-
-        return this.beginRequest<ServiceEndpoint.OAuthConfiguration>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/oauthconfiguration/{configurationId}",
-            routeValues: {
-                configurationId: configurationId
-            }
-        });
-    }
-
-    /**
-     * @param endpointType - 
-     * @param actionFilter - 
-     */
-    public async getOAuthConfigurations(
-        endpointType?: string,
-        actionFilter?: ServiceEndpoint.OAuthConfigurationActionFilter
-        ): Promise<ServiceEndpoint.OAuthConfiguration[]> {
-
-        const queryValues: any = {
-            endpointType: endpointType,
-            actionFilter: actionFilter
-        };
-
-        return this.beginRequest<ServiceEndpoint.OAuthConfiguration[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/oauthconfiguration/{configurationId}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param configurationParams - 
-     * @param configurationId - 
-     */
-    public async updateOAuthConfiguration(
-        configurationParams: ServiceEndpoint.OAuthConfigurationParams,
-        configurationId: string
-        ): Promise<ServiceEndpoint.OAuthConfiguration> {
-
-        return this.beginRequest<ServiceEndpoint.OAuthConfiguration>({
-            apiVersion: "7.2-preview.1",
-            method: "PUT",
-            routeTemplate: "_apis/serviceendpoint/oauthconfiguration/{configurationId}",
-            routeValues: {
-                configurationId: configurationId
-            },
-            body: configurationParams
-        });
-    }
-
-    /**
-     * @param endpointId - 
-     * @param project - 
-     */
-    public async querySharedProjects(
-        endpointId: string,
-        project: string
-        ): Promise<ServiceEndpoint.ProjectReference[]> {
-
-        const queryValues: any = {
-            project: project
-        };
-
-        return this.beginRequest<ServiceEndpoint.ProjectReference[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/share/{endpointId}",
-            routeValues: {
-                endpointId: endpointId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param endpointId - 
-     * @param fromProject - 
-     * @param withProject - 
-     */
-    public async shareEndpointWithProject(
-        endpointId: string,
-        fromProject: string,
-        withProject: string
-        ): Promise<void> {
-
-        const queryValues: any = {
-            fromProject: fromProject,
-            withProject: withProject
-        };
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/serviceendpoint/share/{endpointId}",
-            routeValues: {
-                endpointId: endpointId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Get service endpoint types.
-     * 
-     * @param type - Type of service endpoint.
-     * @param scheme - Scheme of service endpoint.
-     */
-    public async getServiceEndpointTypes(
-        type?: string,
-        scheme?: string
-        ): Promise<ServiceEndpoint.ServiceEndpointType[]> {
-
-        const queryValues: any = {
-            type: type,
-            scheme: scheme
-        };
-
-        return this.beginRequest<ServiceEndpoint.ServiceEndpointType[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/types",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param tenantId - 
-     * @param redirectUri - 
-     * @param promptOption - 
-     * @param completeCallbackPayload - 
-     * @param completeCallbackByAuthCode - 
-     */
-    public async createAadOAuthRequest(
-        tenantId: string,
-        redirectUri: string,
-        promptOption?: ServiceEndpoint.AadLoginPromptOption,
-        completeCallbackPayload?: string,
-        completeCallbackByAuthCode?: boolean
-        ): Promise<string> {
-
-        const queryValues: any = {
-            tenantId: tenantId,
-            redirectUri: redirectUri,
-            promptOption: promptOption,
-            completeCallbackPayload: completeCallbackPayload,
-            completeCallbackByAuthCode: completeCallbackByAuthCode
-        };
-
-        return this.beginRequest<string>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/serviceendpoint/vstsaadoauth/vstsaadoauth",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     */
-    public async getVstsAadTenantId(
-        ): Promise<string> {
-
-        return this.beginRequest<string>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/serviceendpoint/vstsaadoauth/vstsaadoauth"
-        });
-    }
-
-}

package/src/ServiceEndpoint/index.ts

@@ -1,2 +0,0 @@
-export * from "./ServiceEndpoint";
-export * from "./ServiceEndpointClient";