azure.mgmt.appcontainers.models module

class azure.mgmt.appcontainers.models.AccessMode(*values)[source]

Bases: str, Enum

Access mode for storage.

READ_ONLY = 'ReadOnly'
READ_WRITE = 'ReadWrite'
class azure.mgmt.appcontainers.models.Action(*values)[source]

Bases: str, Enum

Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny.

ALLOW = 'Allow'
DENY = 'Deny'
class azure.mgmt.appcontainers.models.ActiveRevisionsMode(*values)[source]

Bases: str, Enum

ActiveRevisionsMode controls how active revisions are handled for the Container app:

Multiple: multiple revisions can be active.Single: Only one

revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.</item></list>.

MULTIPLE = 'Multiple'
SINGLE = 'Single'
class azure.mgmt.appcontainers.models.Affinity(*values)[source]

Bases: str, Enum

Sticky Session Affinity.

NONE = 'none'
STICKY = 'sticky'
class azure.mgmt.appcontainers.models.AllowedAudiencesValidation(*, allowed_audiences: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Allowed Audiences validation flow.

Variables:

allowed_audiences (list[str]) – The configuration settings of the allowed list of audiences from which to validate the JWT token.

Keyword Arguments:

allowed_audiences (list[str]) – The configuration settings of the allowed list of audiences from which to validate the JWT token.

class azure.mgmt.appcontainers.models.AllowedPrincipals(*, groups: List[str] | None = None, identities: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active Directory allowed principals.

Variables:

  • groups (list[str]) – The list of the allowed groups.

  • identities (list[str]) – The list of the allowed identities.

Keyword Arguments:

  • groups (list[str]) – The list of the allowed groups.

  • identities (list[str]) – The list of the allowed identities.

class azure.mgmt.appcontainers.models.AppLogsConfiguration(*, destination: str | None = None, log_analytics_configuration: _models.LogAnalyticsConfiguration | None = None, **kwargs: Any)[source]

Bases: Model

Configuration of application logs.

Variables:

  • destination (str) – Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’.

  • log_analytics_configuration (LogAnalyticsConfiguration) – Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’.

Keyword Arguments:

  • destination (str) – Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’.

  • log_analytics_configuration (LogAnalyticsConfiguration) – Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’.

class azure.mgmt.appcontainers.models.AppProtocol(*values)[source]

Bases: str, Enum

Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http.

GRPC = 'grpc'
HTTP = 'http'
class azure.mgmt.appcontainers.models.AppRegistration(*, app_id: str | None = None, app_secret_setting_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the app registration for providers that have app ids and app secrets.

Variables:

  • app_id (str) – The App ID of the app used for login.

  • app_secret_setting_name (str) – The app setting name that contains the app secret.

Keyword Arguments:

  • app_id (str) – The App ID of the app used for login.

  • app_secret_setting_name (str) – The app setting name that contains the app secret.

class azure.mgmt.appcontainers.models.Apple(*, enabled: bool | None = None, registration: _models.AppleRegistration | None = None, login: _models.LoginScopes | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Apple provider.

Variables:

  • enabled (bool) – <code>false</code> if the Apple provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AppleRegistration) – The configuration settings of the Apple registration.

  • login (LoginScopes) – The configuration settings of the login flow.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Apple provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AppleRegistration) – The configuration settings of the Apple registration.

  • login (LoginScopes) – The configuration settings of the login flow.

class azure.mgmt.appcontainers.models.AppleRegistration(*, client_id: str | None = None, client_secret_setting_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the registration for the Apple provider.

Variables:

  • client_id (str) – The Client ID of the app used for login.

  • client_secret_setting_name (str) – The app setting name that contains the client secret.

Keyword Arguments:

  • client_id (str) – The Client ID of the app used for login.

  • client_secret_setting_name (str) – The app setting name that contains the client secret.

class azure.mgmt.appcontainers.models.Applicability(*values)[source]

Bases: str, Enum

indicates whether the profile is default for the location.

CUSTOM = 'Custom'
LOCATION_DEFAULT = 'LocationDefault'
class azure.mgmt.appcontainers.models.AuthConfig(*, platform: _models.AuthPlatform | None = None, global_validation: _models.GlobalValidation | None = None, identity_providers: _models.IdentityProviders | None = None, login: _models.Login | None = None, http_settings: _models.HttpSettings | None = None, encryption_settings: _models.EncryptionSettings | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • platform (AuthPlatform) – The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

  • global_validation (GlobalValidation) – The configuration settings that determines the validation flow of users using Service Authentication/Authorization.

  • identity_providers (IdentityProviders) – The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

  • login (Login) – The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

  • http_settings (HttpSettings) – The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

  • encryption_settings (EncryptionSettings) – The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

Keyword Arguments:

  • platform (AuthPlatform) – The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

  • global_validation (GlobalValidation) – The configuration settings that determines the validation flow of users using Service Authentication/Authorization.

  • identity_providers (IdentityProviders) – The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

  • login (Login) – The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

  • http_settings (HttpSettings) – The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

  • encryption_settings (EncryptionSettings) – The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

class azure.mgmt.appcontainers.models.AuthConfigCollection(*, value: List[_models.AuthConfig], **kwargs: Any)[source]

Bases: Model

AuthConfig collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[AuthConfig]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[AuthConfig]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.AuthPlatform(*, enabled: bool | None = None, runtime_version: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the platform of ContainerApp Service Authentication/Authorization.

Variables:

  • enabled (bool) – <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.

  • runtime_version (str) – The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

Keyword Arguments:

  • enabled (bool) – <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.

  • runtime_version (str) – The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

class azure.mgmt.appcontainers.models.AvailableOperations(*, value: List[_models.OperationDetail] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Available operations of the service.

Variables:

  • value (list[OperationDetail]) – Collection of available operation details.

  • next_link (str) – URL client should use to fetch the next page (per server side paging). It’s null for now, added for future use.

Keyword Arguments:

  • value (list[OperationDetail]) – Collection of available operation details.

  • next_link (str) – URL client should use to fetch the next page (per server side paging). It’s null for now, added for future use.

class azure.mgmt.appcontainers.models.AvailableWorkloadProfile(*, location: str | None = None, properties: _models.AvailableWorkloadProfileProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

A workload profile with specific hardware configure to run container apps.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – Region of the workload profile.

  • properties (AvailableWorkloadProfileProperties) – Revision resource specific properties.

Keyword Arguments:
class azure.mgmt.appcontainers.models.AvailableWorkloadProfileProperties(*, category: str | None = None, applicability: str | _models.Applicability | None = None, cores: int | None = None, memory_gi_b: int | None = None, gpus: int | None = None, display_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Revision resource specific properties.

Variables:

  • category (str) – Used to categorize workload profiles.

  • applicability (str or Applicability) – indicates whether the profile is default for the location. Known values are: “LocationDefault” and “Custom”.

  • cores (int) – Number of cores in CPU.

  • memory_gi_b (int) – Memory in GiB.

  • gpus (int) – Number of GPUs.

  • display_name (str) – The everyday name of the workload profile.

Keyword Arguments:

  • category (str) – Used to categorize workload profiles.

  • applicability (str or Applicability) – indicates whether the profile is default for the location. Known values are: “LocationDefault” and “Custom”.

  • cores (int) – Number of cores in CPU.

  • memory_gi_b (int) – Memory in GiB.

  • gpus (int) – Number of GPUs.

  • display_name (str) – The everyday name of the workload profile.

class azure.mgmt.appcontainers.models.AvailableWorkloadProfilesCollection(*, value: List[_models.AvailableWorkloadProfile], **kwargs: Any)[source]

Bases: Model

Collection of available workload profiles in the location.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:

value (list[AvailableWorkloadProfile]) – Collection of workload profiles. Required.

class azure.mgmt.appcontainers.models.AzureActiveDirectory(*, enabled: bool | None = None, registration: _models.AzureActiveDirectoryRegistration | None = None, login: _models.AzureActiveDirectoryLogin | None = None, validation: _models.AzureActiveDirectoryValidation | None = None, is_auto_provisioned: bool | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active directory provider.

Variables:

  • enabled (bool) – <code>false</code> if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AzureActiveDirectoryRegistration) – The configuration settings of the Azure Active Directory app registration.

  • login (AzureActiveDirectoryLogin) – The configuration settings of the Azure Active Directory login flow.

  • validation (AzureActiveDirectoryValidation) – The configuration settings of the Azure Active Directory token validation flow.

  • is_auto_provisioned (bool) – Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AzureActiveDirectoryRegistration) – The configuration settings of the Azure Active Directory app registration.

  • login (AzureActiveDirectoryLogin) – The configuration settings of the Azure Active Directory login flow.

  • validation (AzureActiveDirectoryValidation) – The configuration settings of the Azure Active Directory token validation flow.

  • is_auto_provisioned (bool) – Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property.

class azure.mgmt.appcontainers.models.AzureActiveDirectoryLogin(*, login_parameters: List[str] | None = None, disable_www_authenticate: bool | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active Directory login flow.

Variables:

  • login_parameters (list[str]) – Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

  • disable_www_authenticate (bool) – <code>true</code> if the www-authenticate provider should be omitted from the request; otherwise, <code>false</code>.

Keyword Arguments:

  • login_parameters (list[str]) – Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

  • disable_www_authenticate (bool) – <code>true</code> if the www-authenticate provider should be omitted from the request; otherwise, <code>false</code>.

class azure.mgmt.appcontainers.models.AzureActiveDirectoryRegistration(*, open_id_issuer: str | None = None, client_id: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: str | None = None, client_secret_certificate_subject_alternative_name: str | None = None, client_secret_certificate_issuer: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active Directory app registration.

Variables:

  • open_id_issuer (str) – The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.

  • client_id (str) – The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

  • client_secret_setting_name (str) – The app setting name that contains the client secret of the relying party application.

  • client_secret_certificate_thumbprint (str) – An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.

  • client_secret_certificate_subject_alternative_name (str) – An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

  • client_secret_certificate_issuer (str) – An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

Keyword Arguments:

  • open_id_issuer (str) – The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.

  • client_id (str) – The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

  • client_secret_setting_name (str) – The app setting name that contains the client secret of the relying party application.

  • client_secret_certificate_thumbprint (str) – An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.

  • client_secret_certificate_subject_alternative_name (str) – An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

  • client_secret_certificate_issuer (str) – An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

class azure.mgmt.appcontainers.models.AzureActiveDirectoryValidation(*, jwt_claim_checks: _models.JwtClaimChecks | None = None, allowed_audiences: List[str] | None = None, default_authorization_policy: _models.DefaultAuthorizationPolicy | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active Directory token validation flow.

Variables:

  • jwt_claim_checks (JwtClaimChecks) – The configuration settings of the checks that should be made while validating the JWT Claims.

  • allowed_audiences (list[str]) – The list of audiences that can make successful authentication/authorization requests.

  • default_authorization_policy (DefaultAuthorizationPolicy) – The configuration settings of the default authorization policy.

Keyword Arguments:

  • jwt_claim_checks (JwtClaimChecks) – The configuration settings of the checks that should be made while validating the JWT Claims.

  • allowed_audiences (list[str]) – The list of audiences that can make successful authentication/authorization requests.

  • default_authorization_policy (DefaultAuthorizationPolicy) – The configuration settings of the default authorization policy.

class azure.mgmt.appcontainers.models.AzureCredentials(*, client_id: str | None = None, client_secret: str | None = None, tenant_id: str | None = None, kind: str | None = None, subscription_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App credentials.

Variables:

  • client_id (str) – Client Id.

  • client_secret (str) – Client Secret.

  • tenant_id (str) – Tenant Id.

  • kind (str) – Kind of auth github does for deploying the template.

  • subscription_id (str) – Subscription Id.

Keyword Arguments:

  • client_id (str) – Client Id.

  • client_secret (str) – Client Secret.

  • tenant_id (str) – Tenant Id.

  • kind (str) – Kind of auth github does for deploying the template.

  • subscription_id (str) – Subscription Id.

class azure.mgmt.appcontainers.models.AzureFileProperties(*, account_name: str | None = None, account_key: str | None = None, access_mode: str | _models.AccessMode | None = None, share_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Azure File Properties.

Variables:

  • account_name (str) – Storage account name for azure file.

  • account_key (str) – Storage account key for azure file.

  • access_mode (str or AccessMode) – Access mode for storage. Known values are: “ReadOnly” and “ReadWrite”.

  • share_name (str) – Azure file share name.

Keyword Arguments:

  • account_name (str) – Storage account name for azure file.

  • account_key (str) – Storage account key for azure file.

  • access_mode (str or AccessMode) – Access mode for storage. Known values are: “ReadOnly” and “ReadWrite”.

  • share_name (str) – Azure file share name.

class azure.mgmt.appcontainers.models.AzureStaticWebApps(*, enabled: bool | None = None, registration: _models.AzureStaticWebAppsRegistration | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Static Web Apps provider.

Variables:

  • enabled (bool) – <code>false</code> if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AzureStaticWebAppsRegistration) – The configuration settings of the Azure Static Web Apps registration.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AzureStaticWebAppsRegistration) – The configuration settings of the Azure Static Web Apps registration.

class azure.mgmt.appcontainers.models.AzureStaticWebAppsRegistration(*, client_id: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the registration for the Azure Static Web Apps provider.

Variables:

client_id (str) – The Client ID of the app used for login.

Keyword Arguments:

client_id (str) – The Client ID of the app used for login.

class azure.mgmt.appcontainers.models.BaseContainer(*, image: str | None = None, name: str | None = None, command: List[str] | None = None, args: List[str] | None = None, env: List[_models.EnvironmentVar] | None = None, resources: _models.ContainerResources | None = None, volume_mounts: List[_models.VolumeMount] | None = None, **kwargs: Any)[source]

Bases: Model

Container App base container definition.

Variables:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

  • volume_mounts (list[VolumeMount]) – Container volume mounts.

Keyword Arguments:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

  • volume_mounts (list[VolumeMount]) – Container volume mounts.

class azure.mgmt.appcontainers.models.BillingMeter(*, location: str | None = None, properties: _models.BillingMeterProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Billing meter.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – Region for the billing meter.

  • properties (BillingMeterProperties) – Revision resource specific properties.

Keyword Arguments:

  • location (str) – Region for the billing meter.

  • properties (BillingMeterProperties) – Revision resource specific properties.

class azure.mgmt.appcontainers.models.BillingMeterCollection(*, value: List[_models.BillingMeter], **kwargs: Any)[source]

Bases: Model

Collection of billing meters.

All required parameters must be populated in order to send to server.

Variables:

value (list[BillingMeter]) – Collection of billing meters. Required.

Keyword Arguments:

value (list[BillingMeter]) – Collection of billing meters. Required.

class azure.mgmt.appcontainers.models.BillingMeterProperties(*, category: str | None = None, meter_type: str | None = None, display_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Revision resource specific properties.

Variables:

  • category (str) – Used to categorize billing meters.

  • meter_type (str) – Billing meter type.

  • display_name (str) – The everyday name of the billing meter.

Keyword Arguments:

  • category (str) – Used to categorize billing meters.

  • meter_type (str) – Billing meter type.

  • display_name (str) – The everyday name of the billing meter.

class azure.mgmt.appcontainers.models.BindingType(*values)[source]

Bases: str, Enum

Custom Domain binding type.

DISABLED = 'Disabled'
SNI_ENABLED = 'SniEnabled'
class azure.mgmt.appcontainers.models.BlobStorageTokenStore(*, sas_url_setting_name: str, **kwargs: Any)[source]

Bases: Model

The configuration settings of the storage of the tokens if blob storage is used.

All required parameters must be populated in order to send to server.

Variables:

sas_url_setting_name (str) – The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Required.

Keyword Arguments:

sas_url_setting_name (str) – The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Required.

class azure.mgmt.appcontainers.models.Certificate(*, location: str, tags: Dict[str, str] | None = None, properties: _models.CertificateProperties | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Certificate used for Custom Domain bindings of Container Apps in a Managed Environment.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (CertificateProperties) – Certificate resource specific properties.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (CertificateProperties) – Certificate resource specific properties.

class azure.mgmt.appcontainers.models.CertificateCollection(*, value: List[_models.Certificate], **kwargs: Any)[source]

Bases: Model

Collection of Certificates.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[Certificate]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[Certificate]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.CertificateKeyVaultProperties(*, identity: str | None = None, key_vault_url: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties for a certificate stored in a Key Vault.

Variables:

  • identity (str) – Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

  • key_vault_url (str) – URL pointing to the Azure Key Vault secret that holds the certificate.

Keyword Arguments:

  • identity (str) – Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

  • key_vault_url (str) – URL pointing to the Azure Key Vault secret that holds the certificate.

class azure.mgmt.appcontainers.models.CertificatePatch(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

A certificate to update.

Variables:

tags (dict[str, str]) – Application-specific metadata in the form of key-value pairs.

Keyword Arguments:

tags (dict[str, str]) – Application-specific metadata in the form of key-value pairs.

class azure.mgmt.appcontainers.models.CertificateProperties(*, certificate_key_vault_properties: _models.CertificateKeyVaultProperties | None = None, password: str | None = None, value: bytes | None = None, **kwargs: Any)[source]

Bases: Model

Certificate resource specific properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • provisioning_state (str or CertificateProvisioningState) – Provisioning state of the certificate. Known values are: “Succeeded”, “Failed”, “Canceled”, “DeleteFailed”, and “Pending”.

  • certificate_key_vault_properties (CertificateKeyVaultProperties) – Properties for a certificate stored in a Key Vault.

  • password (str) – Certificate password.

  • subject_name (str) – Subject name of the certificate.

  • subject_alternative_names (list[str]) – Subject alternative names the certificate applies to.

  • value (bytes) – PFX or PEM blob.

  • issuer (str) – Certificate issuer.

  • issue_date (datetime) – Certificate issue Date.

  • expiration_date (datetime) – Certificate expiration date.

  • thumbprint (str) – Certificate thumbprint.

  • valid (bool) – Is the certificate valid?.

  • public_key_hash (str) – Public key hash.

Keyword Arguments:

  • certificate_key_vault_properties (CertificateKeyVaultProperties) – Properties for a certificate stored in a Key Vault.

  • password (str) – Certificate password.

  • value (bytes) – PFX or PEM blob.

class azure.mgmt.appcontainers.models.CertificateProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the certificate.

CANCELED = 'Canceled'
DELETE_FAILED = 'DeleteFailed'
FAILED = 'Failed'
PENDING = 'Pending'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.CheckNameAvailabilityReason(*values)[source]

Bases: str, Enum

The reason why the given name is not available.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.appcontainers.models.CheckNameAvailabilityRequest(*, name: str | None = None, type: str | None = None, **kwargs: Any)[source]

Bases: Model

The check availability request body.

Variables:

  • name (str) – The name of the resource for which availability needs to be checked.

  • type (str) – The resource type.

Keyword Arguments:

  • name (str) – The name of the resource for which availability needs to be checked.

  • type (str) – The resource type.

class azure.mgmt.appcontainers.models.CheckNameAvailabilityResponse(*, name_available: bool | None = None, reason: str | _models.CheckNameAvailabilityReason | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

The check availability result.

Variables:

  • name_available (bool) – Indicates if the resource name is available.

  • reason (str or CheckNameAvailabilityReason) – The reason why the given name is not available. Known values are: “Invalid” and “AlreadyExists”.

  • message (str) – Detailed reason why the given name is available.

Keyword Arguments:

  • name_available (bool) – Indicates if the resource name is available.

  • reason (str or CheckNameAvailabilityReason) – The reason why the given name is not available. Known values are: “Invalid” and “AlreadyExists”.

  • message (str) – Detailed reason why the given name is available.

class azure.mgmt.appcontainers.models.ClientRegistration(*, client_id: str | None = None, client_secret_setting_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the app registration for providers that have client ids and client secrets.

Variables:

  • client_id (str) – The Client ID of the app used for login.

  • client_secret_setting_name (str) – The app setting name that contains the client secret.

Keyword Arguments:

  • client_id (str) – The Client ID of the app used for login.

  • client_secret_setting_name (str) – The app setting name that contains the client secret.

class azure.mgmt.appcontainers.models.Configuration(*, secrets: List[_models.Secret] | None = None, active_revisions_mode: str | _models.ActiveRevisionsMode = 'Single', ingress: _models.Ingress | None = None, registries: List[_models.RegistryCredentials] | None = None, dapr: _models.Dapr | None = None, runtime: _models.Runtime | None = None, max_inactive_revisions: int | None = None, service: _models.Service | None = None, identity_settings: List[_models.IdentitySettings] | None = None, **kwargs: Any)[source]

Bases: Model

Non versioned Container App configuration properties that define the mutable settings of a Container app.

Variables:

  • secrets (list[Secret]) – Collection of secrets used by a Container app.

  • active_revisions_mode (str or ActiveRevisionsMode) –

    ActiveRevisionsMode controls how active revisions are handled for the Container app:

    Multiple: multiple revisions can be active.Single: Only one

    revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.</item></list>. Known values are: “Multiple” and “Single”.

  • ingress (Ingress) – Ingress configurations.

  • registries (list[RegistryCredentials]) – Collection of private container registry credentials for containers used by the Container app.

  • dapr (Dapr) – Dapr configuration for the Container App.

  • runtime (Runtime) – App runtime configuration for the Container App.

  • max_inactive_revisions (int) – Optional. Max inactive revisions a Container App can have.

  • service (Service) – Container App to be a dev Container App Service.

  • identity_settings (list[IdentitySettings]) – Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used.

Keyword Arguments:

  • secrets (list[Secret]) – Collection of secrets used by a Container app.

  • active_revisions_mode (str or ActiveRevisionsMode) –

    ActiveRevisionsMode controls how active revisions are handled for the Container app:

    Multiple: multiple revisions can be active.Single: Only one

    revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.</item></list>. Known values are: “Multiple” and “Single”.

  • ingress (Ingress) – Ingress configurations.

  • registries (list[RegistryCredentials]) – Collection of private container registry credentials for containers used by the Container app.

  • dapr (Dapr) – Dapr configuration for the Container App.

  • runtime (Runtime) – App runtime configuration for the Container App.

  • max_inactive_revisions (int) – Optional. Max inactive revisions a Container App can have.

  • service (Service) – Container App to be a dev Container App Service.

  • identity_settings (list[IdentitySettings]) – Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used.

class azure.mgmt.appcontainers.models.ConnectedEnvironment(*, location: str, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, static_ip: str | None = None, dapr_ai_connection_string: str | None = None, custom_domain_configuration: _models.CustomDomainConfiguration | None = None, **kwargs: Any)[source]

Bases: TrackedResource

An environment for Kubernetes cluster specialized for web workloads by Azure App Service.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • extended_location (ExtendedLocation) – The complex type of the extended location.

  • provisioning_state (str or ConnectedEnvironmentProvisioningState) – Provisioning state of the Kubernetes Environment. Known values are: “Succeeded”, “Failed”, “Canceled”, “Waiting”, “InitializationInProgress”, “InfrastructureSetupInProgress”, “InfrastructureSetupComplete”, and “ScheduledForDelete”.

  • deployment_errors (str) – Any errors that occurred during deployment or deployment validation.

  • default_domain (str) – Default Domain Name for the cluster.

  • static_ip (str) – Static IP of the connectedEnvironment.

  • dapr_ai_connection_string (str) – Application Insights connection string used by Dapr to export Service to Service communication telemetry.

  • custom_domain_configuration (CustomDomainConfiguration) – Custom domain configuration for the environment.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • extended_location (ExtendedLocation) – The complex type of the extended location.

  • static_ip (str) – Static IP of the connectedEnvironment.

  • dapr_ai_connection_string (str) – Application Insights connection string used by Dapr to export Service to Service communication telemetry.

  • custom_domain_configuration (CustomDomainConfiguration) – Custom domain configuration for the environment.

class azure.mgmt.appcontainers.models.ConnectedEnvironmentCollection(*, value: List[_models.ConnectedEnvironment] | None = None, **kwargs: Any)[source]

Bases: Model

Collection of connectedEnvironments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[ConnectedEnvironment]) – Collection of resources.

class azure.mgmt.appcontainers.models.ConnectedEnvironmentProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the Kubernetes Environment.

CANCELED = 'Canceled'
FAILED = 'Failed'
INFRASTRUCTURE_SETUP_COMPLETE = 'InfrastructureSetupComplete'
INFRASTRUCTURE_SETUP_IN_PROGRESS = 'InfrastructureSetupInProgress'
INITIALIZATION_IN_PROGRESS = 'InitializationInProgress'
SCHEDULED_FOR_DELETE = 'ScheduledForDelete'
SUCCEEDED = 'Succeeded'
WAITING = 'Waiting'
class azure.mgmt.appcontainers.models.ConnectedEnvironmentStorage(*, properties: _models.ConnectedEnvironmentStorageProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Storage resource for connectedEnvironment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ConnectedEnvironmentStorageProperties) – Storage properties.

Keyword Arguments:

properties (ConnectedEnvironmentStorageProperties) – Storage properties.

class azure.mgmt.appcontainers.models.ConnectedEnvironmentStorageProperties(*, azure_file: _models.AzureFileProperties | None = None, **kwargs: Any)[source]

Bases: Model

Storage properties.

Variables:

azure_file (AzureFileProperties) – Azure file properties.

Keyword Arguments:

azure_file (AzureFileProperties) – Azure file properties.

class azure.mgmt.appcontainers.models.ConnectedEnvironmentStoragesCollection(*, value: List[_models.ConnectedEnvironmentStorage], **kwargs: Any)[source]

Bases: Model

Collection of Storage for Environments.

All required parameters must be populated in order to send to server.

Variables:

value (list[ConnectedEnvironmentStorage]) – Collection of storage resources. Required.

Keyword Arguments:

value (list[ConnectedEnvironmentStorage]) – Collection of storage resources. Required.

class azure.mgmt.appcontainers.models.Container(*, image: str | None = None, name: str | None = None, command: List[str] | None = None, args: List[str] | None = None, env: List[_models.EnvironmentVar] | None = None, resources: _models.ContainerResources | None = None, volume_mounts: List[_models.VolumeMount] | None = None, probes: List[_models.ContainerAppProbe] | None = None, **kwargs: Any)[source]

Bases: BaseContainer

Container App container definition.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.ContainerApp(*, location: str, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, identity: _models.ManagedServiceIdentity | None = None, managed_by: str | None = None, managed_environment_id: str | None = None, environment_id: str | None = None, workload_profile_name: str | None = None, configuration: _models.Configuration | None = None, template: _models.Template | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Container App.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • extended_location (ExtendedLocation) – The complex type of the extended location.

  • identity (ManagedServiceIdentity) – managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • provisioning_state (str or ContainerAppProvisioningState) – Provisioning state of the Container App. Known values are: “InProgress”, “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

  • running_status (str or ContainerAppRunningStatus) – Running status of the Container App. Known values are: “Progressing”, “Running”, “Stopped”, “Suspended”, and “Ready”.

  • managed_environment_id (str) – Deprecated. Resource ID of the Container App’s environment.

  • environment_id (str) – Resource ID of environment.

  • workload_profile_name (str) – Workload profile name to pin for container app execution.

  • latest_revision_name (str) – Name of the latest revision of the Container App.

  • latest_ready_revision_name (str) – Name of the latest ready revision of the Container App.

  • latest_revision_fqdn (str) – Fully Qualified Domain Name of the latest revision of the Container App.

  • custom_domain_verification_id (str) – Id used to verify domain name ownership.

  • configuration (Configuration) – Non versioned Container App configuration properties.

  • template (Template) – Container App versioned application definition.

  • outbound_ip_addresses (list[str]) – Outbound IP Addresses for container app.

  • event_stream_endpoint (str) – The endpoint of the eventstream of the container app.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • extended_location (ExtendedLocation) – The complex type of the extended location.

  • identity (ManagedServiceIdentity) – managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.

  • managed_by (str) – The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

  • managed_environment_id (str) – Deprecated. Resource ID of the Container App’s environment.

  • environment_id (str) – Resource ID of environment.

  • workload_profile_name (str) – Workload profile name to pin for container app execution.

  • configuration (Configuration) – Non versioned Container App configuration properties.

  • template (Template) – Container App versioned application definition.

class azure.mgmt.appcontainers.models.ContainerAppAuthToken(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Container App Auth Token.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • token (str) – Auth token value.

  • expires (datetime) – Token expiration date.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.appcontainers.models.ContainerAppCollection(*, value: List[_models.ContainerApp], **kwargs: Any)[source]

Bases: Model

Container App collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ContainerApp]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[ContainerApp]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.ContainerAppContainerRunningState(*values)[source]

Bases: str, Enum

Current running state of the container.

RUNNING = 'Running'
TERMINATED = 'Terminated'
WAITING = 'Waiting'
class azure.mgmt.appcontainers.models.ContainerAppJobExecutions(*, value: List[_models.JobExecution], **kwargs: Any)[source]

Bases: Model

Container App executions collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[JobExecution]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[JobExecution]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.ContainerAppProbe(*, failure_threshold: int | None = None, http_get: _models.ContainerAppProbeHttpGet | None = None, initial_delay_seconds: int | None = None, period_seconds: int | None = None, success_threshold: int | None = None, tcp_socket: _models.ContainerAppProbeTcpSocket | None = None, termination_grace_period_seconds: int | None = None, timeout_seconds: int | None = None, type: str | _models.Type | None = None, **kwargs: Any)[source]

Bases: Model

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Variables:

  • failure_threshold (int) – Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.

  • http_get (ContainerAppProbeHttpGet) – HTTPGet specifies the http request to perform.

  • initial_delay_seconds (int) – Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.

  • period_seconds (int) – How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.

  • success_threshold (int) – Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.

  • tcp_socket (ContainerAppProbeTcpSocket) – TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

  • termination_grace_period_seconds (int) – Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).

  • timeout_seconds (int) – Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.

  • type (str or Type) – The type of probe. Known values are: “Liveness”, “Readiness”, and “Startup”.

Keyword Arguments:

  • failure_threshold (int) – Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.

  • http_get (ContainerAppProbeHttpGet) – HTTPGet specifies the http request to perform.

  • initial_delay_seconds (int) – Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.

  • period_seconds (int) – How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.

  • success_threshold (int) – Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.

  • tcp_socket (ContainerAppProbeTcpSocket) – TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

  • termination_grace_period_seconds (int) – Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour).

  • timeout_seconds (int) – Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.

  • type (str or Type) – The type of probe. Known values are: “Liveness”, “Readiness”, and “Startup”.

class azure.mgmt.appcontainers.models.ContainerAppProbeHttpGet(*, port: int, host: str | None = None, http_headers: List[_models.ContainerAppProbeHttpGetHttpHeadersItem] | None = None, path: str | None = None, scheme: str | _models.Scheme | None = None, **kwargs: Any)[source]

Bases: Model

HTTPGet specifies the http request to perform.

All required parameters must be populated in order to send to server.

Variables:

  • host (str) – Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

  • http_headers (list[ContainerAppProbeHttpGetHttpHeadersItem]) – Custom headers to set in the request. HTTP allows repeated headers.

  • path (str) – Path to access on the HTTP server.

  • port (int) – Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. Required.

  • scheme (str or Scheme) – Scheme to use for connecting to the host. Defaults to HTTP. Known values are: “HTTP” and “HTTPS”.

Keyword Arguments:

  • host (str) – Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead.

  • http_headers (list[ContainerAppProbeHttpGetHttpHeadersItem]) – Custom headers to set in the request. HTTP allows repeated headers.

  • path (str) – Path to access on the HTTP server.

  • port (int) – Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. Required.

  • scheme (str or Scheme) – Scheme to use for connecting to the host. Defaults to HTTP. Known values are: “HTTP” and “HTTPS”.

class azure.mgmt.appcontainers.models.ContainerAppProbeHttpGetHttpHeadersItem(*, name: str, value: str, **kwargs: Any)[source]

Bases: Model

HTTPHeader describes a custom header to be used in HTTP probes.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The header field name. Required.

  • value (str) – The header field value. Required.

Keyword Arguments:

  • name (str) – The header field name. Required.

  • value (str) – The header field value. Required.

class azure.mgmt.appcontainers.models.ContainerAppProbeTcpSocket(*, port: int, host: str | None = None, **kwargs: Any)[source]

Bases: Model

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.

All required parameters must be populated in order to send to server.

Variables:

  • host (str) – Optional: Host name to connect to, defaults to the pod IP.

  • port (int) – Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. Required.

Keyword Arguments:

  • host (str) – Optional: Host name to connect to, defaults to the pod IP.

  • port (int) – Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. Required.

class azure.mgmt.appcontainers.models.ContainerAppProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the Container App.

CANCELED = 'Canceled'
DELETING = 'Deleting'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.ContainerAppReplicaRunningState(*values)[source]

Bases: str, Enum

Current running state of the replica.

NOT_RUNNING = 'NotRunning'
RUNNING = 'Running'
UNKNOWN = 'Unknown'
class azure.mgmt.appcontainers.models.ContainerAppRunningStatus(*values)[source]

Bases: str, Enum

Running status of the Container App.

PROGRESSING = 'Progressing'

Container App is transitioning between Stopped and Running states.

READY = 'Ready'

Container App Job is in Ready state.

RUNNING = 'Running'

Container App is in Running state.

STOPPED = 'Stopped'

Container App is in Stopped state.

SUSPENDED = 'Suspended'

Container App Job is in Suspended state.

class azure.mgmt.appcontainers.models.ContainerAppSecret(**kwargs: Any)[source]

Bases: Model

Container App Secret.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

  • identity (str) – Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

  • key_vault_url (str) – Azure Key Vault URL pointing to the secret referenced by the container app.

class azure.mgmt.appcontainers.models.ContainerResources(*, cpu: float | None = None, memory: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container resource requirements.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • cpu (float) – Required CPU in cores, e.g. 0.5.

  • memory (str) – Required memory, e.g. “250Mb”.

  • ephemeral_storage (str) – Ephemeral Storage, e.g. “1Gi”.

Keyword Arguments:

  • cpu (float) – Required CPU in cores, e.g. 0.5.

  • memory (str) – Required memory, e.g. “250Mb”.

class azure.mgmt.appcontainers.models.ContainerType(*values)[source]

Bases: str, Enum

The container type of the sessions.

CUSTOM_CONTAINER = 'CustomContainer'
PYTHON_LTS = 'PythonLTS'
class azure.mgmt.appcontainers.models.CookieExpiration(*, convention: str | _models.CookieExpirationConvention | None = None, time_to_expiration: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the session cookie’s expiration.

Variables:

  • convention (str or CookieExpirationConvention) – The convention used when determining the session cookie’s expiration. Known values are: “FixedTime” and “IdentityProviderDerived”.

  • time_to_expiration (str) – The time after the request is made when the session cookie should expire.

Keyword Arguments:

  • convention (str or CookieExpirationConvention) – The convention used when determining the session cookie’s expiration. Known values are: “FixedTime” and “IdentityProviderDerived”.

  • time_to_expiration (str) – The time after the request is made when the session cookie should expire.

class azure.mgmt.appcontainers.models.CookieExpirationConvention(*values)[source]

Bases: str, Enum

The convention used when determining the session cookie’s expiration.

FIXED_TIME = 'FixedTime'
IDENTITY_PROVIDER_DERIVED = 'IdentityProviderDerived'
class azure.mgmt.appcontainers.models.CorsPolicy(*, allowed_origins: List[str], allowed_methods: List[str] | None = None, allowed_headers: List[str] | None = None, expose_headers: List[str] | None = None, max_age: int | None = None, allow_credentials: bool | None = None, **kwargs: Any)[source]

Bases: Model

Cross-Origin-Resource-Sharing policy.

All required parameters must be populated in order to send to server.

Variables:

  • allowed_origins (list[str]) – Specifies the content for the access-control-allow-origins header. Required.

  • allowed_methods (list[str]) – Specifies the content for the access-control-allow-methods header.

  • allowed_headers (list[str]) – Specifies the content for the access-control-allow-headers header.

  • expose_headers (list[str]) – Specifies the content for the access-control-expose-headers header.

  • max_age (int) – Specifies the content for the access-control-max-age header.

  • allow_credentials (bool) – Specifies whether the resource allows credentials.

Keyword Arguments:

  • allowed_origins (list[str]) – Specifies the content for the access-control-allow-origins header. Required.

  • allowed_methods (list[str]) – Specifies the content for the access-control-allow-methods header.

  • allowed_headers (list[str]) – Specifies the content for the access-control-allow-headers header.

  • expose_headers (list[str]) – Specifies the content for the access-control-expose-headers header.

  • max_age (int) – Specifies the content for the access-control-max-age header.

  • allow_credentials (bool) – Specifies whether the resource allows credentials.

class azure.mgmt.appcontainers.models.CreatedByType(*values)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.appcontainers.models.CustomContainerTemplate(*, registry_credentials: _models.SessionRegistryCredentials | None = None, containers: List[_models.SessionContainer] | None = None, ingress: _models.SessionIngress | None = None, **kwargs: Any)[source]

Bases: Model

Custom container configuration.

Variables:

  • registry_credentials (SessionRegistryCredentials) – Private container registry credentials for containers used by the sessions of the session pool.

  • containers (list[SessionContainer]) – List of container definitions for the sessions of the session pool.

  • ingress (SessionIngress) – Session pool ingress configuration.

Keyword Arguments:

  • registry_credentials (SessionRegistryCredentials) – Private container registry credentials for containers used by the sessions of the session pool.

  • containers (list[SessionContainer]) – List of container definitions for the sessions of the session pool.

  • ingress (SessionIngress) – Session pool ingress configuration.

class azure.mgmt.appcontainers.models.CustomDomain(*, name: str, binding_type: str | _models.BindingType | None = None, certificate_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Custom Domain of a Container App.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – Hostname. Required.

  • binding_type (str or BindingType) – Custom Domain binding type. Known values are: “Disabled” and “SniEnabled”.

  • certificate_id (str) – Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.

Keyword Arguments:

  • name (str) – Hostname. Required.

  • binding_type (str or BindingType) – Custom Domain binding type. Known values are: “Disabled” and “SniEnabled”.

  • certificate_id (str) – Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.

class azure.mgmt.appcontainers.models.CustomDomainConfiguration(*, dns_suffix: str | None = None, certificate_key_vault_properties: _models.CertificateKeyVaultProperties | None = None, certificate_value: bytes | None = None, certificate_password: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration properties for apps environment custom domain.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • custom_domain_verification_id (str) – Id used to verify domain name ownership.

  • dns_suffix (str) – Dns suffix for the environment domain.

  • certificate_key_vault_properties (CertificateKeyVaultProperties) – Certificate stored in Azure Key Vault.

  • certificate_value (bytes) – PFX or PEM blob.

  • certificate_password (str) – Certificate password.

  • expiration_date (datetime) – Certificate expiration date.

  • thumbprint (str) – Certificate thumbprint.

  • subject_name (str) – Subject name of the certificate.

Keyword Arguments:

  • dns_suffix (str) – Dns suffix for the environment domain.

  • certificate_key_vault_properties (CertificateKeyVaultProperties) – Certificate stored in Azure Key Vault.

  • certificate_value (bytes) – PFX or PEM blob.

  • certificate_password (str) – Certificate password.

class azure.mgmt.appcontainers.models.CustomHostnameAnalysisResult(*, c_name_records: List[str] | None = None, txt_records: List[str] | None = None, a_records: List[str] | None = None, alternate_c_name_records: List[str] | None = None, alternate_txt_records: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Custom domain analysis.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • host_name (str) – Host name that was analyzed.

  • is_hostname_already_verified (bool) – <code>true</code> if hostname is already verified; otherwise, <code>false</code>.

  • custom_domain_verification_test (str or DnsVerificationTestResult) – DNS verification test result. Known values are: “Passed”, “Failed”, and “Skipped”.

  • custom_domain_verification_failure_info (CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo) – Raw failure information if DNS verification fails.

  • has_conflict_on_managed_environment (bool) – <code>true</code> if there is a conflict on the Container App’s managed environment; otherwise, <code>false</code>.

  • conflict_with_environment_custom_domain (bool) – <code>true</code> if there is a conflict on the Container App’s managed environment level custom domain; otherwise, <code>false</code>.

  • conflicting_container_app_resource_id (str) – Name of the conflicting Container App on the Managed Environment if it’s within the same subscription.

  • c_name_records (list[str]) – CName records visible for this hostname.

  • txt_records (list[str]) – TXT records visible for this hostname.

  • a_records (list[str]) – A records visible for this hostname.

  • alternate_c_name_records (list[str]) – Alternate CName records visible for this hostname.

  • alternate_txt_records (list[str]) – Alternate TXT records visible for this hostname.

Keyword Arguments:

  • c_name_records (list[str]) – CName records visible for this hostname.

  • txt_records (list[str]) – TXT records visible for this hostname.

  • a_records (list[str]) – A records visible for this hostname.

  • alternate_c_name_records (list[str]) – Alternate CName records visible for this hostname.

  • alternate_txt_records (list[str]) – Alternate TXT records visible for this hostname.

class azure.mgmt.appcontainers.models.CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo(*, details: List[_models.CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem] | None = None, **kwargs: Any)[source]

Bases: Model

Raw failure information if DNS verification fails.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

details (list[CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem] # pylint: disable=line-too-long) – Details or the error.

class azure.mgmt.appcontainers.models.CustomHostnameAnalysisResultCustomDomainVerificationFailureInfoDetailsItem(**kwargs: Any)[source]

Bases: Model

Detailed errors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • code (str) – Standardized string to programmatically identify the error.

  • message (str) – Detailed error description and debugging information.

  • target (str) – Detailed error description and debugging information.

class azure.mgmt.appcontainers.models.CustomOpenIdConnectProvider(*, enabled: bool | None = None, registration: _models.OpenIdConnectRegistration | None = None, login: _models.OpenIdConnectLogin | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the custom Open ID Connect provider.

Variables:

  • enabled (bool) – <code>false</code> if the custom Open ID provider provider should not be enabled; otherwise, <code>true</code>.

  • registration (OpenIdConnectRegistration) – The configuration settings of the app registration for the custom Open ID Connect provider.

  • login (OpenIdConnectLogin) – The configuration settings of the login flow of the custom Open ID Connect provider.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the custom Open ID provider provider should not be enabled; otherwise, <code>true</code>.

  • registration (OpenIdConnectRegistration) – The configuration settings of the app registration for the custom Open ID Connect provider.

  • login (OpenIdConnectLogin) – The configuration settings of the login flow of the custom Open ID Connect provider.

class azure.mgmt.appcontainers.models.CustomScaleRule(*, type: str | None = None, metadata: Dict[str, str] | None = None, auth: List[_models.ScaleRuleAuth] | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container Custom scaling rule.

Variables:

  • type (str) – Type of the custom scale rule eg: azure-servicebus, redis etc.

  • metadata (dict[str, str]) – Metadata properties to describe custom scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the custom scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

Keyword Arguments:

  • type (str) – Type of the custom scale rule eg: azure-servicebus, redis etc.

  • metadata (dict[str, str]) – Metadata properties to describe custom scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the custom scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

class azure.mgmt.appcontainers.models.Dapr(*, enabled: bool = False, app_id: str | None = None, app_protocol: str | _models.AppProtocol = 'http', app_port: int | None = None, http_read_buffer_size: int | None = None, http_max_request_size: int | None = None, log_level: str | _models.LogLevel | None = None, enable_api_logging: bool | None = None, **kwargs: Any)[source]

Bases: Model

Container App Dapr configuration.

Variables:

  • enabled (bool) – Boolean indicating if the Dapr side car is enabled.

  • app_id (str) – Dapr application identifier.

  • app_protocol (str or AppProtocol) – Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http. Known values are: “http” and “grpc”.

  • app_port (int) – Tells Dapr which port your application is listening on.

  • http_read_buffer_size (int) – Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.

  • http_max_request_size (int) – Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.

  • log_level (str or LogLevel) – Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. Known values are: “info”, “debug”, “warn”, and “error”.

  • enable_api_logging (bool) – Enables API logging for the Dapr sidecar.

Keyword Arguments:

  • enabled (bool) – Boolean indicating if the Dapr side car is enabled.

  • app_id (str) – Dapr application identifier.

  • app_protocol (str or AppProtocol) – Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http. Known values are: “http” and “grpc”.

  • app_port (int) – Tells Dapr which port your application is listening on.

  • http_read_buffer_size (int) – Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.

  • http_max_request_size (int) – Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.

  • log_level (str or LogLevel) – Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. Known values are: “info”, “debug”, “warn”, and “error”.

  • enable_api_logging (bool) – Enables API logging for the Dapr sidecar.

class azure.mgmt.appcontainers.models.DaprComponent(*, component_type: str | None = None, version: str | None = None, ignore_errors: bool = False, init_timeout: str | None = None, secrets: List[_models.Secret] | None = None, secret_store_component: str | None = None, metadata: List[_models.DaprMetadata] | None = None, scopes: List[str] | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Dapr Component.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • component_type (str) – Component type.

  • version (str) – Component version.

  • ignore_errors (bool) – Boolean describing if the component errors are ignores.

  • init_timeout (str) – Initialization timeout.

  • secrets (list[Secret]) – Collection of secrets used by a Dapr component.

  • secret_store_component (str) – Name of a Dapr component to retrieve component secrets from.

  • metadata (list[DaprMetadata]) – Component metadata.

  • scopes (list[str]) – Names of container apps that can use this Dapr component.

Keyword Arguments:

  • component_type (str) – Component type.

  • version (str) – Component version.

  • ignore_errors (bool) – Boolean describing if the component errors are ignores.

  • init_timeout (str) – Initialization timeout.

  • secrets (list[Secret]) – Collection of secrets used by a Dapr component.

  • secret_store_component (str) – Name of a Dapr component to retrieve component secrets from.

  • metadata (list[DaprMetadata]) – Component metadata.

  • scopes (list[str]) – Names of container apps that can use this Dapr component.

class azure.mgmt.appcontainers.models.DaprComponentsCollection(*, value: List[_models.DaprComponent], **kwargs: Any)[source]

Bases: Model

Dapr Components ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[DaprComponent]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[DaprComponent]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.DaprConfiguration(**kwargs: Any)[source]

Bases: Model

Configuration properties Dapr component.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

version (str) – The version of Dapr.

class azure.mgmt.appcontainers.models.DaprMetadata(*, name: str | None = None, value: str | None = None, secret_ref: str | None = None, **kwargs: Any)[source]

Bases: Model

Dapr component metadata.

Variables:

  • name (str) – Metadata property name.

  • value (str) – Metadata property value.

  • secret_ref (str) – Name of the Dapr Component secret from which to pull the metadata property value.

Keyword Arguments:

  • name (str) – Metadata property name.

  • value (str) – Metadata property value.

  • secret_ref (str) – Name of the Dapr Component secret from which to pull the metadata property value.

class azure.mgmt.appcontainers.models.DaprSecret(**kwargs: Any)[source]

Bases: Model

Dapr component Secret for ListSecrets Action.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

class azure.mgmt.appcontainers.models.DaprSecretsCollection(*, value: List[_models.DaprSecret], **kwargs: Any)[source]

Bases: Model

Dapr component Secrets Collection for ListSecrets Action.

All required parameters must be populated in order to send to server.

Variables:

value (list[DaprSecret]) – Collection of secrets used by a Dapr component. Required.

Keyword Arguments:

value (list[DaprSecret]) – Collection of secrets used by a Dapr component. Required.

class azure.mgmt.appcontainers.models.DefaultAuthorizationPolicy(*, allowed_principals: _models.AllowedPrincipals | None = None, allowed_applications: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Azure Active Directory default authorization policy.

Variables:

  • allowed_principals (AllowedPrincipals) – The configuration settings of the Azure Active Directory allowed principals.

  • allowed_applications (list[str]) – The configuration settings of the Azure Active Directory allowed applications.

Keyword Arguments:

  • allowed_principals (AllowedPrincipals) – The configuration settings of the Azure Active Directory allowed principals.

  • allowed_applications (list[str]) – The configuration settings of the Azure Active Directory allowed applications.

class azure.mgmt.appcontainers.models.DefaultErrorResponse(**kwargs: Any)[source]

Bases: Model

App Service error response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

error (DefaultErrorResponseError) – Error model.

class azure.mgmt.appcontainers.models.DefaultErrorResponseError(*, details: List[_models.DefaultErrorResponseErrorDetailsItem] | None = None, **kwargs: Any)[source]

Bases: Model

Error model.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • code (str) – Standardized string to programmatically identify the error.

  • message (str) – Detailed error description and debugging information.

  • target (str) – Detailed error description and debugging information.

  • details (list[DefaultErrorResponseErrorDetailsItem]) – Details or the error.

  • innererror (str) – More information to debug error.

Keyword Arguments:

details (list[DefaultErrorResponseErrorDetailsItem]) – Details or the error.

class azure.mgmt.appcontainers.models.DefaultErrorResponseErrorDetailsItem(**kwargs: Any)[source]

Bases: Model

Detailed errors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • code (str) – Standardized string to programmatically identify the error.

  • message (str) – Detailed error description and debugging information.

  • target (str) – Detailed error description and debugging information.

class azure.mgmt.appcontainers.models.DiagnosticDataProviderMetadata(*, provider_name: str | None = None, property_bag: List[_models.DiagnosticDataProviderMetadataPropertyBagItem] | None = None, **kwargs: Any)[source]

Bases: Model

Details of a diagnostics data provider.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.DiagnosticDataProviderMetadataPropertyBagItem(*, name: str | None = None, value: str | None = None, **kwargs: Any)[source]

Bases: Model

Property details.

Variables:

  • name (str) – Property name.

  • value (str) – Property value.

Keyword Arguments:

  • name (str) – Property name.

  • value (str) – Property value.

class azure.mgmt.appcontainers.models.DiagnosticDataTableResponseColumn(*, column_name: str | None = None, data_type: str | None = None, column_type: str | None = None, **kwargs: Any)[source]

Bases: Model

Diagnostics data column.

Variables:

  • column_name (str) – Column name.

  • data_type (str) – Data type of the column.

  • column_type (str) – Column type.

Keyword Arguments:

  • column_name (str) – Column name.

  • data_type (str) – Data type of the column.

  • column_type (str) – Column type.

class azure.mgmt.appcontainers.models.DiagnosticDataTableResponseObject(*, table_name: str | None = None, columns: List[_models.DiagnosticDataTableResponseColumn] | None = None, rows: List[MutableMapping[str, Any]] | None = None, **kwargs: Any)[source]

Bases: Model

Diagnostics data table.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.DiagnosticRendering(*, type: int | None = None, title: str | None = None, description: str | None = None, is_visible: bool | None = None, **kwargs: Any)[source]

Bases: Model

Rendering details of a diagnostics table.

Variables:

  • type (int) – Rendering type.

  • title (str) – Title of the table.

  • description (str) – Description of the table.

  • is_visible (bool) – Flag if the table should be rendered.

Keyword Arguments:

  • type (int) – Rendering type.

  • title (str) – Title of the table.

  • description (str) – Description of the table.

  • is_visible (bool) – Flag if the table should be rendered.

class azure.mgmt.appcontainers.models.DiagnosticSupportTopic(**kwargs: Any)[source]

Bases: Model

Support topic information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Unique topic identifier.

  • pes_id (str) – PES identifier.

class azure.mgmt.appcontainers.models.Diagnostics(*, properties: _models.DiagnosticsProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Diagnostics data for a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (DiagnosticsProperties) – Diagnostics resource specific properties.

Keyword Arguments:

properties (DiagnosticsProperties) – Diagnostics resource specific properties.

class azure.mgmt.appcontainers.models.DiagnosticsCollection(*, value: List[_models.Diagnostics], **kwargs: Any)[source]

Bases: Model

Diagnostics data collection for a resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[Diagnostics]) – Collection of diagnostic data. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[Diagnostics]) – Collection of diagnostic data. Required.

class azure.mgmt.appcontainers.models.DiagnosticsDataApiResponse(*, table: _models.DiagnosticDataTableResponseObject | None = None, rendering_properties: _models.DiagnosticRendering | None = None, **kwargs: Any)[source]

Bases: Model

Diagnostics data returned from a detector.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.DiagnosticsDefinition(*, support_topic_list: List[_models.DiagnosticSupportTopic] | None = None, analysis_types: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Metadata of the diagnostics response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Unique detector name.

  • name (str) – Display Name of the detector.

  • description (str) – Details of the diagnostics info.

  • author (str) – Authors’ names of the detector.

  • category (str) – Category of the detector.

  • support_topic_list (list[DiagnosticSupportTopic]) – List of support topics.

  • analysis_types (list[str]) – List of analysis types.

  • type (str) – Authors’ names of the detector.

  • score (float) – Authors’ names of the detector.

Keyword Arguments:
class azure.mgmt.appcontainers.models.DiagnosticsProperties(*, metadata: _models.DiagnosticsDefinition | None = None, dataset: List[_models.DiagnosticsDataApiResponse] | None = None, status: _models.DiagnosticsStatus | None = None, data_provider_metadata: _models.DiagnosticDataProviderMetadata | None = None, **kwargs: Any)[source]

Bases: Model

Diagnostics resource specific properties.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.DiagnosticsStatus(*, message: str | None = None, status_id: int | None = None, **kwargs: Any)[source]

Bases: Model

Rendering details of a diagnostics table.

Variables:

  • message (str) – Diagnostic message.

  • status_id (int) – Status.

Keyword Arguments:

  • message (str) – Diagnostic message.

  • status_id (int) – Status.

class azure.mgmt.appcontainers.models.DnsVerificationTestResult(*values)[source]

Bases: str, Enum

DNS verification test result.

FAILED = 'Failed'
PASSED = 'Passed'
SKIPPED = 'Skipped'
class azure.mgmt.appcontainers.models.DynamicPoolConfiguration(*, lifecycle_configuration: _models.LifecycleConfiguration | None = None, **kwargs: Any)[source]

Bases: Model

Dynamic pool configuration.

Variables:

lifecycle_configuration (LifecycleConfiguration) – The lifecycle configuration of a session in the dynamic session pool.

Keyword Arguments:

lifecycle_configuration (LifecycleConfiguration) – The lifecycle configuration of a session in the dynamic session pool.

class azure.mgmt.appcontainers.models.EncryptionSettings(*, container_app_auth_encryption_secret_name: str | None = None, container_app_auth_signing_secret_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.

Variables:

  • container_app_auth_encryption_secret_name (str) – The secret name which is referenced for EncryptionKey.

  • container_app_auth_signing_secret_name (str) – The secret name which is referenced for SigningKey.

Keyword Arguments:

  • container_app_auth_encryption_secret_name (str) – The secret name which is referenced for EncryptionKey.

  • container_app_auth_signing_secret_name (str) – The secret name which is referenced for SigningKey.

class azure.mgmt.appcontainers.models.EnvironmentAuthToken(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Environment Auth Token.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • token (str) – Auth token value.

  • expires (datetime) – Token expiration date.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.appcontainers.models.EnvironmentProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the Environment.

CANCELED = 'Canceled'
FAILED = 'Failed'
INFRASTRUCTURE_SETUP_COMPLETE = 'InfrastructureSetupComplete'
INFRASTRUCTURE_SETUP_IN_PROGRESS = 'InfrastructureSetupInProgress'
INITIALIZATION_IN_PROGRESS = 'InitializationInProgress'
SCHEDULED_FOR_DELETE = 'ScheduledForDelete'
SUCCEEDED = 'Succeeded'
UPGRADE_FAILED = 'UpgradeFailed'
UPGRADE_REQUESTED = 'UpgradeRequested'
WAITING = 'Waiting'
class azure.mgmt.appcontainers.models.EnvironmentVar(*, name: str | None = None, value: str | None = None, secret_ref: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container environment variable.

Variables:

  • name (str) – Environment variable name.

  • value (str) – Non-secret environment variable value.

  • secret_ref (str) – Name of the Container App secret from which to pull the environment variable value.

Keyword Arguments:

  • name (str) – Environment variable name.

  • value (str) – Non-secret environment variable value.

  • secret_ref (str) – Name of the Container App secret from which to pull the environment variable value.

class azure.mgmt.appcontainers.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.appcontainers.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.appcontainers.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:

error (ErrorDetail) – The error object.

Keyword Arguments:

error (ErrorDetail) – The error object.

class azure.mgmt.appcontainers.models.ExtendedLocation(*, name: str | None = None, type: str | _models.ExtendedLocationTypes | None = None, **kwargs: Any)[source]

Bases: Model

The complex type of the extended location.

Variables:

  • name (str) – The name of the extended location.

  • type (str or ExtendedLocationTypes) – The type of the extended location. “CustomLocation”

Keyword Arguments:

  • name (str) – The name of the extended location.

  • type (str or ExtendedLocationTypes) – The type of the extended location. “CustomLocation”

class azure.mgmt.appcontainers.models.ExtendedLocationTypes(*values)[source]

Bases: str, Enum

The type of extendedLocation.

CUSTOM_LOCATION = 'CustomLocation'
class azure.mgmt.appcontainers.models.Facebook(*, enabled: bool | None = None, registration: _models.AppRegistration | None = None, graph_api_version: str | None = None, login: _models.LoginScopes | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Facebook provider.

Variables:

  • enabled (bool) – <code>false</code> if the Facebook provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AppRegistration) – The configuration settings of the app registration for the Facebook provider.

  • graph_api_version (str) – The version of the Facebook api to be used while logging in.

  • login (LoginScopes) – The configuration settings of the login flow.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Facebook provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (AppRegistration) – The configuration settings of the app registration for the Facebook provider.

  • graph_api_version (str) – The version of the Facebook api to be used while logging in.

  • login (LoginScopes) – The configuration settings of the login flow.

class azure.mgmt.appcontainers.models.ForwardProxy(*, convention: str | _models.ForwardProxyConvention | None = None, custom_host_header_name: str | None = None, custom_proto_header_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of a forward proxy used to make the requests.

Variables:

  • convention (str or ForwardProxyConvention) – The convention used to determine the url of the request made. Known values are: “NoProxy”, “Standard”, and “Custom”.

  • custom_host_header_name (str) – The name of the header containing the host of the request.

  • custom_proto_header_name (str) – The name of the header containing the scheme of the request.

Keyword Arguments:

  • convention (str or ForwardProxyConvention) – The convention used to determine the url of the request made. Known values are: “NoProxy”, “Standard”, and “Custom”.

  • custom_host_header_name (str) – The name of the header containing the host of the request.

  • custom_proto_header_name (str) – The name of the header containing the scheme of the request.

class azure.mgmt.appcontainers.models.ForwardProxyConvention(*values)[source]

Bases: str, Enum

The convention used to determine the url of the request made.

CUSTOM = 'Custom'
NO_PROXY = 'NoProxy'
STANDARD = 'Standard'
class azure.mgmt.appcontainers.models.GitHub(*, enabled: bool | None = None, registration: _models.ClientRegistration | None = None, login: _models.LoginScopes | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the GitHub provider.

Variables:

  • enabled (bool) – <code>false</code> if the GitHub provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (ClientRegistration) – The configuration settings of the app registration for the GitHub provider.

  • login (LoginScopes) – The configuration settings of the login flow.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the GitHub provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (ClientRegistration) – The configuration settings of the app registration for the GitHub provider.

  • login (LoginScopes) – The configuration settings of the login flow.

class azure.mgmt.appcontainers.models.GithubActionConfiguration(*, registry_info: _models.RegistryInfo | None = None, azure_credentials: _models.AzureCredentials | None = None, context_path: str | None = None, github_personal_access_token: str | None = None, image: str | None = None, publish_type: str | None = None, os: str | None = None, runtime_stack: str | None = None, runtime_version: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration properties that define the mutable settings of a Container App SourceControl.

Variables:

  • registry_info (RegistryInfo) – Registry configurations.

  • azure_credentials (AzureCredentials) – AzureCredentials configurations.

  • context_path (str) – Context path.

  • github_personal_access_token (str) – One time Github PAT to configure github environment.

  • image (str) – Image name.

  • publish_type (str) – Code or Image.

  • os (str) – Operation system.

  • runtime_stack (str) – Runtime stack.

  • runtime_version (str) – Runtime version.

Keyword Arguments:

  • registry_info (RegistryInfo) – Registry configurations.

  • azure_credentials (AzureCredentials) – AzureCredentials configurations.

  • context_path (str) – Context path.

  • github_personal_access_token (str) – One time Github PAT to configure github environment.

  • image (str) – Image name.

  • publish_type (str) – Code or Image.

  • os (str) – Operation system.

  • runtime_stack (str) – Runtime stack.

  • runtime_version (str) – Runtime version.

class azure.mgmt.appcontainers.models.GlobalValidation(*, unauthenticated_client_action: str | _models.UnauthenticatedClientActionV2 | None = None, redirect_to_provider: str | None = None, excluded_paths: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.

Variables:

  • unauthenticated_client_action (str or UnauthenticatedClientActionV2) – The action to take when an unauthenticated client attempts to access the app. Known values are: “RedirectToLoginPage”, “AllowAnonymous”, “Return401”, and “Return403”.

  • redirect_to_provider (str) – The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to “RedirectToLoginPage”.

  • excluded_paths (list[str]) – The paths for which unauthenticated flow would not be redirected to the login page.

Keyword Arguments:

  • unauthenticated_client_action (str or UnauthenticatedClientActionV2) – The action to take when an unauthenticated client attempts to access the app. Known values are: “RedirectToLoginPage”, “AllowAnonymous”, “Return401”, and “Return403”.

  • redirect_to_provider (str) – The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to “RedirectToLoginPage”.

  • excluded_paths (list[str]) – The paths for which unauthenticated flow would not be redirected to the login page.

class azure.mgmt.appcontainers.models.Google(*, enabled: bool | None = None, registration: _models.ClientRegistration | None = None, login: _models.LoginScopes | None = None, validation: _models.AllowedAudiencesValidation | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Google provider.

Variables:

  • enabled (bool) – <code>false</code> if the Google provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (ClientRegistration) – The configuration settings of the app registration for the Google provider.

  • login (LoginScopes) – The configuration settings of the login flow.

  • validation (AllowedAudiencesValidation) – The configuration settings of the Azure Active Directory token validation flow.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Google provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (ClientRegistration) – The configuration settings of the app registration for the Google provider.

  • login (LoginScopes) – The configuration settings of the login flow.

  • validation (AllowedAudiencesValidation) – The configuration settings of the Azure Active Directory token validation flow.

class azure.mgmt.appcontainers.models.HttpScaleRule(*, metadata: Dict[str, str] | None = None, auth: List[_models.ScaleRuleAuth] | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container Http scaling rule.

Variables:

  • metadata (dict[str, str]) – Metadata properties to describe http scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the custom scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

Keyword Arguments:

  • metadata (dict[str, str]) – Metadata properties to describe http scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the custom scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

class azure.mgmt.appcontainers.models.HttpSettings(*, require_https: bool | None = None, routes: _models.HttpSettingsRoutes | None = None, forward_proxy: _models.ForwardProxy | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.

Variables:

  • require_https (bool) – <code>false</code> if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, <code>true</code>.

  • routes (HttpSettingsRoutes) – The configuration settings of the paths HTTP requests.

  • forward_proxy (ForwardProxy) – The configuration settings of a forward proxy used to make the requests.

Keyword Arguments:

  • require_https (bool) – <code>false</code> if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, <code>true</code>.

  • routes (HttpSettingsRoutes) – The configuration settings of the paths HTTP requests.

  • forward_proxy (ForwardProxy) – The configuration settings of a forward proxy used to make the requests.

class azure.mgmt.appcontainers.models.HttpSettingsRoutes(*, api_prefix: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the paths HTTP requests.

Variables:

api_prefix (str) – The prefix that should precede all the authentication/authorization paths.

Keyword Arguments:

api_prefix (str) – The prefix that should precede all the authentication/authorization paths.

class azure.mgmt.appcontainers.models.IdentityProviders(*, azure_active_directory: _models.AzureActiveDirectory | None = None, facebook: _models.Facebook | None = None, git_hub: _models.GitHub | None = None, google: _models.Google | None = None, twitter: _models.Twitter | None = None, apple: _models.Apple | None = None, azure_static_web_apps: _models.AzureStaticWebApps | None = None, custom_open_id_connect_providers: Dict[str, _models.CustomOpenIdConnectProvider] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

Variables:

  • azure_active_directory (AzureActiveDirectory) – The configuration settings of the Azure Active directory provider.

  • facebook (Facebook) – The configuration settings of the Facebook provider.

  • git_hub (GitHub) – The configuration settings of the GitHub provider.

  • google (Google) – The configuration settings of the Google provider.

  • twitter (Twitter) – The configuration settings of the Twitter provider.

  • apple (Apple) – The configuration settings of the Apple provider.

  • azure_static_web_apps (AzureStaticWebApps) – The configuration settings of the Azure Static Web Apps provider.

  • custom_open_id_connect_providers (dict[str, CustomOpenIdConnectProvider]) – The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider.

Keyword Arguments:

  • azure_active_directory (AzureActiveDirectory) – The configuration settings of the Azure Active directory provider.

  • facebook (Facebook) – The configuration settings of the Facebook provider.

  • git_hub (GitHub) – The configuration settings of the GitHub provider.

  • google (Google) – The configuration settings of the Google provider.

  • twitter (Twitter) – The configuration settings of the Twitter provider.

  • apple (Apple) – The configuration settings of the Apple provider.

  • azure_static_web_apps (AzureStaticWebApps) – The configuration settings of the Azure Static Web Apps provider.

  • custom_open_id_connect_providers (dict[str, CustomOpenIdConnectProvider]) – The map of the name of the alias of each custom Open ID Connect provider to the configuration settings of the custom Open ID Connect provider.

class azure.mgmt.appcontainers.models.IdentitySettings(*, identity: str, lifecycle: str | _models.IdentitySettingsLifeCycle | None = None, **kwargs: Any)[source]

Bases: Model

Optional settings for a Managed Identity that is assigned to the Container App.

All required parameters must be populated in order to send to server.

Variables:

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity. Required.

  • lifecycle (str or IdentitySettingsLifeCycle) – Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. Known values are: “Init”, “Main”, “None”, and “All”.

Keyword Arguments:

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity. Required.

  • lifecycle (str or IdentitySettingsLifeCycle) – Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. Known values are: “Init”, “Main”, “None”, and “All”.

class azure.mgmt.appcontainers.models.IdentitySettingsLifeCycle(*values)[source]

Bases: str, Enum

Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.

ALL = 'All'
INIT = 'Init'
MAIN = 'Main'
NONE = 'None'
class azure.mgmt.appcontainers.models.Ingress(*, external: bool = False, target_port: int | None = None, exposed_port: int | None = None, transport: str | _models.IngressTransportMethod = 'auto', traffic: List[_models.TrafficWeight] | None = None, custom_domains: List[_models.CustomDomain] | None = None, allow_insecure: bool = False, ip_security_restrictions: List[_models.IpSecurityRestrictionRule] | None = None, sticky_sessions: _models.IngressStickySessions | None = None, client_certificate_mode: str | _models.IngressClientCertificateMode | None = None, cors_policy: _models.CorsPolicy | None = None, additional_port_mappings: List[_models.IngressPortMapping] | None = None, **kwargs: Any)[source]

Bases: Model

Container App Ingress configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • fqdn (str) – Hostname.

  • external (bool) – Bool indicating if app exposes an external http endpoint.

  • target_port (int) – Target Port in containers for traffic from ingress.

  • exposed_port (int) – Exposed Port in containers for TCP traffic from ingress.

  • transport (str or IngressTransportMethod) – Ingress transport protocol. Known values are: “auto”, “http”, “http2”, and “tcp”.

  • traffic (list[TrafficWeight]) – Traffic weights for app’s revisions.

  • custom_domains (list[CustomDomain]) – custom domain bindings for Container Apps’ hostnames.

  • allow_insecure (bool) – Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.

  • ip_security_restrictions (list[IpSecurityRestrictionRule]) – Rules to restrict incoming IP address.

  • sticky_sessions (IngressStickySessions) – Sticky Sessions for Single Revision Mode.

  • client_certificate_mode (str or IngressClientCertificateMode) – Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. Known values are: “ignore”, “accept”, and “require”.

  • cors_policy (CorsPolicy) – CORS policy for container app.

  • additional_port_mappings (list[IngressPortMapping]) – Settings to expose additional ports on container app.

Keyword Arguments:

  • external (bool) – Bool indicating if app exposes an external http endpoint.

  • target_port (int) – Target Port in containers for traffic from ingress.

  • exposed_port (int) – Exposed Port in containers for TCP traffic from ingress.

  • transport (str or IngressTransportMethod) – Ingress transport protocol. Known values are: “auto”, “http”, “http2”, and “tcp”.

  • traffic (list[TrafficWeight]) – Traffic weights for app’s revisions.

  • custom_domains (list[CustomDomain]) – custom domain bindings for Container Apps’ hostnames.

  • allow_insecure (bool) – Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.

  • ip_security_restrictions (list[IpSecurityRestrictionRule]) – Rules to restrict incoming IP address.

  • sticky_sessions (IngressStickySessions) – Sticky Sessions for Single Revision Mode.

  • client_certificate_mode (str or IngressClientCertificateMode) – Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. Known values are: “ignore”, “accept”, and “require”.

  • cors_policy (CorsPolicy) – CORS policy for container app.

  • additional_port_mappings (list[IngressPortMapping]) – Settings to expose additional ports on container app.

class azure.mgmt.appcontainers.models.IngressClientCertificateMode(*values)[source]

Bases: str, Enum

Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.

ACCEPT = 'accept'
IGNORE = 'ignore'
REQUIRE = 'require'
class azure.mgmt.appcontainers.models.IngressPortMapping(*, external: bool, target_port: int, exposed_port: int | None = None, **kwargs: Any)[source]

Bases: Model

Port mappings of container app ingress.

All required parameters must be populated in order to send to server.

Variables:

  • external (bool) – Specifies whether the app port is accessible outside of the environment. Required.

  • target_port (int) – Specifies the port user’s container listens on. Required.

  • exposed_port (int) – Specifies the exposed port for the target port. If not specified, it defaults to target port.

Keyword Arguments:

  • external (bool) – Specifies whether the app port is accessible outside of the environment. Required.

  • target_port (int) – Specifies the port user’s container listens on. Required.

  • exposed_port (int) – Specifies the exposed port for the target port. If not specified, it defaults to target port.

class azure.mgmt.appcontainers.models.IngressStickySessions(*, affinity: str | _models.Affinity | None = None, **kwargs: Any)[source]

Bases: Model

Sticky Sessions for Single Revision Mode.

Variables:

affinity (str or Affinity) – Sticky Session Affinity. Known values are: “sticky” and “none”.

Keyword Arguments:

affinity (str or Affinity) – Sticky Session Affinity. Known values are: “sticky” and “none”.

class azure.mgmt.appcontainers.models.IngressTransportMethod(*values)[source]

Bases: str, Enum

Ingress transport protocol.

AUTO = 'auto'
HTTP = 'http'
HTTP2 = 'http2'
TCP = 'tcp'
class azure.mgmt.appcontainers.models.InitContainer(*, image: str | None = None, name: str | None = None, command: List[str] | None = None, args: List[str] | None = None, env: List[_models.EnvironmentVar] | None = None, resources: _models.ContainerResources | None = None, volume_mounts: List[_models.VolumeMount] | None = None, **kwargs: Any)[source]

Bases: BaseContainer

Container App init container definition.

Variables:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

  • volume_mounts (list[VolumeMount]) – Container volume mounts.

Keyword Arguments:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

  • volume_mounts (list[VolumeMount]) – Container volume mounts.

class azure.mgmt.appcontainers.models.IpSecurityRestrictionRule(*, name: str, ip_address_range: str, action: str | _models.Action, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Rule to restrict incoming IP address.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – Name for the IP restriction rule. Required.

  • description (str) – Describe the IP restriction rule that is being sent to the container-app. This is an optional field.

  • ip_address_range (str) – CIDR notation to match incoming IP address. Required.

  • action (str or Action) – Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny. Required. Known values are: “Allow” and “Deny”.

Keyword Arguments:

  • name (str) – Name for the IP restriction rule. Required.

  • description (str) – Describe the IP restriction rule that is being sent to the container-app. This is an optional field.

  • ip_address_range (str) – CIDR notation to match incoming IP address. Required.

  • action (str or Action) – Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny. Required. Known values are: “Allow” and “Deny”.

class azure.mgmt.appcontainers.models.JavaComponent(*, properties: _models.JavaComponentProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Java Component.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (JavaComponentProperties) – Java Component resource specific properties.

Keyword Arguments:

properties (JavaComponentProperties) – Java Component resource specific properties.

class azure.mgmt.appcontainers.models.JavaComponentConfigurationProperty(*, property_name: str | None = None, value: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration properties for a Java Component.

Variables:

  • property_name (str) – The name of the property.

  • value (str) – The value of the property.

Keyword Arguments:

  • property_name (str) – The name of the property.

  • value (str) – The value of the property.

class azure.mgmt.appcontainers.models.JavaComponentIngress(**kwargs: Any)[source]

Bases: Model

Container App Ingress configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

fqdn (str) – Hostname of the Java Component endpoint.

class azure.mgmt.appcontainers.models.JavaComponentProperties(*, configurations: List[_models.JavaComponentConfigurationProperty] | None = None, scale: _models.JavaComponentPropertiesScale | None = None, service_binds: List[_models.JavaComponentServiceBind] | None = None, **kwargs: Any)[source]

Bases: Model

Java Component common properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SpringBootAdminComponent, SpringCloudConfigComponent, SpringCloudEurekaComponent

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.JavaComponentPropertiesScale(*, min_replicas: int | None = None, max_replicas: int | None = None, **kwargs: Any)[source]

Bases: Model

Java component scaling configurations.

Variables:

  • min_replicas (int) – Optional. Minimum number of Java component replicas. Defaults to 1 if not set.

  • max_replicas (int) – Optional. Maximum number of Java component replicas.

Keyword Arguments:

  • min_replicas (int) – Optional. Minimum number of Java component replicas. Defaults to 1 if not set.

  • max_replicas (int) – Optional. Maximum number of Java component replicas.

class azure.mgmt.appcontainers.models.JavaComponentProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the Java Component.

CANCELED = 'Canceled'
DELETING = 'Deleting'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.JavaComponentServiceBind(*, name: str | None = None, service_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration to bind a Java Component to another Java Component.

Variables:

  • name (str) – Name of the service bind.

  • service_id (str) – Resource id of the target service.

Keyword Arguments:

  • name (str) – Name of the service bind.

  • service_id (str) – Resource id of the target service.

class azure.mgmt.appcontainers.models.JavaComponentType(*values)[source]

Bases: str, Enum

Type of the Java Component.

SPRING_BOOT_ADMIN = 'SpringBootAdmin'
SPRING_CLOUD_CONFIG = 'SpringCloudConfig'
SPRING_CLOUD_EUREKA = 'SpringCloudEureka'
class azure.mgmt.appcontainers.models.JavaComponentsCollection(*, value: List[_models.JavaComponent], **kwargs: Any)[source]

Bases: Model

Java Components ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[JavaComponent]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[JavaComponent]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.Job(*, location: str, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, environment_id: str | None = None, workload_profile_name: str | None = None, configuration: _models.JobConfiguration | None = None, template: _models.JobTemplate | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Container App Job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (ManagedServiceIdentity) – Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.

  • provisioning_state (str or JobProvisioningState) – Provisioning state of the Container Apps Job. Known values are: “InProgress”, “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

  • environment_id (str) – Resource ID of environment.

  • workload_profile_name (str) – Workload profile name to pin for container apps job execution.

  • configuration (JobConfiguration) – Container Apps Job configuration properties.

  • template (JobTemplate) – Container Apps job definition.

  • outbound_ip_addresses (list[str]) – Outbound IP Addresses of a container apps job.

  • event_stream_endpoint (str) – The endpoint of the eventstream of the container apps job.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (ManagedServiceIdentity) – Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.

  • environment_id (str) – Resource ID of environment.

  • workload_profile_name (str) – Workload profile name to pin for container apps job execution.

  • configuration (JobConfiguration) – Container Apps Job configuration properties.

  • template (JobTemplate) – Container Apps job definition.

class azure.mgmt.appcontainers.models.JobConfiguration(*, trigger_type: str | _models.TriggerType = 'Manual', replica_timeout: int, secrets: List[_models.Secret] | None = None, replica_retry_limit: int | None = None, manual_trigger_config: _models.JobConfigurationManualTriggerConfig | None = None, schedule_trigger_config: _models.JobConfigurationScheduleTriggerConfig | None = None, event_trigger_config: _models.JobConfigurationEventTriggerConfig | None = None, registries: List[_models.RegistryCredentials] | None = None, identity_settings: List[_models.IdentitySettings] | None = None, **kwargs: Any)[source]

Bases: Model

Non versioned Container Apps Job configuration properties.

All required parameters must be populated in order to send to server.

Variables:

  • secrets (list[Secret]) – Collection of secrets used by a Container Apps Job.

  • trigger_type (str or TriggerType) – Trigger type of the job. Known values are: “Schedule”, “Event”, and “Manual”.

  • replica_timeout (int) – Maximum number of seconds a replica is allowed to run. Required.

  • replica_retry_limit (int) – Maximum number of retries before failing the job.

  • manual_trigger_config (JobConfigurationManualTriggerConfig) – Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.

  • schedule_trigger_config (JobConfigurationScheduleTriggerConfig) – Cron formatted repeating trigger schedule (”* * * * *”) for cronjobs. Properties completions and parallelism would be set to 1 by default.

  • event_trigger_config (JobConfigurationEventTriggerConfig) – Trigger configuration of an event driven job.

  • registries (list[RegistryCredentials]) – Collection of private container registry credentials used by a Container apps job.

  • identity_settings (list[IdentitySettings]) – Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.

Keyword Arguments:

  • secrets (list[Secret]) – Collection of secrets used by a Container Apps Job.

  • trigger_type (str or TriggerType) – Trigger type of the job. Known values are: “Schedule”, “Event”, and “Manual”.

  • replica_timeout (int) – Maximum number of seconds a replica is allowed to run. Required.

  • replica_retry_limit (int) – Maximum number of retries before failing the job.

  • manual_trigger_config (JobConfigurationManualTriggerConfig) – Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.

  • schedule_trigger_config (JobConfigurationScheduleTriggerConfig) – Cron formatted repeating trigger schedule (”* * * * *”) for cronjobs. Properties completions and parallelism would be set to 1 by default.

  • event_trigger_config (JobConfigurationEventTriggerConfig) – Trigger configuration of an event driven job.

  • registries (list[RegistryCredentials]) – Collection of private container registry credentials used by a Container apps job.

  • identity_settings (list[IdentitySettings]) – Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.

class azure.mgmt.appcontainers.models.JobConfigurationEventTriggerConfig(*, replica_completion_count: int | None = None, parallelism: int | None = None, scale: _models.JobScale | None = None, **kwargs: Any)[source]

Bases: Model

Trigger configuration of an event driven job.

Variables:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

  • scale (JobScale) – Scaling configurations for event driven jobs.

Keyword Arguments:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

  • scale (JobScale) – Scaling configurations for event driven jobs.

class azure.mgmt.appcontainers.models.JobConfigurationManualTriggerConfig(*, replica_completion_count: int | None = None, parallelism: int | None = None, **kwargs: Any)[source]

Bases: Model

Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default.

Variables:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

Keyword Arguments:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

class azure.mgmt.appcontainers.models.JobConfigurationScheduleTriggerConfig(*, cron_expression: str, replica_completion_count: int | None = None, parallelism: int | None = None, **kwargs: Any)[source]

Bases: Model

Cron formatted repeating trigger schedule (”* * * * *”) for cronjobs. Properties completions and parallelism would be set to 1 by default.

All required parameters must be populated in order to send to server.

Variables:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • cron_expression (str) – Cron formatted repeating schedule (”* * * * *”) of a Cron Job. Required.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

Keyword Arguments:

  • replica_completion_count (int) – Minimum number of successful replica completions before overall job completion.

  • cron_expression (str) – Cron formatted repeating schedule (”* * * * *”) of a Cron Job. Required.

  • parallelism (int) – Number of parallel replicas of a job that can run at a given time.

class azure.mgmt.appcontainers.models.JobExecution(*, name: str | None = None, id: str | None = None, type: str | None = None, start_time: datetime | None = None, end_time: datetime | None = None, template: _models.JobExecutionTemplate | None = None, **kwargs: Any)[source]

Bases: Model

Container Apps Job execution.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – Job execution Name.

  • id (str) – Job execution Id.

  • type (str) – Job execution type.

  • status (str or JobExecutionRunningState) – Current running State of the job. Known values are: “Running”, “Processing”, “Stopped”, “Degraded”, “Failed”, “Unknown”, and “Succeeded”.

  • start_time (datetime) – Job execution start time.

  • end_time (datetime) – Job execution end time.

  • template (JobExecutionTemplate) – Job’s execution container.

Keyword Arguments:

  • name (str) – Job execution Name.

  • id (str) – Job execution Id.

  • type (str) – Job execution type.

  • start_time (datetime) – Job execution start time.

  • end_time (datetime) – Job execution end time.

  • template (JobExecutionTemplate) – Job’s execution container.

class azure.mgmt.appcontainers.models.JobExecutionBase(*, name: str | None = None, id: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App’s Job execution name.

Variables:

  • name (str) – Job execution name.

  • id (str) – Job execution Id.

Keyword Arguments:

  • name (str) – Job execution name.

  • id (str) – Job execution Id.

class azure.mgmt.appcontainers.models.JobExecutionContainer(*, image: str | None = None, name: str | None = None, command: List[str] | None = None, args: List[str] | None = None, env: List[_models.EnvironmentVar] | None = None, resources: _models.ContainerResources | None = None, **kwargs: Any)[source]

Bases: Model

Container Apps Jobs execution container definition.

Variables:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

Keyword Arguments:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (ContainerResources) – Container resource requirements.

class azure.mgmt.appcontainers.models.JobExecutionNamesCollection(*, value: List[_models.JobExecutionBase], **kwargs: Any)[source]

Bases: Model

Container App executions names list.

All required parameters must be populated in order to send to server.

Variables:

value (list[JobExecutionBase]) – Collection of resources. Required.

Keyword Arguments:

value (list[JobExecutionBase]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.JobExecutionRunningState(*values)[source]

Bases: str, Enum

Current running State of the job.

DEGRADED = 'Degraded'
FAILED = 'Failed'
PROCESSING = 'Processing'
RUNNING = 'Running'
STOPPED = 'Stopped'
SUCCEEDED = 'Succeeded'
UNKNOWN = 'Unknown'
class azure.mgmt.appcontainers.models.JobExecutionTemplate(*, containers: List[_models.JobExecutionContainer] | None = None, init_containers: List[_models.JobExecutionContainer] | None = None, **kwargs: Any)[source]

Bases: Model

Job’s execution template, containing container configuration for a job’s execution.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.JobPatchProperties(*, identity: _models.ManagedServiceIdentity | None = None, tags: Dict[str, str] | None = None, properties: _models.JobPatchPropertiesProperties | None = None, **kwargs: Any)[source]

Bases: Model

Container Apps Job resource specific properties.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.JobPatchPropertiesProperties(*, environment_id: str | None = None, configuration: _models.JobConfiguration | None = None, template: _models.JobTemplate | None = None, outbound_ip_addresses: List[str] | None = None, event_stream_endpoint: str | None = None, **kwargs: Any)[source]

Bases: Model

JobPatchPropertiesProperties.

Variables:

  • environment_id (str) – Resource ID of environment.

  • configuration (JobConfiguration) – Container Apps Job configuration properties.

  • template (JobTemplate) – Container Apps job definition.

  • outbound_ip_addresses (list[str]) – Outbound IP Addresses of a container apps job.

  • event_stream_endpoint (str) – The endpoint of the eventstream of the container apps job.

Keyword Arguments:

  • environment_id (str) – Resource ID of environment.

  • configuration (JobConfiguration) – Container Apps Job configuration properties.

  • template (JobTemplate) – Container Apps job definition.

  • outbound_ip_addresses (list[str]) – Outbound IP Addresses of a container apps job.

  • event_stream_endpoint (str) – The endpoint of the eventstream of the container apps job.

class azure.mgmt.appcontainers.models.JobProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the Container Apps Job.

CANCELED = 'Canceled'
DELETING = 'Deleting'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.JobScale(*, polling_interval: int | None = None, min_executions: int = 0, max_executions: int = 100, rules: List[_models.JobScaleRule] | None = None, **kwargs: Any)[source]

Bases: Model

Scaling configurations for event driven jobs.

Variables:

  • polling_interval (int) – Interval to check each event source in seconds. Defaults to 30s.

  • min_executions (int) – Minimum number of job executions that are created for a trigger, default 0.

  • max_executions (int) – Maximum number of job executions that are created for a trigger, default 100.

  • rules (list[JobScaleRule]) – Scaling rules.

Keyword Arguments:

  • polling_interval (int) – Interval to check each event source in seconds. Defaults to 30s.

  • min_executions (int) – Minimum number of job executions that are created for a trigger, default 0.

  • max_executions (int) – Maximum number of job executions that are created for a trigger, default 100.

  • rules (list[JobScaleRule]) – Scaling rules.

class azure.mgmt.appcontainers.models.JobScaleRule(*, name: str | None = None, type: str | None = None, metadata: MutableMapping[str, Any] | None = None, auth: List[_models.ScaleRuleAuth] | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Scaling rule.

Variables:

  • name (str) – Scale Rule Name.

  • type (str) – Type of the scale rule eg: azure-servicebus, redis etc.

  • metadata (JSON) – Metadata properties to describe the scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

Keyword Arguments:

  • name (str) – Scale Rule Name.

  • type (str) – Type of the scale rule eg: azure-servicebus, redis etc.

  • metadata (JSON) – Metadata properties to describe the scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

class azure.mgmt.appcontainers.models.JobSecretsCollection(*, value: List[_models.Secret], **kwargs: Any)[source]

Bases: Model

Container Apps Job Secrets Collection ARM resource.

All required parameters must be populated in order to send to server.

Variables:

value (list[Secret]) – Collection of resources. Required.

Keyword Arguments:

value (list[Secret]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.JobTemplate(*, init_containers: List[_models.InitContainer] | None = None, containers: List[_models.Container] | None = None, volumes: List[_models.Volume] | None = None, **kwargs: Any)[source]

Bases: Model

Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created.

Variables:

  • init_containers (list[InitContainer]) – List of specialized containers that run before app containers.

  • containers (list[Container]) – List of container definitions for the Container App.

  • volumes (list[Volume]) – List of volume definitions for the Container App.

Keyword Arguments:

  • init_containers (list[InitContainer]) – List of specialized containers that run before app containers.

  • containers (list[Container]) – List of container definitions for the Container App.

  • volumes (list[Volume]) – List of volume definitions for the Container App.

class azure.mgmt.appcontainers.models.JobsCollection(*, value: List[_models.Job], **kwargs: Any)[source]

Bases: Model

Container Apps Jobs collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[Job]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[Job]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.JwtClaimChecks(*, allowed_groups: List[str] | None = None, allowed_client_applications: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the checks that should be made while validating the JWT Claims.

Variables:

  • allowed_groups (list[str]) – The list of the allowed groups.

  • allowed_client_applications (list[str]) – The list of the allowed client applications.

Keyword Arguments:

  • allowed_groups (list[str]) – The list of the allowed groups.

  • allowed_client_applications (list[str]) – The list of the allowed client applications.

class azure.mgmt.appcontainers.models.KedaConfiguration(**kwargs: Any)[source]

Bases: Model

Configuration properties Keda component.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

version (str) – The version of Keda.

class azure.mgmt.appcontainers.models.LifecycleConfiguration(*, lifecycle_type: str | _models.LifecycleType | None = None, cooldown_period_in_seconds: int | None = None, max_alive_period_in_seconds: int | None = None, **kwargs: Any)[source]

Bases: Model

The lifecycle configuration properties of a session in the dynamic session pool.

Variables:

  • lifecycle_type (str or LifecycleType) – The lifecycle type of the session pool. Known values are: “Timed” and “OnContainerExit”.

  • cooldown_period_in_seconds (int) – The cooldown period of a session in seconds when the lifecycle type is ‘Timed’.

  • max_alive_period_in_seconds (int) – The maximum alive period of a session in seconds when the lifecycle type is ‘OnContainerExit’.

Keyword Arguments:

  • lifecycle_type (str or LifecycleType) – The lifecycle type of the session pool. Known values are: “Timed” and “OnContainerExit”.

  • cooldown_period_in_seconds (int) – The cooldown period of a session in seconds when the lifecycle type is ‘Timed’.

  • max_alive_period_in_seconds (int) – The maximum alive period of a session in seconds when the lifecycle type is ‘OnContainerExit’.

class azure.mgmt.appcontainers.models.LifecycleType(*values)[source]

Bases: str, Enum

The lifecycle type of the session pool.

ON_CONTAINER_EXIT = 'OnContainerExit'
TIMED = 'Timed'
class azure.mgmt.appcontainers.models.ListUsagesResult(*, value: List[_models.Usage] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

ListUsagesResult.

Variables:

  • value (list[Usage]) – The list of compute resource usages.

  • next_link (str) – The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

Keyword Arguments:

  • value (list[Usage]) – The list of compute resource usages.

  • next_link (str) – The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.

class azure.mgmt.appcontainers.models.LogAnalyticsConfiguration(*, customer_id: str | None = None, shared_key: str | None = None, **kwargs: Any)[source]

Bases: Model

Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’.

Variables:

  • customer_id (str) – Log analytics customer id.

  • shared_key (str) – Log analytics customer key.

Keyword Arguments:

  • customer_id (str) – Log analytics customer id.

  • shared_key (str) – Log analytics customer key.

class azure.mgmt.appcontainers.models.LogLevel(*values)[source]

Bases: str, Enum

Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.

DEBUG = 'debug'
ERROR = 'error'
INFO = 'info'
WARN = 'warn'
class azure.mgmt.appcontainers.models.Login(*, routes: _models.LoginRoutes | None = None, token_store: _models.TokenStore | None = None, preserve_url_fragments_for_logins: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, cookie_expiration: _models.CookieExpiration | None = None, nonce: _models.Nonce | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

Variables:

  • routes (LoginRoutes) – The routes that specify the endpoints used for login and logout requests.

  • token_store (TokenStore) – The configuration settings of the token store.

  • preserve_url_fragments_for_logins (bool) – <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.

  • allowed_external_redirect_urls (list[str]) – External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

  • cookie_expiration (CookieExpiration) – The configuration settings of the session cookie’s expiration.

  • nonce (Nonce) – The configuration settings of the nonce used in the login flow.

Keyword Arguments:

  • routes (LoginRoutes) – The routes that specify the endpoints used for login and logout requests.

  • token_store (TokenStore) – The configuration settings of the token store.

  • preserve_url_fragments_for_logins (bool) – <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.

  • allowed_external_redirect_urls (list[str]) – External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

  • cookie_expiration (CookieExpiration) – The configuration settings of the session cookie’s expiration.

  • nonce (Nonce) – The configuration settings of the nonce used in the login flow.

class azure.mgmt.appcontainers.models.LoginRoutes(*, logout_endpoint: str | None = None, **kwargs: Any)[source]

Bases: Model

The routes that specify the endpoints used for login and logout requests.

Variables:

logout_endpoint (str) – The endpoint at which a logout request should be made.

Keyword Arguments:

logout_endpoint (str) – The endpoint at which a logout request should be made.

class azure.mgmt.appcontainers.models.LoginScopes(*, scopes: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the login flow, including the scopes that should be requested.

Variables:

scopes (list[str]) – A list of the scopes that should be requested while authenticating.

Keyword Arguments:

scopes (list[str]) – A list of the scopes that should be requested while authenticating.

class azure.mgmt.appcontainers.models.ManagedCertificate(*, location: str, tags: Dict[str, str] | None = None, properties: _models.ManagedCertificateProperties | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ManagedCertificateProperties) – Certificate resource specific properties.

Keyword Arguments:
class azure.mgmt.appcontainers.models.ManagedCertificateCollection(*, value: List[_models.ManagedCertificate], **kwargs: Any)[source]

Bases: Model

Collection of Managed Certificates.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ManagedCertificate]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[ManagedCertificate]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.ManagedCertificateDomainControlValidation(*values)[source]

Bases: str, Enum

Selected type of domain control validation for managed certificates.

CNAME = 'CNAME'
HTTP = 'HTTP'
TXT = 'TXT'
class azure.mgmt.appcontainers.models.ManagedCertificatePatch(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

A managed certificate to update.

Variables:

tags (dict[str, str]) – Application-specific metadata in the form of key-value pairs.

Keyword Arguments:

tags (dict[str, str]) – Application-specific metadata in the form of key-value pairs.

class azure.mgmt.appcontainers.models.ManagedCertificateProperties(*, subject_name: str | None = None, domain_control_validation: str | _models.ManagedCertificateDomainControlValidation | None = None, **kwargs: Any)[source]

Bases: Model

Certificate resource specific properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • provisioning_state (str or CertificateProvisioningState) – Provisioning state of the certificate. Known values are: “Succeeded”, “Failed”, “Canceled”, “DeleteFailed”, and “Pending”.

  • subject_name (str) – Subject name of the certificate.

  • error (str) – Any error occurred during the certificate provision.

  • domain_control_validation (str or ManagedCertificateDomainControlValidation) – Selected type of domain control validation for managed certificates. Known values are: “CNAME”, “HTTP”, and “TXT”.

  • validation_token (str) – A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.

Keyword Arguments:

  • subject_name (str) – Subject name of the certificate.

  • domain_control_validation (str or ManagedCertificateDomainControlValidation) – Selected type of domain control validation for managed certificates. Known values are: “CNAME”, “HTTP”, and “TXT”.

class azure.mgmt.appcontainers.models.ManagedEnvironment(*, location: str, tags: Dict[str, str] | None = None, kind: str | None = None, identity: _models.ManagedServiceIdentity | None = None, dapr_ai_instrumentation_key: str | None = None, dapr_ai_connection_string: str | None = None, vnet_configuration: _models.VnetConfiguration | None = None, app_logs_configuration: _models.AppLogsConfiguration | None = None, zone_redundant: bool | None = None, custom_domain_configuration: _models.CustomDomainConfiguration | None = None, workload_profiles: List[_models.WorkloadProfile] | None = None, keda_configuration: _models.KedaConfiguration | None = None, dapr_configuration: _models.DaprConfiguration | None = None, infrastructure_resource_group: str | None = None, peer_authentication: _models.ManagedEnvironmentPropertiesPeerAuthentication | None = None, peer_traffic_configuration: _models.ManagedEnvironmentPropertiesPeerTrafficConfiguration | None = None, **kwargs: Any)[source]

Bases: TrackedResource

An environment for hosting container apps.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • kind (str) – Kind of the Environment.

  • identity (ManagedServiceIdentity) – Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or credentials in code.

  • provisioning_state (str or EnvironmentProvisioningState) – Provisioning state of the Environment. Known values are: “Succeeded”, “Failed”, “Canceled”, “Waiting”, “InitializationInProgress”, “InfrastructureSetupInProgress”, “InfrastructureSetupComplete”, “ScheduledForDelete”, “UpgradeRequested”, and “UpgradeFailed”.

  • dapr_ai_instrumentation_key (str) – Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.

  • dapr_ai_connection_string (str) – Application Insights connection string used by Dapr to export Service to Service communication telemetry.

  • vnet_configuration (VnetConfiguration) – Vnet configuration for the environment.

  • deployment_errors (str) – Any errors that occurred during deployment or deployment validation.

  • default_domain (str) – Default Domain Name for the cluster.

  • static_ip (str) – Static IP of the Environment.

  • app_logs_configuration (AppLogsConfiguration) – Cluster configuration which enables the log daemon to export app logs to configured destination.

  • zone_redundant (bool) – Whether or not this Managed Environment is zone-redundant.

  • custom_domain_configuration (CustomDomainConfiguration) – Custom domain configuration for the environment.

  • event_stream_endpoint (str) – The endpoint of the eventstream of the Environment.

  • workload_profiles (list[WorkloadProfile]) – Workload profiles configured for the Managed Environment.

  • keda_configuration (KedaConfiguration) – The configuration of Keda component.

  • dapr_configuration (DaprConfiguration) – The configuration of Dapr component.

  • infrastructure_resource_group (str) – Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.

  • peer_authentication (ManagedEnvironmentPropertiesPeerAuthentication) – Peer authentication settings for the Managed Environment.

  • peer_traffic_configuration (ManagedEnvironmentPropertiesPeerTrafficConfiguration) – Peer traffic settings for the Managed Environment.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • kind (str) – Kind of the Environment.

  • identity (ManagedServiceIdentity) – Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or credentials in code.

  • dapr_ai_instrumentation_key (str) – Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.

  • dapr_ai_connection_string (str) – Application Insights connection string used by Dapr to export Service to Service communication telemetry.

  • vnet_configuration (VnetConfiguration) – Vnet configuration for the environment.

  • app_logs_configuration (AppLogsConfiguration) – Cluster configuration which enables the log daemon to export app logs to configured destination.

  • zone_redundant (bool) – Whether or not this Managed Environment is zone-redundant.

  • custom_domain_configuration (CustomDomainConfiguration) – Custom domain configuration for the environment.

  • workload_profiles (list[WorkloadProfile]) – Workload profiles configured for the Managed Environment.

  • keda_configuration (KedaConfiguration) – The configuration of Keda component.

  • dapr_configuration (DaprConfiguration) – The configuration of Dapr component.

  • infrastructure_resource_group (str) – Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.

  • peer_authentication (ManagedEnvironmentPropertiesPeerAuthentication) – Peer authentication settings for the Managed Environment.

  • peer_traffic_configuration (ManagedEnvironmentPropertiesPeerTrafficConfiguration) – Peer traffic settings for the Managed Environment.

class azure.mgmt.appcontainers.models.ManagedEnvironmentPropertiesPeerAuthentication(*, mtls: _models.Mtls | None = None, **kwargs: Any)[source]

Bases: Model

Peer authentication settings for the Managed Environment.

Variables:

mtls (Mtls) – Mutual TLS authentication settings for the Managed Environment.

Keyword Arguments:

mtls (Mtls) – Mutual TLS authentication settings for the Managed Environment.

class azure.mgmt.appcontainers.models.ManagedEnvironmentPropertiesPeerTrafficConfiguration(*, encryption: _models.ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption | None = None, **kwargs: Any)[source]

Bases: Model

Peer traffic settings for the Managed Environment.

Variables:

encryption (ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption) – Peer traffic encryption settings for the Managed Environment.

Keyword Arguments:

encryption (ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption) – Peer traffic encryption settings for the Managed Environment.

class azure.mgmt.appcontainers.models.ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption(*, enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Peer traffic encryption settings for the Managed Environment.

Variables:

enabled (bool) – Boolean indicating whether the peer traffic encryption is enabled.

Keyword Arguments:

enabled (bool) – Boolean indicating whether the peer traffic encryption is enabled.

class azure.mgmt.appcontainers.models.ManagedEnvironmentStorage(*, properties: _models.ManagedEnvironmentStorageProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Storage resource for managedEnvironment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ManagedEnvironmentStorageProperties) – Storage properties.

Keyword Arguments:

properties (ManagedEnvironmentStorageProperties) – Storage properties.

class azure.mgmt.appcontainers.models.ManagedEnvironmentStorageProperties(*, azure_file: _models.AzureFileProperties | None = None, nfs_azure_file: _models.NfsAzureFileProperties | None = None, **kwargs: Any)[source]

Bases: Model

Storage properties.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.ManagedEnvironmentStoragesCollection(*, value: List[_models.ManagedEnvironmentStorage], **kwargs: Any)[source]

Bases: Model

Collection of Storage for Environments.

All required parameters must be populated in order to send to server.

Variables:

value (list[ManagedEnvironmentStorage]) – Collection of storage resources. Required.

Keyword Arguments:

value (list[ManagedEnvironmentStorage]) – Collection of storage resources. Required.

class azure.mgmt.appcontainers.models.ManagedEnvironmentsCollection(*, value: List[_models.ManagedEnvironment], **kwargs: Any)[source]

Bases: Model

Collection of Environments.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ManagedEnvironment]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[ManagedEnvironment]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.ManagedIdentitySetting(*, identity: str, lifecycle: str | _models.IdentitySettingsLifeCycle | None = None, **kwargs: Any)[source]

Bases: Model

Optional settings for a Managed Identity that is assigned to the Session pool.

All required parameters must be populated in order to send to server.

Variables:

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or ‘system’ for system-assigned identity. Required.

  • lifecycle (str or IdentitySettingsLifeCycle) – Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. Known values are: “Init”, “Main”, “None”, and “All”.

Keyword Arguments:

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or ‘system’ for system-assigned identity. Required.

  • lifecycle (str or IdentitySettingsLifeCycle) – Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. Known values are: “Init”, “Main”, “None”, and “All”.

class azure.mgmt.appcontainers.models.ManagedServiceIdentity(*, type: str | _models.ManagedServiceIdentityType, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

  • type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. # pylint: disable=line-too-long The dictionary values can be empty objects ({}) in requests.

Keyword Arguments:

  • type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. # pylint: disable=line-too-long The dictionary values can be empty objects ({}) in requests.

class azure.mgmt.appcontainers.models.ManagedServiceIdentityType(*values)[source]

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'
USER_ASSIGNED = 'UserAssigned'
class azure.mgmt.appcontainers.models.Mtls(*, enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Configuration properties for mutual TLS authentication.

Variables:

enabled (bool) – Boolean indicating whether the mutual TLS authentication is enabled.

Keyword Arguments:

enabled (bool) – Boolean indicating whether the mutual TLS authentication is enabled.

class azure.mgmt.appcontainers.models.NfsAzureFileProperties(*, server: str | None = None, access_mode: str | _models.AccessMode | None = None, share_name: str | None = None, **kwargs: Any)[source]

Bases: Model

NFS Azure File Properties.

Variables:

  • server (str) – Server for NFS azure file. Specify the Azure storage account server address.

  • access_mode (str or AccessMode) – Access mode for storage. Known values are: “ReadOnly” and “ReadWrite”.

  • share_name (str) – NFS Azure file share name.

Keyword Arguments:

  • server (str) – Server for NFS azure file. Specify the Azure storage account server address.

  • access_mode (str or AccessMode) – Access mode for storage. Known values are: “ReadOnly” and “ReadWrite”.

  • share_name (str) – NFS Azure file share name.

class azure.mgmt.appcontainers.models.Nonce(*, validate_nonce: bool | None = None, nonce_expiration_interval: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the nonce used in the login flow.

Variables:

  • validate_nonce (bool) – <code>false</code> if the nonce should not be validated while completing the login flow; otherwise, <code>true</code>.

  • nonce_expiration_interval (str) – The time after the request is made when the nonce should expire.

Keyword Arguments:

  • validate_nonce (bool) – <code>false</code> if the nonce should not be validated while completing the login flow; otherwise, <code>true</code>.

  • nonce_expiration_interval (str) – The time after the request is made when the nonce should expire.

class azure.mgmt.appcontainers.models.OpenIdConnectClientCredential(*, method: Literal['ClientSecretPost'] | None = None, client_secret_setting_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The authentication client credentials of the custom Open ID Connect provider.

Variables:

  • method (str) – The method that should be used to authenticate the user. Default value is “ClientSecretPost”.

  • client_secret_setting_name (str) – The app setting that contains the client secret for the custom Open ID Connect provider.

Keyword Arguments:

  • method (str) – The method that should be used to authenticate the user. Default value is “ClientSecretPost”.

  • client_secret_setting_name (str) – The app setting that contains the client secret for the custom Open ID Connect provider.

class azure.mgmt.appcontainers.models.OpenIdConnectConfig(*, authorization_endpoint: str | None = None, token_endpoint: str | None = None, issuer: str | None = None, certification_uri: str | None = None, well_known_open_id_configuration: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the endpoints used for the custom Open ID Connect provider.

Variables:

  • authorization_endpoint (str) – The endpoint to be used to make an authorization request.

  • token_endpoint (str) – The endpoint to be used to request a token.

  • issuer (str) – The endpoint that issues the token.

  • certification_uri (str) – The endpoint that provides the keys necessary to validate the token.

  • well_known_open_id_configuration (str) – The endpoint that contains all the configuration endpoints for the provider.

Keyword Arguments:

  • authorization_endpoint (str) – The endpoint to be used to make an authorization request.

  • token_endpoint (str) – The endpoint to be used to request a token.

  • issuer (str) – The endpoint that issues the token.

  • certification_uri (str) – The endpoint that provides the keys necessary to validate the token.

  • well_known_open_id_configuration (str) – The endpoint that contains all the configuration endpoints for the provider.

class azure.mgmt.appcontainers.models.OpenIdConnectLogin(*, name_claim_type: str | None = None, scopes: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the login flow of the custom Open ID Connect provider.

Variables:

  • name_claim_type (str) – The name of the claim that contains the users name.

  • scopes (list[str]) – A list of the scopes that should be requested while authenticating.

Keyword Arguments:

  • name_claim_type (str) – The name of the claim that contains the users name.

  • scopes (list[str]) – A list of the scopes that should be requested while authenticating.

class azure.mgmt.appcontainers.models.OpenIdConnectRegistration(*, client_id: str | None = None, client_credential: _models.OpenIdConnectClientCredential | None = None, open_id_connect_configuration: _models.OpenIdConnectConfig | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the app registration for the custom Open ID Connect provider.

Variables:

  • client_id (str) – The client id of the custom Open ID Connect provider.

  • client_credential (OpenIdConnectClientCredential) – The authentication credentials of the custom Open ID Connect provider.

  • open_id_connect_configuration (OpenIdConnectConfig) – The configuration settings of the endpoints used for the custom Open ID Connect provider.

Keyword Arguments:

  • client_id (str) – The client id of the custom Open ID Connect provider.

  • client_credential (OpenIdConnectClientCredential) – The authentication credentials of the custom Open ID Connect provider.

  • open_id_connect_configuration (OpenIdConnectConfig) – The configuration settings of the endpoints used for the custom Open ID Connect provider.

class azure.mgmt.appcontainers.models.OperationDetail(*, name: str | None = None, is_data_action: bool | None = None, display: _models.OperationDisplay | None = None, origin: str | None = None, **kwargs: Any)[source]

Bases: Model

Operation detail payload.

Variables:

  • name (str) – Name of the operation.

  • is_data_action (bool) – Indicates whether the operation is a data action.

  • display (OperationDisplay) – Display of the operation.

  • origin (str) – Origin of the operation.

Keyword Arguments:

  • name (str) – Name of the operation.

  • is_data_action (bool) – Indicates whether the operation is a data action.

  • display (OperationDisplay) – Display of the operation.

  • origin (str) – Origin of the operation.

class azure.mgmt.appcontainers.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Operation display payload.

Variables:

  • provider (str) – Resource provider of the operation.

  • resource (str) – Resource of the operation.

  • operation (str) – Localized friendly name for the operation.

  • description (str) – Localized friendly description for the operation.

Keyword Arguments:

  • provider (str) – Resource provider of the operation.

  • resource (str) – Resource of the operation.

  • operation (str) – Localized friendly name for the operation.

  • description (str) – Localized friendly description for the operation.

class azure.mgmt.appcontainers.models.PoolManagementType(*values)[source]

Bases: str, Enum

The pool management type of the session pool.

DYNAMIC = 'Dynamic'
MANUAL = 'Manual'
class azure.mgmt.appcontainers.models.ProxyResource(**kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.appcontainers.models.QueueScaleRule(*, account_name: str | None = None, queue_name: str | None = None, queue_length: int | None = None, auth: List[_models.ScaleRuleAuth] | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container Azure Queue based scaling rule.

Variables:

  • account_name (str) – Storage account name. required if using managed identity to authenticate.

  • queue_name (str) – Queue name.

  • queue_length (int) – Queue length.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the queue scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

Keyword Arguments:

  • account_name (str) – Storage account name. required if using managed identity to authenticate.

  • queue_name (str) – Queue name.

  • queue_length (int) – Queue length.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the queue scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

class azure.mgmt.appcontainers.models.RegistryCredentials(*, server: str | None = None, username: str | None = None, password_secret_ref: str | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App Private Registry.

Variables:

  • server (str) – Container Registry Server.

  • username (str) – Container Registry Username.

  • password_secret_ref (str) – The name of the Secret that contains the registry login password.

  • identity (str) – A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’.

Keyword Arguments:

  • server (str) – Container Registry Server.

  • username (str) – Container Registry Username.

  • password_secret_ref (str) – The name of the Secret that contains the registry login password.

  • identity (str) – A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’.

class azure.mgmt.appcontainers.models.RegistryInfo(*, registry_url: str | None = None, registry_user_name: str | None = None, registry_password: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App registry information.

Variables:

  • registry_url (str) – registry server Url.

  • registry_user_name (str) – registry username.

  • registry_password (str) – registry secret.

Keyword Arguments:

  • registry_url (str) – registry server Url.

  • registry_user_name (str) – registry username.

  • registry_password (str) – registry secret.

class azure.mgmt.appcontainers.models.Replica(*, containers: List[_models.ReplicaContainer] | None = None, init_containers: List[_models.ReplicaContainer] | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Container App Revision Replica.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • created_time (datetime) – Timestamp describing when the pod was created by controller.

  • running_state (str or ContainerAppReplicaRunningState) – Current running state of the replica. Known values are: “Running”, “NotRunning”, and “Unknown”.

  • running_state_details (str) – The details of replica current running state.

  • containers (list[ReplicaContainer]) – The containers collection under a replica.

  • init_containers (list[ReplicaContainer]) – The init containers collection under a replica.

Keyword Arguments:
class azure.mgmt.appcontainers.models.ReplicaCollection(*, value: List[_models.Replica], **kwargs: Any)[source]

Bases: Model

Container App Revision Replicas collection ARM resource.

All required parameters must be populated in order to send to server.

Variables:

value (list[Replica]) – Collection of resources. Required.

Keyword Arguments:

value (list[Replica]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.ReplicaContainer(*, name: str | None = None, container_id: str | None = None, ready: bool | None = None, started: bool | None = None, restart_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Container object under Container App Revision Replica.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The Name of the Container.

  • container_id (str) – The Id of the Container.

  • ready (bool) – The container ready status.

  • started (bool) – The container start status.

  • restart_count (int) – The container restart count.

  • running_state (str or ContainerAppContainerRunningState) – Current running state of the container. Known values are: “Running”, “Terminated”, and “Waiting”.

  • running_state_details (str) – The details of container current running state.

  • log_stream_endpoint (str) – Log Stream endpoint.

  • exec_endpoint (str) – Container exec endpoint.

Keyword Arguments:

  • name (str) – The Name of the Container.

  • container_id (str) – The Id of the Container.

  • ready (bool) – The container ready status.

  • started (bool) – The container start status.

  • restart_count (int) – The container restart count.

class azure.mgmt.appcontainers.models.Resource(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.appcontainers.models.Revision(**kwargs: Any)[source]

Bases: ProxyResource

Container App Revision.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • created_time (datetime) – Timestamp describing when the revision was created by controller.

  • last_active_time (datetime) – Timestamp describing when the revision was last active. Only meaningful when revision is inactive.

  • fqdn (str) – Fully qualified domain name of the revision.

  • template (Template) – Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.

  • active (bool) – Boolean describing if the Revision is Active.

  • replicas (int) – Number of pods currently running for this revision.

  • traffic_weight (int) – Traffic weight assigned to this revision.

  • provisioning_error (str) – Optional Field - Platform Error Message.

  • health_state (str or RevisionHealthState) – Current health State of the revision. Known values are: “Healthy”, “Unhealthy”, and “None”.

  • provisioning_state (str or RevisionProvisioningState) – Current provisioning State of the revision. Known values are: “Provisioning”, “Provisioned”, “Failed”, “Deprovisioning”, and “Deprovisioned”.

  • running_state (str or RevisionRunningState) – Current running state of the revision. Known values are: “Running”, “Processing”, “Stopped”, “Degraded”, “Failed”, and “Unknown”.

class azure.mgmt.appcontainers.models.RevisionCollection(*, value: List[_models.Revision], **kwargs: Any)[source]

Bases: Model

Container App Revisions collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[Revision]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[Revision]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.RevisionHealthState(*values)[source]

Bases: str, Enum

Current health State of the revision.

HEALTHY = 'Healthy'
NONE = 'None'
UNHEALTHY = 'Unhealthy'
class azure.mgmt.appcontainers.models.RevisionProvisioningState(*values)[source]

Bases: str, Enum

Current provisioning State of the revision.

DEPROVISIONED = 'Deprovisioned'
DEPROVISIONING = 'Deprovisioning'
FAILED = 'Failed'
PROVISIONED = 'Provisioned'
PROVISIONING = 'Provisioning'
class azure.mgmt.appcontainers.models.RevisionRunningState(*values)[source]

Bases: str, Enum

Current running state of the revision.

DEGRADED = 'Degraded'
FAILED = 'Failed'
PROCESSING = 'Processing'
RUNNING = 'Running'
STOPPED = 'Stopped'
UNKNOWN = 'Unknown'
class azure.mgmt.appcontainers.models.Runtime(*, java: _models.RuntimeJava | None = None, **kwargs: Any)[source]

Bases: Model

Container App Runtime configuration.

Variables:

java (RuntimeJava) – Java app configuration.

Keyword Arguments:

java (RuntimeJava) – Java app configuration.

class azure.mgmt.appcontainers.models.RuntimeJava(*, enable_metrics: bool | None = None, **kwargs: Any)[source]

Bases: Model

Java app configuration.

Variables:

enable_metrics (bool) – Enable jmx core metrics for the java app.

Keyword Arguments:

enable_metrics (bool) – Enable jmx core metrics for the java app.

class azure.mgmt.appcontainers.models.Scale(*, min_replicas: int | None = None, max_replicas: int = 10, cooldown_period: int | None = None, polling_interval: int | None = None, rules: List[_models.ScaleRule] | None = None, **kwargs: Any)[source]

Bases: Model

Container App scaling configurations.

Variables:

  • min_replicas (int) – Optional. Minimum number of container replicas.

  • max_replicas (int) – Optional. Maximum number of container replicas. Defaults to 10 if not set.

  • cooldown_period (int) – Optional. KEDA Cooldown Period in seconds. Defaults to 300 seconds if not set.

  • polling_interval (int) – Optional. KEDA Polling Interval in seconds. Defaults to 30 seconds if not set.

  • rules (list[ScaleRule]) – Scaling rules.

Keyword Arguments:

  • min_replicas (int) – Optional. Minimum number of container replicas.

  • max_replicas (int) – Optional. Maximum number of container replicas. Defaults to 10 if not set.

  • cooldown_period (int) – Optional. KEDA Cooldown Period in seconds. Defaults to 300 seconds if not set.

  • polling_interval (int) – Optional. KEDA Polling Interval in seconds. Defaults to 30 seconds if not set.

  • rules (list[ScaleRule]) – Scaling rules.

class azure.mgmt.appcontainers.models.ScaleConfiguration(*, max_concurrent_sessions: int | None = None, ready_session_instances: int | None = None, **kwargs: Any)[source]

Bases: Model

Scale configuration.

Variables:

  • max_concurrent_sessions (int) – The maximum count of sessions at the same time.

  • ready_session_instances (int) – The minimum count of ready session instances.

Keyword Arguments:

  • max_concurrent_sessions (int) – The maximum count of sessions at the same time.

  • ready_session_instances (int) – The minimum count of ready session instances.

class azure.mgmt.appcontainers.models.ScaleRule(*, name: str | None = None, azure_queue: _models.QueueScaleRule | None = None, custom: _models.CustomScaleRule | None = None, http: _models.HttpScaleRule | None = None, tcp: _models.TcpScaleRule | None = None, **kwargs: Any)[source]

Bases: Model

Container App container scaling rule.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.ScaleRuleAuth(*, secret_ref: str | None = None, trigger_parameter: str | None = None, **kwargs: Any)[source]

Bases: Model

Auth Secrets for Scale Rule.

Variables:

  • secret_ref (str) – Name of the secret from which to pull the auth params.

  • trigger_parameter (str) – Trigger Parameter that uses the secret.

Keyword Arguments:

  • secret_ref (str) – Name of the secret from which to pull the auth params.

  • trigger_parameter (str) – Trigger Parameter that uses the secret.

class azure.mgmt.appcontainers.models.Scheme(*values)[source]

Bases: str, Enum

Scheme to use for connecting to the host. Defaults to HTTP.

HTTP = 'HTTP'
HTTPS = 'HTTPS'
class azure.mgmt.appcontainers.models.Secret(*, name: str | None = None, value: str | None = None, identity: str | None = None, key_vault_url: str | None = None, **kwargs: Any)[source]

Bases: Model

Secret definition.

Variables:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

  • identity (str) – Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

  • key_vault_url (str) – Azure Key Vault URL pointing to the secret referenced by the container app.

Keyword Arguments:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

  • identity (str) – Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.

  • key_vault_url (str) – Azure Key Vault URL pointing to the secret referenced by the container app.

class azure.mgmt.appcontainers.models.SecretVolumeItem(*, secret_ref: str | None = None, path: str | None = None, **kwargs: Any)[source]

Bases: Model

Secret to be added to volume.

Variables:

  • secret_ref (str) – Name of the Container App secret from which to pull the secret value.

  • path (str) – Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.

Keyword Arguments:

  • secret_ref (str) – Name of the Container App secret from which to pull the secret value.

  • path (str) – Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.

class azure.mgmt.appcontainers.models.SecretsCollection(*, value: List[_models.ContainerAppSecret], **kwargs: Any)[source]

Bases: Model

Container App Secrets Collection ARM resource.

All required parameters must be populated in order to send to server.

Variables:

value (list[ContainerAppSecret]) – Collection of resources. Required.

Keyword Arguments:

value (list[ContainerAppSecret]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.Service(*, type: str, **kwargs: Any)[source]

Bases: Model

Container App to be a dev service.

All required parameters must be populated in order to send to server.

Variables:

type (str) – Dev ContainerApp service type. Required.

Keyword Arguments:

type (str) – Dev ContainerApp service type. Required.

class azure.mgmt.appcontainers.models.ServiceBind(*, service_id: str | None = None, name: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration to bind a ContainerApp to a dev ContainerApp Service.

Variables:

  • service_id (str) – Resource id of the target service.

  • name (str) – Name of the service bind.

Keyword Arguments:

  • service_id (str) – Resource id of the target service.

  • name (str) – Name of the service bind.

class azure.mgmt.appcontainers.models.SessionContainer(*, image: str | None = None, name: str | None = None, command: List[str] | None = None, args: List[str] | None = None, env: List[_models.EnvironmentVar] | None = None, resources: _models.SessionContainerResources | None = None, **kwargs: Any)[source]

Bases: Model

Container definitions for the sessions of the session pool.

Variables:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (SessionContainerResources) – Container resource requirements.

Keyword Arguments:

  • image (str) – Container image tag.

  • name (str) – Custom container name.

  • command (list[str]) – Container start command.

  • args (list[str]) – Container start command arguments.

  • env (list[EnvironmentVar]) – Container environment variables.

  • resources (SessionContainerResources) – Container resource requirements.

class azure.mgmt.appcontainers.models.SessionContainerResources(*, cpu: float | None = None, memory: str | None = None, **kwargs: Any)[source]

Bases: Model

Container resource requirements for sessions of the session pool.

Variables:

  • cpu (float) – Required CPU in cores, e.g. 0.5.

  • memory (str) – Required memory, e.g. “250Mb”.

Keyword Arguments:

  • cpu (float) – Required CPU in cores, e.g. 0.5.

  • memory (str) – Required memory, e.g. “250Mb”.

class azure.mgmt.appcontainers.models.SessionIngress(*, target_port: int | None = None, **kwargs: Any)[source]

Bases: Model

Session pool ingress configuration.

Variables:

target_port (int) – Target port in containers for traffic from ingress.

Keyword Arguments:

target_port (int) – Target port in containers for traffic from ingress.

class azure.mgmt.appcontainers.models.SessionNetworkConfiguration(*, status: str | _models.SessionNetworkStatus | None = None, **kwargs: Any)[source]

Bases: Model

Session network configuration.

Variables:

status (str or SessionNetworkStatus) – Network status for the sessions. Known values are: “EgressEnabled” and “EgressDisabled”.

Keyword Arguments:

status (str or SessionNetworkStatus) – Network status for the sessions. Known values are: “EgressEnabled” and “EgressDisabled”.

class azure.mgmt.appcontainers.models.SessionNetworkStatus(*values)[source]

Bases: str, Enum

Network status for the sessions.

EGRESS_DISABLED = 'EgressDisabled'
EGRESS_ENABLED = 'EgressEnabled'
class azure.mgmt.appcontainers.models.SessionPool(*, location: str, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, environment_id: str | None = None, container_type: str | _models.ContainerType | None = None, pool_management_type: str | _models.PoolManagementType | None = None, scale_configuration: _models.ScaleConfiguration | None = None, secrets: List[_models.SessionPoolSecret] | None = None, dynamic_pool_configuration: _models.DynamicPoolConfiguration | None = None, custom_container_template: _models.CustomContainerTemplate | None = None, session_network_configuration: _models.SessionNetworkConfiguration | None = None, managed_identity_settings: List[_models.ManagedIdentitySetting] | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Container App session pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (ManagedServiceIdentity) – Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.

  • environment_id (str) – Resource ID of the session pool’s environment.

  • container_type (str or ContainerType) – The container type of the sessions. Known values are: “CustomContainer” and “PythonLTS”.

  • pool_management_type (str or PoolManagementType) – The pool management type of the session pool. Known values are: “Manual” and “Dynamic”.

  • node_count (int) – The number of nodes the session pool is using.

  • scale_configuration (ScaleConfiguration) – The scale configuration of the session pool.

  • secrets (list[SessionPoolSecret]) – The secrets of the session pool.

  • dynamic_pool_configuration (DynamicPoolConfiguration) – The pool configuration if the poolManagementType is dynamic.

  • custom_container_template (CustomContainerTemplate) – The custom container configuration if the containerType is CustomContainer.

  • session_network_configuration (SessionNetworkConfiguration) – The network configuration of the sessions in the session pool.

  • pool_management_endpoint (str) – The endpoint to manage the pool.

  • provisioning_state (str or SessionPoolProvisioningState) – Provisioning state of the session pool. Known values are: “InProgress”, “Succeeded”, “Failed”, “Canceled”, and “Deleting”.

  • managed_identity_settings (list[ManagedIdentitySetting]) – Optional settings for a Managed Identity that is assigned to the Session pool.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (ManagedServiceIdentity) – Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.

  • environment_id (str) – Resource ID of the session pool’s environment.

  • container_type (str or ContainerType) – The container type of the sessions. Known values are: “CustomContainer” and “PythonLTS”.

  • pool_management_type (str or PoolManagementType) – The pool management type of the session pool. Known values are: “Manual” and “Dynamic”.

  • scale_configuration (ScaleConfiguration) – The scale configuration of the session pool.

  • secrets (list[SessionPoolSecret]) – The secrets of the session pool.

  • dynamic_pool_configuration (DynamicPoolConfiguration) – The pool configuration if the poolManagementType is dynamic.

  • custom_container_template (CustomContainerTemplate) – The custom container configuration if the containerType is CustomContainer.

  • session_network_configuration (SessionNetworkConfiguration) – The network configuration of the sessions in the session pool.

  • managed_identity_settings (list[ManagedIdentitySetting]) – Optional settings for a Managed Identity that is assigned to the Session pool.

class azure.mgmt.appcontainers.models.SessionPoolCollection(*, value: List[_models.SessionPool], **kwargs: Any)[source]

Bases: Model

Session pool collection Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[SessionPool]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[SessionPool]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.SessionPoolProvisioningState(*values)[source]

Bases: str, Enum

Provisioning state of the session pool.

CANCELED = 'Canceled'
DELETING = 'Deleting'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.SessionPoolSecret(*, name: str | None = None, value: str | None = None, **kwargs: Any)[source]

Bases: Model

Secret definition.

Variables:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

Keyword Arguments:

  • name (str) – Secret Name.

  • value (str) – Secret Value.

class azure.mgmt.appcontainers.models.SessionPoolUpdatableProperties(*, tags: Dict[str, str] | None = None, identity: _models.ManagedServiceIdentity | None = None, scale_configuration: _models.ScaleConfiguration | None = None, secrets: List[_models.SessionPoolSecret] | None = None, dynamic_pool_configuration: _models.DynamicPoolConfiguration | None = None, custom_container_template: _models.CustomContainerTemplate | None = None, session_network_configuration: _models.SessionNetworkConfiguration | None = None, **kwargs: Any)[source]

Bases: Model

Container App session pool updatable properties.

Variables:

  • tags (dict[str, str]) – Resource tags.

  • identity (ManagedServiceIdentity) – Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.

  • scale_configuration (ScaleConfiguration) – The scale configuration of the session pool.

  • secrets (list[SessionPoolSecret]) – The secrets of the session pool.

  • dynamic_pool_configuration (DynamicPoolConfiguration) – The pool configuration if the poolManagementType is dynamic.

  • custom_container_template (CustomContainerTemplate) – The custom container configuration if the containerType is CustomContainer.

  • session_network_configuration (SessionNetworkConfiguration) – The network configuration of the sessions in the session pool.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • identity (ManagedServiceIdentity) – Managed identities needed by a session pool to interact with other Azure services to not maintain any secrets or credentials in code.

  • scale_configuration (ScaleConfiguration) – The scale configuration of the session pool.

  • secrets (list[SessionPoolSecret]) – The secrets of the session pool.

  • dynamic_pool_configuration (DynamicPoolConfiguration) – The pool configuration if the poolManagementType is dynamic.

  • custom_container_template (CustomContainerTemplate) – The custom container configuration if the containerType is CustomContainer.

  • session_network_configuration (SessionNetworkConfiguration) – The network configuration of the sessions in the session pool.

class azure.mgmt.appcontainers.models.SessionRegistryCredentials(*, server: str | None = None, username: str | None = None, password_secret_ref: str | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Session pool private registry credentials.

Variables:

  • server (str) – Container registry server.

  • username (str) – Container registry username.

  • password_secret_ref (str) – The name of the secret that contains the registry login password.

  • identity (str) – A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’.

Keyword Arguments:

  • server (str) – Container registry server.

  • username (str) – Container registry username.

  • password_secret_ref (str) – The name of the secret that contains the registry login password.

  • identity (str) – A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’.

class azure.mgmt.appcontainers.models.SourceControl(*, repo_url: str | None = None, branch: str | None = None, github_action_configuration: _models.GithubActionConfiguration | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Container App SourceControl.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • operation_state (str or SourceControlOperationState) – Current provisioning State of the operation. Known values are: “InProgress”, “Succeeded”, “Failed”, and “Canceled”.

  • repo_url (str) – The repo url which will be integrated to ContainerApp.

  • branch (str) – The branch which will trigger the auto deployment.

  • github_action_configuration (GithubActionConfiguration) – Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.

Keyword Arguments:

  • repo_url (str) – The repo url which will be integrated to ContainerApp.

  • branch (str) – The branch which will trigger the auto deployment.

  • github_action_configuration (GithubActionConfiguration) – Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.

class azure.mgmt.appcontainers.models.SourceControlCollection(*, value: List[_models.SourceControl], **kwargs: Any)[source]

Bases: Model

SourceControl collection ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[SourceControl]) – Collection of resources. Required.

  • next_link (str) – Link to next page of resources.

Keyword Arguments:

value (list[SourceControl]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.SourceControlOperationState(*values)[source]

Bases: str, Enum

Current provisioning State of the operation.

CANCELED = 'Canceled'
FAILED = 'Failed'
IN_PROGRESS = 'InProgress'
SUCCEEDED = 'Succeeded'
class azure.mgmt.appcontainers.models.SpringBootAdminComponent(*, configurations: List[_models.JavaComponentConfigurationProperty] | None = None, scale: _models.JavaComponentPropertiesScale | None = None, service_binds: List[_models.JavaComponentServiceBind] | None = None, ingress: _models.JavaComponentIngress | None = None, **kwargs: Any)[source]

Bases: JavaComponentProperties

Spring Boot Admin properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.SpringCloudConfigComponent(*, configurations: List[_models.JavaComponentConfigurationProperty] | None = None, scale: _models.JavaComponentPropertiesScale | None = None, service_binds: List[_models.JavaComponentServiceBind] | None = None, **kwargs: Any)[source]

Bases: JavaComponentProperties

Spring Cloud Config properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.SpringCloudEurekaComponent(*, configurations: List[_models.JavaComponentConfigurationProperty] | None = None, scale: _models.JavaComponentPropertiesScale | None = None, service_binds: List[_models.JavaComponentServiceBind] | None = None, ingress: _models.JavaComponentIngress | None = None, **kwargs: Any)[source]

Bases: JavaComponentProperties

Spring Cloud Eureka properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.appcontainers.models.StorageType(*values)[source]

Bases: str, Enum

Storage type for the volume. If not provided, use EmptyDir.

AZURE_FILE = 'AzureFile'
EMPTY_DIR = 'EmptyDir'
NFS_AZURE_FILE = 'NfsAzureFile'
SECRET = 'Secret'
class azure.mgmt.appcontainers.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.appcontainers.models.TcpScaleRule(*, metadata: Dict[str, str] | None = None, auth: List[_models.ScaleRuleAuth] | None = None, identity: str | None = None, **kwargs: Any)[source]

Bases: Model

Container App container Tcp scaling rule.

Variables:

  • metadata (dict[str, str]) – Metadata properties to describe tcp scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the tcp scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

Keyword Arguments:

  • metadata (dict[str, str]) – Metadata properties to describe tcp scale rule.

  • auth (list[ScaleRuleAuth]) – Authentication secrets for the tcp scale rule.

  • identity (str) – The resource ID of a user-assigned managed identity that is assigned to the Container App, or ‘system’ for system-assigned identity.

class azure.mgmt.appcontainers.models.Template(*, revision_suffix: str | None = None, termination_grace_period_seconds: int | None = None, init_containers: List[_models.InitContainer] | None = None, containers: List[_models.Container] | None = None, scale: _models.Scale | None = None, volumes: List[_models.Volume] | None = None, service_binds: List[_models.ServiceBind] | None = None, **kwargs: Any)[source]

Bases: Model

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.

Variables:

  • revision_suffix (str) – User friendly suffix that is appended to the revision name.

  • termination_grace_period_seconds (int) – Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

  • init_containers (list[InitContainer]) – List of specialized containers that run before app containers.

  • containers (list[Container]) – List of container definitions for the Container App.

  • scale (Scale) – Scaling properties for the Container App.

  • volumes (list[Volume]) – List of volume definitions for the Container App.

  • service_binds (list[ServiceBind]) – List of container app services bound to the app.

Keyword Arguments:

  • revision_suffix (str) – User friendly suffix that is appended to the revision name.

  • termination_grace_period_seconds (int) – Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

  • init_containers (list[InitContainer]) – List of specialized containers that run before app containers.

  • containers (list[Container]) – List of container definitions for the Container App.

  • scale (Scale) – Scaling properties for the Container App.

  • volumes (list[Volume]) – List of volume definitions for the Container App.

  • service_binds (list[ServiceBind]) – List of container app services bound to the app.

class azure.mgmt.appcontainers.models.TokenStore(*, enabled: bool | None = None, token_refresh_extension_hours: float | None = None, azure_blob_storage: _models.BlobStorageTokenStore | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the token store.

Variables:

  • enabled (bool) –

    <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.

    The default is <code>false</code>.

  • token_refresh_extension_hours (float) – The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.

  • azure_blob_storage (BlobStorageTokenStore) – The configuration settings of the storage of the tokens if blob storage is used.

Keyword Arguments:

  • enabled (bool) –

    <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.

    The default is <code>false</code>.

  • token_refresh_extension_hours (float) – The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.

  • azure_blob_storage (BlobStorageTokenStore) – The configuration settings of the storage of the tokens if blob storage is used.

class azure.mgmt.appcontainers.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.appcontainers.models.TrafficWeight(*, revision_name: str | None = None, weight: int | None = None, latest_revision: bool = False, label: str | None = None, **kwargs: Any)[source]

Bases: Model

Traffic weight assigned to a revision.

Variables:

  • revision_name (str) – Name of a revision.

  • weight (int) – Traffic weight assigned to a revision.

  • latest_revision (bool) – Indicates that the traffic weight belongs to a latest stable revision.

  • label (str) – Associates a traffic label with a revision.

Keyword Arguments:

  • revision_name (str) – Name of a revision.

  • weight (int) – Traffic weight assigned to a revision.

  • latest_revision (bool) – Indicates that the traffic weight belongs to a latest stable revision.

  • label (str) – Associates a traffic label with a revision.

class azure.mgmt.appcontainers.models.TriggerType(*values)[source]

Bases: str, Enum

Trigger type of the job.

EVENT = 'Event'
MANUAL = 'Manual'
SCHEDULE = 'Schedule'
class azure.mgmt.appcontainers.models.Twitter(*, enabled: bool | None = None, registration: _models.TwitterRegistration | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the Twitter provider.

Variables:

  • enabled (bool) – <code>false</code> if the Twitter provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (TwitterRegistration) – The configuration settings of the app registration for the Twitter provider.

Keyword Arguments:

  • enabled (bool) – <code>false</code> if the Twitter provider should not be enabled despite the set registration; otherwise, <code>true</code>.

  • registration (TwitterRegistration) – The configuration settings of the app registration for the Twitter provider.

class azure.mgmt.appcontainers.models.TwitterRegistration(*, consumer_key: str | None = None, consumer_secret_setting_name: str | None = None, **kwargs: Any)[source]

Bases: Model

The configuration settings of the app registration for the Twitter provider.

Variables:

  • consumer_key (str) – The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.

  • consumer_secret_setting_name (str) – The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

Keyword Arguments:

  • consumer_key (str) – The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.

  • consumer_secret_setting_name (str) – The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

class azure.mgmt.appcontainers.models.Type(*values)[source]

Bases: str, Enum

The type of probe.

LIVENESS = 'Liveness'
READINESS = 'Readiness'
STARTUP = 'Startup'
class azure.mgmt.appcontainers.models.UnauthenticatedClientActionV2(*values)[source]

Bases: str, Enum

The action to take when an unauthenticated client attempts to access the app.

ALLOW_ANONYMOUS = 'AllowAnonymous'
REDIRECT_TO_LOGIN_PAGE = 'RedirectToLoginPage'
RETURN401 = 'Return401'
RETURN403 = 'Return403'
class azure.mgmt.appcontainers.models.Usage(*, current_value: float, limit: float, name: _models.UsageName, **kwargs: Any)[source]

Bases: Model

Describes Compute Resource Usage.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • unit (str) – An enum describing the unit of usage measurement. Required. Default value is “Count”.

  • current_value (float) – The current usage of the resource. Required.

  • limit (float) – The maximum permitted usage of the resource. Required.

  • name (UsageName) – The name of the type of usage. Required.

Keyword Arguments:

  • current_value (float) – The current usage of the resource. Required.

  • limit (float) – The maximum permitted usage of the resource. Required.

  • name (UsageName) – The name of the type of usage. Required.

unit = 'Count'
class azure.mgmt.appcontainers.models.UsageName(*, value: str | None = None, localized_value: str | None = None, **kwargs: Any)[source]

Bases: Model

The Usage Names.

Variables:

  • value (str) – The name of the resource.

  • localized_value (str) – The localized name of the resource.

Keyword Arguments:

  • value (str) – The name of the resource.

  • localized_value (str) – The localized name of the resource.

class azure.mgmt.appcontainers.models.UserAssignedIdentity(**kwargs: Any)[source]

Bases: Model

User assigned identity properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of the assigned identity.

  • client_id (str) – The client ID of the assigned identity.

class azure.mgmt.appcontainers.models.VnetConfiguration(*, internal: bool | None = None, infrastructure_subnet_id: str | None = None, docker_bridge_cidr: str | None = None, platform_reserved_cidr: str | None = None, platform_reserved_dns_ip: str | None = None, **kwargs: Any)[source]

Bases: Model

Configuration properties for apps environment to join a Virtual Network.

Variables:

  • internal (bool) – Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property.

  • infrastructure_subnet_id (str) – Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.

  • docker_bridge_cidr (str) – CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.

  • platform_reserved_cidr (str) – IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.

  • platform_reserved_dns_ip (str) – An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.

Keyword Arguments:

  • internal (bool) – Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property.

  • infrastructure_subnet_id (str) – Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.

  • docker_bridge_cidr (str) – CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.

  • platform_reserved_cidr (str) – IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.

  • platform_reserved_dns_ip (str) – An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.

class azure.mgmt.appcontainers.models.Volume(*, name: str | None = None, storage_type: str | _models.StorageType | None = None, storage_name: str | None = None, secrets: List[_models.SecretVolumeItem] | None = None, mount_options: str | None = None, **kwargs: Any)[source]

Bases: Model

Volume definitions for the Container App.

Variables:

  • name (str) – Volume name.

  • storage_type (str or StorageType) – Storage type for the volume. If not provided, use EmptyDir. Known values are: “AzureFile”, “EmptyDir”, “Secret”, and “NfsAzureFile”.

  • storage_name (str) – Name of storage resource. No need to provide for EmptyDir and Secret.

  • secrets (list[SecretVolumeItem]) – List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

  • mount_options (str) – Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string.

Keyword Arguments:

  • name (str) – Volume name.

  • storage_type (str or StorageType) – Storage type for the volume. If not provided, use EmptyDir. Known values are: “AzureFile”, “EmptyDir”, “Secret”, and “NfsAzureFile”.

  • storage_name (str) – Name of storage resource. No need to provide for EmptyDir and Secret.

  • secrets (list[SecretVolumeItem]) – List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

  • mount_options (str) – Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string.

class azure.mgmt.appcontainers.models.VolumeMount(*, volume_name: str | None = None, mount_path: str | None = None, sub_path: str | None = None, **kwargs: Any)[source]

Bases: Model

Volume mount for the Container App.

Variables:

  • volume_name (str) – This must match the Name of a Volume.

  • mount_path (str) – Path within the container at which the volume should be mounted.Must not contain ‘:’.

  • sub_path (str) – Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

Keyword Arguments:

  • volume_name (str) – This must match the Name of a Volume.

  • mount_path (str) – Path within the container at which the volume should be mounted.Must not contain ‘:’.

  • sub_path (str) – Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root).

class azure.mgmt.appcontainers.models.WorkloadProfile(*, name: str, workload_profile_type: str, minimum_count: int | None = None, maximum_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Workload profile to scope container app execution.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – Workload profile type for the workloads to run on. Required.

  • workload_profile_type (str) – Workload profile type for the workloads to run on. Required.

  • minimum_count (int) – The minimum capacity.

  • maximum_count (int) – The maximum capacity.

Keyword Arguments:

  • name (str) – Workload profile type for the workloads to run on. Required.

  • workload_profile_type (str) – Workload profile type for the workloads to run on. Required.

  • minimum_count (int) – The minimum capacity.

  • maximum_count (int) – The maximum capacity.

class azure.mgmt.appcontainers.models.WorkloadProfileStates(*, properties: _models.WorkloadProfileStatesProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Collection of all the workload Profile States for a Managed Environment..

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (WorkloadProfileStatesProperties) – Workload Profile resource specific properties.

Keyword Arguments:

properties (WorkloadProfileStatesProperties) – Workload Profile resource specific properties.

class azure.mgmt.appcontainers.models.WorkloadProfileStatesCollection(*, value: List[_models.WorkloadProfileStates], **kwargs: Any)[source]

Bases: Model

Collection of workloadProfileStates.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:

value (list[WorkloadProfileStates]) – Collection of resources. Required.

class azure.mgmt.appcontainers.models.WorkloadProfileStatesProperties(*, minimum_count: int | None = None, maximum_count: int | None = None, current_count: int | None = None, **kwargs: Any)[source]

Bases: Model

Workload Profile resource specific properties.

Variables:

  • minimum_count (int) – Minimum count of instances.

  • maximum_count (int) – Maximum count of nodes.

  • current_count (int) – Current count of nodes.

Keyword Arguments:

  • minimum_count (int) – Minimum count of instances.

  • maximum_count (int) – Maximum count of nodes.

  • current_count (int) – Current count of nodes.