Metadata-Version: 2.1
Name: azure-mgmt-appplatform
Version: 9.0.0
Summary: Microsoft Azure App Platform Management Client Library for Python
Home-page: https://github.com/Azure/azure-sdk-for-python
Author: Microsoft Corporation
Author-email: azpysdkhelp@microsoft.com
License: MIT License
Keywords: azure,azure sdk
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: isodate<1.0.0,>=0.6.1
Requires-Dist: azure-common~=1.1
Requires-Dist: azure-mgmt-core<2.0.0,>=1.3.2

# Microsoft Azure SDK for Python

This is the Microsoft Azure App Platform Management Client Library.
This package has been tested with Python 3.8+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.8+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-appplatform
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.appplatform import AppPlatformManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AppPlatformManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search App Platform Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 


# Release History

## 9.0.0 (2024-01-26)

### Features Added

  - Added operation BuildServiceOperations.begin_create_or_update
  - Added operation BuildServiceOperations.begin_delete_build
  - Added operation ConfigurationServicesOperations.begin_validate_resource
  - Added operation GatewaysOperations.begin_restart
  - Added operation ServicesOperations.begin_disable_apm_globally
  - Added operation ServicesOperations.begin_enable_apm_globally
  - Added operation ServicesOperations.begin_flush_vnet_dns_setting
  - Added operation ServicesOperations.list_globally_enabled_apms
  - Added operation ServicesOperations.list_supported_apm_types
  - Added operation ServicesOperations.list_supported_server_versions
  - Added operation group ApmsOperations
  - Added operation group ContainerRegistriesOperations
  - Added operation group EurekaServersOperations
  - Model AcceleratorBasicAuthSetting has a new parameter ca_cert_resource_id
  - Model AcceleratorGitRepository has a new parameter sub_path
  - Model AcceleratorPublicSetting has a new parameter ca_cert_resource_id
  - Model ApiPortalProperties has a new parameter api_try_out_enabled_state
  - Model BuildProperties has a new parameter apms
  - Model BuildProperties has a new parameter certificates
  - Model BuildResultProperties has a new parameter image
  - Model BuildServiceProperties has a new parameter container_registry
  - Model ConfigurationServiceGitRepository has a new parameter ca_cert_resource_id
  - Model ConfigurationServiceGitRepository has a new parameter git_implementation
  - Model ConfigurationServiceProperties has a new parameter generation
  - Model CustomizedAcceleratorProperties has a new parameter accelerator_type
  - Model CustomizedAcceleratorProperties has a new parameter imports
  - Model DeploymentSettings has a new parameter apms
  - Model DevToolPortalProperties has a new parameter components
  - Model GatewayCorsProperties has a new parameter allowed_origin_patterns
  - Model GatewayProperties has a new parameter apms
  - Model GatewayProperties has a new parameter client_auth
  - Model KeyVaultCertificateProperties has a new parameter auto_sync
  - Model ServiceVNetAddons has a new parameter data_plane_public_endpoint
  - Model TriggeredBuildResult has a new parameter image
  - Model TriggeredBuildResult has a new parameter last_transition_reason
  - Model TriggeredBuildResult has a new parameter last_transition_status
  - Model TriggeredBuildResult has a new parameter last_transition_time
  - Model TriggeredBuildResult has a new parameter provisioning_state
  - Operation DeploymentsOperations.list_for_cluster has a new optional parameter expand

### Breaking Changes

  - Model AppResourceProperties no longer has parameter secrets
  - Model ClusterResourceProperties no longer has parameter infra_resource_group
  - Model ClusterResourceProperties no longer has parameter managed_environment_id
  - Model DeploymentSettings no longer has parameter scale
  - Model DevToolPortalProperties no longer has parameter instances
  - Model DevToolPortalProperties no longer has parameter resource_requests
  - Model GatewayProperties no longer has parameter apm_types
  - Removed operation GatewaysOperations.begin_update_capacity
  - Renamed operation CustomizedAcceleratorsOperations.validate to CustomizedAcceleratorsOperations.begin_validate

