DeveloperHubServiceClient class

Package:

@azure/arm-devhub

Extends

ServiceClient

Constructors

DeveloperHubServiceClient(TokenCredential, string, DeveloperHubServiceClientOptionalParams)

Initializes a new instance of the DeveloperHubServiceClient class.

Properties

$host
apiVersion
operations
subscriptionId
workflowOperations

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

generatePreviewArtifacts(string, ArtifactGenerationProperties, GeneratePreviewArtifactsOptionalParams)	Generate preview dockerfile and manifests.
gitHubOAuth(string, GitHubOAuthOptionalParams)	Gets GitHubOAuth info used to authenticate users with the Developer Hub GitHub App.
gitHubOAuthCallback(string, string, string, GitHubOAuthCallbackOptionalParams)	Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.
listGitHubOAuth(string, ListGitHubOAuthOptionalParams)	Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

DeveloperHubServiceClient(TokenCredential, string, DeveloperHubServiceClientOptionalParams)

Initializes a new instance of the DeveloperHubServiceClient class.

new DeveloperHubServiceClient(credentials: TokenCredential, subscriptionId: string, options?: DeveloperHubServiceClientOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription.

options

DeveloperHubServiceClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

operations

operations: Operations

Property Value

Operations

subscriptionId

subscriptionId: string

Property Value

string

workflowOperations

workflowOperations: WorkflowOperations

Property Value

WorkflowOperations

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

generatePreviewArtifacts(string, ArtifactGenerationProperties, GeneratePreviewArtifactsOptionalParams)

Generate preview dockerfile and manifests.

function generatePreviewArtifacts(location: string, parameters: ArtifactGenerationProperties, options?: GeneratePreviewArtifactsOptionalParams): Promise<GeneratePreviewArtifactsResponse>

Parameters

location

string

The name of Azure region.

parameters

ArtifactGenerationProperties

Properties used for generating artifacts such as Dockerfiles and manifests.

options

GeneratePreviewArtifactsOptionalParams

The options parameters.

Returns

Promise<GeneratePreviewArtifactsResponse>

gitHubOAuth(string, GitHubOAuthOptionalParams)

Gets GitHubOAuth info used to authenticate users with the Developer Hub GitHub App.

function gitHubOAuth(location: string, options?: GitHubOAuthOptionalParams): Promise<GitHubOAuthInfoResponse>

Parameters

location

string

The name of Azure region.

options

GitHubOAuthOptionalParams

The options parameters.

Returns

Promise<GitHubOAuthInfoResponse>

gitHubOAuthCallback(string, string, string, GitHubOAuthCallbackOptionalParams)

Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.

function gitHubOAuthCallback(location: string, code: string, state: string, options?: GitHubOAuthCallbackOptionalParams): Promise<GitHubOAuthResponse>

Parameters

location

string

The name of Azure region.

code

string

The code response from authenticating the GitHub App.

state

string

The state response from authenticating the GitHub App.

options

GitHubOAuthCallbackOptionalParams

The options parameters.

Returns

Promise<GitHubOAuthResponse>

listGitHubOAuth(string, ListGitHubOAuthOptionalParams)

Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.

function listGitHubOAuth(location: string, options?: ListGitHubOAuthOptionalParams): Promise<GitHubOAuthListResponse>

Parameters

location

string

The name of Azure region.

options

ListGitHubOAuthOptionalParams

The options parameters.

Returns

Promise<GitHubOAuthListResponse>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest