@azure/arm-app package

Classes

ContainerAppsAPIClient

Interfaces

AllowedAudiencesValidation	The configuration settings of the Allowed Audiences validation flow.
AllowedPrincipals	The configuration settings of the Azure Active Directory allowed principals.
AppLogsConfiguration	Configuration of application logs
AppRegistration	The configuration settings of the app registration for providers that have app ids and app secrets
Apple	The configuration settings of the Apple provider.
AppleRegistration	The configuration settings of the registration for the Apple provider
AuthConfigCollection	AuthConfig collection ARM resource.
AuthPlatform	The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
AvailableOperations	Available operations of the service
AzureActiveDirectory	The configuration settings of the Azure Active directory provider.
AzureActiveDirectoryLogin	The configuration settings of the Azure Active Directory login flow.
AzureActiveDirectoryRegistration	The configuration settings of the Azure Active Directory app registration.
AzureActiveDirectoryValidation	The configuration settings of the Azure Active Directory token validation flow.
AzureCredentials	Container App credentials.
AzureFileProperties	Azure File Properties.
AzureStaticWebApps	The configuration settings of the Azure Static Web Apps provider.
AzureStaticWebAppsRegistration	The configuration settings of the registration for the Azure Static Web Apps provider
CertificateCollection	Collection of Certificates.
CertificatePatch	A certificate to update
CertificateProperties	Certificate resource specific properties
Certificates	Interface representing a Certificates.
CertificatesCreateOrUpdateOptionalParams	Optional parameters.
CertificatesDeleteOptionalParams	Optional parameters.
CertificatesGetOptionalParams	Optional parameters.
CertificatesListNextOptionalParams	Optional parameters.
CertificatesListOptionalParams	Optional parameters.
CertificatesUpdateOptionalParams	Optional parameters.
ClientRegistration	The configuration settings of the app registration for providers that have client ids and client secrets
Configuration	Non versioned Container App configuration properties that define the mutable settings of a Container app
Container	Container App container definition.
ContainerAppCollection	Container App collection ARM resource.
ContainerAppPatch	Container App Patch.
ContainerAppProbe	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ContainerAppProbeHttpGet	HTTPGet specifies the http request to perform.
ContainerAppProbeHttpGetHttpHeadersItem	HTTPHeader describes a custom header to be used in HTTP probes
ContainerAppProbeTcpSocket	TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.
ContainerAppSecret	Container App Secret.
ContainerApps	Interface representing a ContainerApps.
ContainerAppsAPIClientOptionalParams	Optional parameters.
ContainerAppsAuthConfigs	Interface representing a ContainerAppsAuthConfigs.
ContainerAppsAuthConfigsCreateOrUpdateOptionalParams	Optional parameters.
ContainerAppsAuthConfigsDeleteOptionalParams	Optional parameters.
ContainerAppsAuthConfigsGetOptionalParams	Optional parameters.
ContainerAppsAuthConfigsListByContainerAppNextOptionalParams	Optional parameters.
ContainerAppsAuthConfigsListByContainerAppOptionalParams	Optional parameters.
ContainerAppsCreateOrUpdateOptionalParams	Optional parameters.
ContainerAppsDeleteOptionalParams	Optional parameters.
ContainerAppsGetOptionalParams	Optional parameters.
ContainerAppsListByResourceGroupNextOptionalParams	Optional parameters.
ContainerAppsListByResourceGroupOptionalParams	Optional parameters.
ContainerAppsListBySubscriptionNextOptionalParams	Optional parameters.
ContainerAppsListBySubscriptionOptionalParams	Optional parameters.
ContainerAppsListCustomHostNameAnalysisOptionalParams	Optional parameters.
ContainerAppsListSecretsOptionalParams	Optional parameters.
ContainerAppsRevisionReplicas	Interface representing a ContainerAppsRevisionReplicas.
ContainerAppsRevisionReplicasGetReplicaOptionalParams	Optional parameters.
ContainerAppsRevisionReplicasListReplicasOptionalParams	Optional parameters.
ContainerAppsRevisions	Interface representing a ContainerAppsRevisions.
ContainerAppsRevisionsActivateRevisionOptionalParams	Optional parameters.
ContainerAppsRevisionsDeactivateRevisionOptionalParams	Optional parameters.
ContainerAppsRevisionsGetRevisionOptionalParams	Optional parameters.
ContainerAppsRevisionsListRevisionsNextOptionalParams	Optional parameters.
ContainerAppsRevisionsListRevisionsOptionalParams	Optional parameters.
ContainerAppsRevisionsRestartRevisionOptionalParams	Optional parameters.
ContainerAppsSourceControls	Interface representing a ContainerAppsSourceControls.
ContainerAppsSourceControlsCreateOrUpdateOptionalParams	Optional parameters.
ContainerAppsSourceControlsDeleteOptionalParams	Optional parameters.
ContainerAppsSourceControlsGetOptionalParams	Optional parameters.
ContainerAppsSourceControlsListByContainerAppNextOptionalParams	Optional parameters.
ContainerAppsSourceControlsListByContainerAppOptionalParams	Optional parameters.
ContainerAppsUpdateOptionalParams	Optional parameters.
ContainerResources	Container App container resource requirements.
CookieExpiration	The configuration settings of the session cookie's expiration.
CustomDomain	Custom Domain of a Container App
CustomOpenIdConnectProvider	The configuration settings of the custom Open ID Connect provider.
CustomScaleRule	Container App container Custom scaling rule.
Dapr	Container App Dapr configuration.
DaprComponents	Interface representing a DaprComponents.
DaprComponentsCollection	Dapr Components ARM resource.
DaprComponentsCreateOrUpdateOptionalParams	Optional parameters.
DaprComponentsDeleteOptionalParams	Optional parameters.
DaprComponentsGetOptionalParams	Optional parameters.
DaprComponentsListNextOptionalParams	Optional parameters.
DaprComponentsListOptionalParams	Optional parameters.
DaprMetadata	Dapr component metadata.
DefaultAuthorizationPolicy	The configuration settings of the Azure Active Directory default authorization policy.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
EnvironmentVar	Container App container environment variable.
Facebook	The configuration settings of the Facebook provider.
ForwardProxy	The configuration settings of a forward proxy used to make the requests.
GitHub	The configuration settings of the GitHub provider.
GithubActionConfiguration	Configuration properties that define the mutable settings of a Container App SourceControl
GlobalValidation	The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.
Google	The configuration settings of the Google provider.
HttpScaleRule	Container App container Custom scaling rule.
HttpSettings	The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
HttpSettingsRoutes	The configuration settings of the paths HTTP requests.
IdentityProviders	The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
Ingress	Container App Ingress configuration.
JwtClaimChecks	The configuration settings of the checks that should be made while validating the JWT Claims.
LogAnalyticsConfiguration	Log analytics configuration
Login	The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
LoginRoutes	The routes that specify the endpoints used for login and logout requests.
LoginScopes	The configuration settings of the login flow, including the scopes that should be requested.
ManagedEnvironmentPatch	An environment for hosting container apps
ManagedEnvironmentStorageProperties	Storage properties
ManagedEnvironmentStoragesCollection	Collection of Storage for Environments
ManagedEnvironments	Interface representing a ManagedEnvironments.
ManagedEnvironmentsCollection	Collection of Environments
ManagedEnvironmentsCreateOrUpdateOptionalParams	Optional parameters.
ManagedEnvironmentsDeleteOptionalParams	Optional parameters.
ManagedEnvironmentsGetOptionalParams	Optional parameters.
ManagedEnvironmentsListByResourceGroupNextOptionalParams	Optional parameters.
ManagedEnvironmentsListByResourceGroupOptionalParams	Optional parameters.
ManagedEnvironmentsListBySubscriptionNextOptionalParams	Optional parameters.
ManagedEnvironmentsListBySubscriptionOptionalParams	Optional parameters.
ManagedEnvironmentsStorages	Interface representing a ManagedEnvironmentsStorages.
ManagedEnvironmentsStoragesCreateOrUpdateOptionalParams	Optional parameters.
ManagedEnvironmentsStoragesDeleteOptionalParams	Optional parameters.
ManagedEnvironmentsStoragesGetOptionalParams	Optional parameters.
ManagedEnvironmentsStoragesListOptionalParams	Optional parameters.
ManagedEnvironmentsUpdateOptionalParams	Optional parameters.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Nonce	The configuration settings of the nonce used in the login flow.
OpenIdConnectClientCredential	The authentication client credentials of the custom Open ID Connect provider.
OpenIdConnectConfig	The configuration settings of the endpoints used for the custom Open ID Connect provider.
OpenIdConnectLogin	The configuration settings of the login flow of the custom Open ID Connect provider.
OpenIdConnectRegistration	The configuration settings of the app registration for the custom Open ID Connect provider.
OperationDetail	Operation detail payload
OperationDisplay	Operation display payload
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
QueueScaleRule	Container App container Azure Queue based scaling rule.
RegistryCredentials	Container App Private Registry
RegistryInfo	Container App registry information.
ReplicaCollection	Container App Revision Replicas collection ARM resource.
ReplicaContainer	Container object under Container App Revision Replica.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RevisionCollection	Container App Revisions collection ARM resource.
Scale	Container App scaling configurations.
ScaleRule	Container App container scaling rule.
ScaleRuleAuth	Auth Secrets for Container App Scale Rule
Secret	Secret definition.
SecretsCollection	Container App Secrets Collection ARM resource.
SourceControlCollection	SourceControl collection ARM resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
Template	Container App versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created
TrafficWeight	Traffic weight assigned to a revision
Twitter	The configuration settings of the Twitter provider.
TwitterRegistration	The configuration settings of the app registration for the Twitter provider.
UserAssignedIdentity	User assigned identity properties
VnetConfiguration	Configuration properties for apps environment to join a Virtual Network
Volume	Volume definitions for the Container App.
VolumeMount	Volume mount for the Container App.