## 8.0.0 (2023-04-20)

### Features Added

  - Added operation BuildServiceBuilderOperations.list_deployments
  - Added operation BuildpackBindingOperations.list_for_cluster
  - Added operation DeploymentsOperations.begin_disable_remote_debugging
  - Added operation DeploymentsOperations.begin_enable_remote_debugging
  - Added operation DeploymentsOperations.get_remote_debugging_config
  - Added operation GatewaysOperations.begin_update_capacity
  - Added operation GatewaysOperations.list_env_secrets
  - Added operation group ApplicationAcceleratorsOperations
  - Added operation group ApplicationLiveViewsOperations
  - Added operation group CustomizedAcceleratorsOperations
  - Added operation group DevToolPortalsOperations
  - Added operation group PredefinedAcceleratorsOperations
  - Model AppResourceProperties has a new parameter ingress_settings
  - Model AppResourceProperties has a new parameter secrets
  - Model AzureFileVolume has a new parameter enable_sub_path
  - Model BuildResultProperties has a new parameter error
  - Model BuildStageProperties has a new parameter exit_code
  - Model BuildStageProperties has a new parameter reason
  - Model ClusterResourceProperties has a new parameter infra_resource_group
  - Model ClusterResourceProperties has a new parameter managed_environment_id
  - Model CustomPersistentDiskProperties has a new parameter enable_sub_path
  - Model DeploymentSettings has a new parameter scale
  - Model GatewayProperties has a new parameter apm_types
  - Model GatewayProperties has a new parameter environment_variables
  - Model GatewayRouteConfigProperties has a new parameter filters
  - Model GatewayRouteConfigProperties has a new parameter predicates
  - Model GatewayRouteConfigProperties has a new parameter protocol
  - Model GatewayRouteConfigProperties has a new parameter sso_enabled
  - Model NetworkProfile has a new parameter outbound_type

## 8.0.0b1 (2023-02-13)

### Features Added

  - Added operation BuildServiceBuilderOperations.list_deployments
  - Added operation DeploymentsOperations.begin_disable_remote_debugging
  - Added operation DeploymentsOperations.begin_enable_remote_debugging
  - Added operation DeploymentsOperations.get_remote_debugging_config
  - Added operation group ApplicationAcceleratorsOperations
  - Added operation group ApplicationLiveViewsOperations
  - Added operation group CustomizedAcceleratorsOperations
  - Added operation group DevToolPortalsOperations
  - Added operation group PredefinedAcceleratorsOperations
  - Model AppResourceProperties has a new parameter ingress_settings
  - Model GatewayRouteConfigProperties has a new parameter protocol
  - Model NetworkProfile has a new parameter outbound_type

### Breaking Changes

  - Model ClusterResourceProperties no longer has parameter marketplace_resource

## 7.1.0 (2022-05-16)

**Features**

  - Model AppResourceProperties has a new parameter vnet_addons
  - Model BuildProperties has a new parameter resource_requests
  - Model CertificateProperties has a new parameter provisioning_state
  - Model ClusterResourceProperties has a new parameter marketplace_resource
  - Model ClusterResourceProperties has a new parameter vnet_addons
  - Model ContentCertificateProperties has a new parameter provisioning_state
  - Model CustomContainer has a new parameter language_framework
  - Model CustomDomainProperties has a new parameter provisioning_state
  - Model DeploymentSettings has a new parameter liveness_probe
  - Model DeploymentSettings has a new parameter readiness_probe
  - Model DeploymentSettings has a new parameter startup_probe
  - Model DeploymentSettings has a new parameter termination_grace_period_seconds
  - Model GatewayRouteConfigProperties has a new parameter open_api
  - Model KeyVaultCertificateProperties has a new parameter provisioning_state
  - Model ManagedIdentityProperties has a new parameter user_assigned_identities
  - Model NetworkProfile has a new parameter ingress_config

## 7.0.0 (2022-02-22)

