ContainerAppsAPIClient class

Extends

Constructors

ContainerAppsAPIClient(TokenCredential, string, ContainerAppsAPIClientOptionalParams)

Initializes a new instance of the ContainerAppsAPIClient class.

Properties

$host
apiVersion
availableWorkloadProfiles
billingMeters
certificates
connectedEnvironments
connectedEnvironmentsCertificates
connectedEnvironmentsDaprComponents
connectedEnvironmentsStorages
containerApps
containerAppsAuthConfigs
containerAppsDiagnostics
containerAppsRevisionReplicas
containerAppsRevisions
containerAppsSourceControls
daprComponents
jobs
jobsExecutions
managedCertificates
managedEnvironmentDiagnostics
managedEnvironments
managedEnvironmentsDiagnostics
managedEnvironmentsStorages
managedEnvironmentUsages
namespaces
operations
subscriptionId
usages

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

getCustomDomainVerificationId(GetCustomDomainVerificationIdOptionalParams)

Get the verification id of a subscription used for verifying custom domains

jobExecution(string, string, string, JobExecutionOptionalParams)

Get details of a single job execution

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

ContainerAppsAPIClient(TokenCredential, string, ContainerAppsAPIClientOptionalParams)

Initializes a new instance of the ContainerAppsAPIClient class.

new ContainerAppsAPIClient(credentials: TokenCredential, subscriptionId: string, options?: ContainerAppsAPIClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription.

options
ContainerAppsAPIClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

availableWorkloadProfiles

availableWorkloadProfiles: AvailableWorkloadProfiles

Property Value

billingMeters

billingMeters: BillingMeters

Property Value

certificates

certificates: Certificates

Property Value

connectedEnvironments

connectedEnvironments: ConnectedEnvironments

Property Value

connectedEnvironmentsCertificates

connectedEnvironmentsCertificates: ConnectedEnvironmentsCertificates

Property Value

connectedEnvironmentsDaprComponents

connectedEnvironmentsDaprComponents: ConnectedEnvironmentsDaprComponents

Property Value

connectedEnvironmentsStorages

connectedEnvironmentsStorages: ConnectedEnvironmentsStorages

Property Value

containerApps

containerApps: ContainerApps

Property Value

containerAppsAuthConfigs

containerAppsAuthConfigs: ContainerAppsAuthConfigs

Property Value

containerAppsDiagnostics

containerAppsDiagnostics: ContainerAppsDiagnostics

Property Value

containerAppsRevisionReplicas

containerAppsRevisionReplicas: ContainerAppsRevisionReplicas

Property Value

containerAppsRevisions

containerAppsRevisions: ContainerAppsRevisions

Property Value

containerAppsSourceControls

containerAppsSourceControls: ContainerAppsSourceControls

Property Value

daprComponents

daprComponents: DaprComponents

Property Value

jobs

jobs: Jobs

Property Value

jobsExecutions

jobsExecutions: JobsExecutions

Property Value

managedCertificates

managedCertificates: ManagedCertificates

Property Value

managedEnvironmentDiagnostics

managedEnvironmentDiagnostics: ManagedEnvironmentDiagnostics

Property Value

managedEnvironments

managedEnvironments: ManagedEnvironments

Property Value

managedEnvironmentsDiagnostics

managedEnvironmentsDiagnostics: ManagedEnvironmentsDiagnostics

Property Value

managedEnvironmentsStorages

managedEnvironmentsStorages: ManagedEnvironmentsStorages

Property Value

managedEnvironmentUsages

managedEnvironmentUsages: ManagedEnvironmentUsages

Property Value

namespaces

namespaces: Namespaces

Property Value

operations

operations: Operations

Property Value

subscriptionId

subscriptionId: string

Property Value

string

usages

usages: Usages

Property Value

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Inherited From coreClient.ServiceClient.pipeline

Method Details

getCustomDomainVerificationId(GetCustomDomainVerificationIdOptionalParams)

Get the verification id of a subscription used for verifying custom domains

function getCustomDomainVerificationId(options?: GetCustomDomainVerificationIdOptionalParams): Promise<GetCustomDomainVerificationIdResponse>

Parameters

options
GetCustomDomainVerificationIdOptionalParams

The options parameters.

Returns

jobExecution(string, string, string, JobExecutionOptionalParams)

Get details of a single job execution

function jobExecution(resourceGroupName: string, jobName: string, jobExecutionName: string, options?: JobExecutionOptionalParams): Promise<JobExecution>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

jobName

string

Job Name

jobExecutionName

string

Job execution name.

options
JobExecutionOptionalParams

The options parameters.

Returns

Promise<JobExecution>

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