Type Aliases

AccessMode	Defines values for AccessMode. KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports. Known values supported by the service ReadOnly ReadWrite
ActiveRevisionsMode	Defines values for ActiveRevisionsMode. KnownActiveRevisionsMode can be used interchangeably with ActiveRevisionsMode, this enum contains the known values that the service supports. Known values supported by the service multiple single
AppProtocol	Defines values for AppProtocol. KnownAppProtocol can be used interchangeably with AppProtocol, this enum contains the known values that the service supports. Known values supported by the service http grpc
AuthConfig	Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.
BindingType	Defines values for BindingType. KnownBindingType can be used interchangeably with BindingType, this enum contains the known values that the service supports. Known values supported by the service Disabled SniEnabled
Certificate	Certificate used for Custom Domain bindings of Container Apps in a Managed Environment
CertificateProvisioningState	Defines values for CertificateProvisioningState. KnownCertificateProvisioningState can be used interchangeably with CertificateProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Canceled DeleteFailed Pending
CertificatesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CertificatesGetResponse	Contains response data for the get operation.
CertificatesListNextResponse	Contains response data for the listNext operation.
CertificatesListResponse	Contains response data for the list operation.
CertificatesUpdateResponse	Contains response data for the update operation.
ContainerApp	Container App.
ContainerAppProvisioningState	Defines values for ContainerAppProvisioningState. KnownContainerAppProvisioningState can be used interchangeably with ContainerAppProvisioningState, this enum contains the known values that the service supports. Known values supported by the service InProgress Succeeded Failed Canceled
ContainerAppsAuthConfigsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ContainerAppsAuthConfigsGetResponse	Contains response data for the get operation.
ContainerAppsAuthConfigsListByContainerAppNextResponse	Contains response data for the listByContainerAppNext operation.
ContainerAppsAuthConfigsListByContainerAppResponse	Contains response data for the listByContainerApp operation.
ContainerAppsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ContainerAppsGetResponse	Contains response data for the get operation.
ContainerAppsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ContainerAppsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ContainerAppsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ContainerAppsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ContainerAppsListCustomHostNameAnalysisResponse	Contains response data for the listCustomHostNameAnalysis operation.
ContainerAppsListSecretsResponse	Contains response data for the listSecrets operation.
ContainerAppsRevisionReplicasGetReplicaResponse	Contains response data for the getReplica operation.
ContainerAppsRevisionReplicasListReplicasResponse	Contains response data for the listReplicas operation.
ContainerAppsRevisionsGetRevisionResponse	Contains response data for the getRevision operation.
ContainerAppsRevisionsListRevisionsNextResponse	Contains response data for the listRevisionsNext operation.
ContainerAppsRevisionsListRevisionsResponse	Contains response data for the listRevisions operation.
ContainerAppsSourceControlsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ContainerAppsSourceControlsGetResponse	Contains response data for the get operation.
ContainerAppsSourceControlsListByContainerAppNextResponse	Contains response data for the listByContainerAppNext operation.
ContainerAppsSourceControlsListByContainerAppResponse	Contains response data for the listByContainerApp operation.
ContainerAppsUpdateResponse	Contains response data for the update operation.
CookieExpirationConvention	Defines values for CookieExpirationConvention.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
CustomHostnameAnalysisResult	Custom domain analysis.
DaprComponent	Dapr Component.
DaprComponentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DaprComponentsGetResponse	Contains response data for the get operation.
DaprComponentsListNextResponse	Contains response data for the listNext operation.
DaprComponentsListResponse	Contains response data for the list operation.
DnsVerificationTestResult	Defines values for DnsVerificationTestResult.
EnvironmentProvisioningState	Defines values for EnvironmentProvisioningState. KnownEnvironmentProvisioningState can be used interchangeably with EnvironmentProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Canceled Waiting InitializationInProgress InfrastructureSetupInProgress InfrastructureSetupComplete ScheduledForDelete UpgradeRequested UpgradeFailed
ForwardProxyConvention	Defines values for ForwardProxyConvention.
IngressTransportMethod	Defines values for IngressTransportMethod. KnownIngressTransportMethod can be used interchangeably with IngressTransportMethod, this enum contains the known values that the service supports. Known values supported by the service auto http http2
ManagedEnvironment	An environment for hosting container apps
ManagedEnvironmentStorage	Storage resource for managedEnvironment.
ManagedEnvironmentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ManagedEnvironmentsGetResponse	Contains response data for the get operation.
ManagedEnvironmentsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ManagedEnvironmentsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ManagedEnvironmentsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ManagedEnvironmentsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ManagedEnvironmentsStoragesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ManagedEnvironmentsStoragesGetResponse	Contains response data for the get operation.
ManagedEnvironmentsStoragesListResponse	Contains response data for the list operation.
ManagedEnvironmentsUpdateResponse	Contains response data for the update operation.
ManagedServiceIdentityType	Defines values for ManagedServiceIdentityType. KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned,UserAssigned
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Replica	Container App Revision Replica.
Revision	Container App Revision.
RevisionHealthState	Defines values for RevisionHealthState. KnownRevisionHealthState can be used interchangeably with RevisionHealthState, this enum contains the known values that the service supports. Known values supported by the service Healthy Unhealthy None
RevisionProvisioningState	Defines values for RevisionProvisioningState. KnownRevisionProvisioningState can be used interchangeably with RevisionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Provisioning Provisioned Failed Deprovisioning Deprovisioned
SourceControl	Container App SourceControl.
SourceControlOperationState	Defines values for SourceControlOperationState. KnownSourceControlOperationState can be used interchangeably with SourceControlOperationState, this enum contains the known values that the service supports. Known values supported by the service InProgress Succeeded Failed Canceled
StorageType	Defines values for StorageType. KnownStorageType can be used interchangeably with StorageType, this enum contains the known values that the service supports. Known values supported by the service AzureFile EmptyDir
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
Type	Defines values for Type. KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service liveness readiness startup
UnauthenticatedClientActionV2	Defines values for UnauthenticatedClientActionV2.

Enums

KnownAccessMode	Known values of AccessMode that the service accepts.
KnownActiveRevisionsMode	Known values of ActiveRevisionsMode that the service accepts.
KnownAppProtocol	Known values of AppProtocol that the service accepts.
KnownBindingType	Known values of BindingType that the service accepts.
KnownCertificateProvisioningState	Known values of CertificateProvisioningState that the service accepts.
KnownContainerAppProvisioningState	Known values of ContainerAppProvisioningState that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownEnvironmentProvisioningState	Known values of EnvironmentProvisioningState that the service accepts.
KnownIngressTransportMethod	Known values of IngressTransportMethod that the service accepts.
KnownManagedServiceIdentityType	Known values of ManagedServiceIdentityType that the service accepts.
KnownRevisionHealthState	Known values of RevisionHealthState that the service accepts.
KnownRevisionProvisioningState	Known values of RevisionProvisioningState that the service accepts.
KnownSourceControlOperationState	Known values of SourceControlOperationState that the service accepts.
KnownStorageType	Known values of StorageType that the service accepts.
KnownType	Known values of Type that the service accepts.