**Features**

  - Added operation AppsOperations.begin_set_active_deployments
  - Added operation DeploymentsOperations.begin_generate_heap_dump
  - Added operation DeploymentsOperations.begin_generate_thread_dump
  - Added operation DeploymentsOperations.begin_start_jfr
  - Added operation ServicesOperations.begin_start
  - Added operation ServicesOperations.begin_stop
  - Added operation group ApiPortalCustomDomainsOperations
  - Added operation group ApiPortalsOperations
  - Added operation group BuildServiceAgentPoolOperations
  - Added operation group BuildServiceBuilderOperations
  - Added operation group BuildServiceOperations
  - Added operation group BuildpackBindingOperations
  - Added operation group ConfigurationServicesOperations
  - Added operation group GatewayCustomDomainsOperations
  - Added operation group GatewayRouteConfigsOperations
  - Added operation group GatewaysOperations
  - Added operation group ServiceRegistriesOperations
  - Added operation group StoragesOperations
  - Model AppResource has a new parameter system_data
  - Model AppResourceProperties has a new parameter addon_configs
  - Model AppResourceProperties has a new parameter custom_persistent_disks
  - Model AppResourceProperties has a new parameter loaded_certificates
  - Model BindingResource has a new parameter system_data
  - Model CertificateResource has a new parameter system_data
  - Model ClusterResourceProperties has a new parameter fqdn
  - Model ClusterResourceProperties has a new parameter power_state
  - Model ClusterResourceProperties has a new parameter zone_redundant
  - Model ConfigServerResource has a new parameter system_data
  - Model CustomDomainResource has a new parameter system_data
  - Model DeploymentInstance has a new parameter zone
  - Model DeploymentResource has a new parameter system_data
  - Model DeploymentSettings has a new parameter addon_configs
  - Model DeploymentSettings has a new parameter container_probe_settings
  - Model MetricSpecification has a new parameter source_mdm_namespace
  - Model MonitoringSettingResource has a new parameter system_data
  - Model OperationDetail has a new parameter action_type
  - Model ProxyResource has a new parameter system_data
  - Model Resource has a new parameter system_data
  - Model ServiceResource has a new parameter system_data
  - Model TrackedResource has a new parameter system_data

**Breaking changes**

  - Model AppResourceProperties no longer has parameter active_deployment_name
  - Model AppResourceProperties no longer has parameter created_time
  - Model CertificateProperties has a new required parameter type
  - Model CertificateProperties no longer has parameter cert_version
  - Model CertificateProperties no longer has parameter key_vault_cert_name
  - Model CertificateProperties no longer has parameter vault_uri
  - Model DeploymentResourceProperties no longer has parameter app_name
  - Model DeploymentResourceProperties no longer has parameter created_time
  - Model DeploymentSettings no longer has parameter cpu
  - Model DeploymentSettings no longer has parameter jvm_options
  - Model DeploymentSettings no longer has parameter memory_in_gb
  - Model DeploymentSettings no longer has parameter net_core_main_entry_path
  - Model DeploymentSettings no longer has parameter runtime_version
  - Model UserSourceInfo no longer has parameter artifact_selector
  - Model UserSourceInfo no longer has parameter custom_container
  - Model UserSourceInfo no longer has parameter relative_path
  - Parameter type of model UserSourceInfo is now required
  - Removed operation group SkuOperations

## 6.1.0 (2021-07-09)

**Features**

  - Model UserSourceInfo has a new parameter custom_container
  - Model MetricDimension has a new parameter to_be_exported_for_shoebox
  - Model DeploymentSettings has a new parameter resource_requests

## 6.0.0 (2021-04-08)

**Features**

  - Model MonitoringSettingProperties has a new parameter app_insights_agent_versions
  - Model MonitoringSettingProperties has a new parameter app_insights_sampling_rate
  - Model AppResourceProperties has a new parameter enable_end_to_end_tls
  - Model NetworkProfile has a new parameter required_traffics

## 6.0.0b1 (2020-12-03)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of
  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.

## 1.0.0 (2020-08-25)

  - Initial API version Release

## 0.1.0 (2019-10-25)

  - Additional pre-release API changes

## 0.1.0rc1 (2019-10-24)

  - Initial Release
