Package: azure-mgmt-appplatform
Microsoft Azure SDK for PythonThis 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 theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.8+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-appplatform
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.appplatformimportAppPlatformManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=AppPlatformManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search App Platform Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History9.0.0 (2024-01-26)Features AddedAdded operation BuildServiceOperations.begin_create_or_updateAdded operation BuildServiceOperations.begin_delete_buildAdded operation ConfigurationServicesOperations.begin_validate_resourceAdded operation GatewaysOperations.begin_restartAdded operation ServicesOperations.begin_disable_apm_globallyAdded operation ServicesOperations.begin_enable_apm_globallyAdded operation ServicesOperations.begin_flush_vnet_dns_settingAdded operation ServicesOperations.list_globally_enabled_apmsAdded operation ServicesOperations.list_supported_apm_typesAdded operation ServicesOperations.list_supported_server_versionsAdded operation group ApmsOperationsAdded operation group ContainerRegistriesOperationsAdded operation group EurekaServersOperationsModel AcceleratorBasicAuthSetting has a new parameter ca_cert_resource_idModel AcceleratorGitRepository has a new parameter sub_pathModel AcceleratorPublicSetting has a new parameter ca_cert_resource_idModel ApiPortalProperties has a new parameter api_try_out_enabled_stateModel BuildProperties has a new parameter apmsModel BuildProperties has a new parameter certificatesModel BuildResultProperties has a new parameter imageModel BuildServiceProperties has a new parameter container_registryModel ConfigurationServiceGitRepository has a new parameter ca_cert_resource_idModel ConfigurationServiceGitRepository has a new parameter git_implementationModel ConfigurationServiceProperties has a new parameter generationModel CustomizedAcceleratorProperties has a new parameter accelerator_typeModel CustomizedAcceleratorProperties has a new parameter importsModel DeploymentSettings has a new parameter apmsModel DevToolPortalProperties has a new parameter componentsModel GatewayCorsProperties has a new parameter allowed_origin_patternsModel GatewayProperties has a new parameter apmsModel GatewayProperties has a new parameter client_authModel KeyVaultCertificateProperties has a new parameter auto_syncModel ServiceVNetAddons has a new parameter data_plane_public_endpointModel TriggeredBuildResult has a new parameter imageModel TriggeredBuildResult has a new parameter last_transition_reasonModel TriggeredBuildResult has a new parameter last_transition_statusModel TriggeredBuildResult has a new parameter last_transition_timeModel TriggeredBuildResult has a new parameter provisioning_stateOperation DeploymentsOperations.list_for_cluster has a new optional parameter expandBreaking ChangesModel AppResourceProperties no longer has parameter secretsModel ClusterResourceProperties no longer has parameter infra_resource_groupModel ClusterResourceProperties no longer has parameter managed_environment_idModel DeploymentSettings no longer has parameter scaleModel DevToolPortalProperties no longer has parameter instancesModel DevToolPortalProperties no longer has parameter resource_requestsModel GatewayProperties no longer has parameter apm_typesRemoved operation GatewaysOperations.begin_update_capacityRenamed operation CustomizedAcceleratorsOperations.validate to CustomizedAcceleratorsOperations.begin_validate8.0.0 (2023-04-20)Features AddedAdded operation BuildServiceBuilderOperations.list_deploymentsAdded operation BuildpackBindingOperations.list_for_clusterAdded operation DeploymentsOperations.begin_disable_remote_debuggingAdded operation DeploymentsOperations.begin_enable_remote_debuggingAdded operation DeploymentsOperations.get_remote_debugging_configAdded operation GatewaysOperations.begin_update_capacityAdded operation GatewaysOperations.list_env_secretsAdded operation group ApplicationAcceleratorsOperationsAdded operation group ApplicationLiveViewsOperationsAdded operation group CustomizedAcceleratorsOperationsAdded operation group DevToolPortalsOperationsAdded operation group PredefinedAcceleratorsOperationsModel AppResourceProperties has a new parameter ingress_settingsModel AppResourceProperties has a new parameter secretsModel AzureFileVolume has a new parameter enable_sub_pathModel BuildResultProperties has a new parameter errorModel BuildStageProperties has a new parameter exit_codeModel BuildStageProperties has a new parameter reasonModel ClusterResourceProperties has a new parameter infra_resource_groupModel ClusterResourceProperties has a new parameter managed_environment_idModel CustomPersistentDiskProperties has a new parameter enable_sub_pathModel DeploymentSettings has a new parameter scaleModel GatewayProperties has a new parameter apm_typesModel GatewayProperties has a new parameter environment_variablesModel GatewayRouteConfigProperties has a new parameter filtersModel GatewayRouteConfigProperties has a new parameter predicatesModel GatewayRouteConfigProperties has a new parameter protocolModel GatewayRouteConfigProperties has a new parameter sso_enabledModel NetworkProfile has a new parameter outbound_type8.0.0b1 (2023-02-13)Features AddedAdded operation BuildServiceBuilderOperations.list_deploymentsAdded operation DeploymentsOperations.begin_disable_remote_debuggingAdded operation DeploymentsOperations.begin_enable_remote_debuggingAdded operation DeploymentsOperations.get_remote_debugging_configAdded operation group ApplicationAcceleratorsOperationsAdded operation group ApplicationLiveViewsOperationsAdded operation group CustomizedAcceleratorsOperationsAdded operation group DevToolPortalsOperationsAdded operation group PredefinedAcceleratorsOperationsModel AppResourceProperties has a new parameter ingress_settingsModel GatewayRouteConfigProperties has a new parameter protocolModel NetworkProfile has a new parameter outbound_typeBreaking ChangesModel ClusterResourceProperties no longer has parameter marketplace_resource7.1.0 (2022-05-16)FeaturesModel AppResourceProperties has a new parameter vnet_addonsModel BuildProperties has a new parameter resource_requestsModel CertificateProperties has a new parameter provisioning_stateModel ClusterResourceProperties has a new parameter marketplace_resourceModel ClusterResourceProperties has a new parameter vnet_addonsModel ContentCertificateProperties has a new parameter provisioning_stateModel CustomContainer has a new parameter language_frameworkModel CustomDomainProperties has a new parameter provisioning_stateModel DeploymentSettings has a new parameter liveness_probeModel DeploymentSettings has a new parameter readiness_probeModel DeploymentSettings has a new parameter startup_probeModel DeploymentSettings has a new parameter termination_grace_period_secondsModel GatewayRouteConfigProperties has a new parameter open_apiModel KeyVaultCertificateProperties has a new parameter provisioning_stateModel ManagedIdentityProperties has a new parameter user_assigned_identitiesModel NetworkProfile has a new parameter ingress_config7.0.0 (2022-02-22)FeaturesAdded operation AppsOperations.begin_set_active_deploymentsAdded operation DeploymentsOperations.begin_generate_heap_dumpAdded operation DeploymentsOperations.begin_generate_thread_dumpAdded operation DeploymentsOperations.begin_start_jfrAdded operation ServicesOperations.begin_startAdded operation ServicesOperations.begin_stopAdded operation group ApiPortalCustomDomainsOperationsAdded operation group ApiPortalsOperationsAdded operation group BuildServiceAgentPoolOperationsAdded operation group BuildServiceBuilderOperationsAdded operation group BuildServiceOperationsAdded operation group BuildpackBindingOperationsAdded operation group ConfigurationServicesOperationsAdded operation group GatewayCustomDomainsOperationsAdded operation group GatewayRouteConfigsOperationsAdded operation group GatewaysOperationsAdded operation group ServiceRegistriesOperationsAdded operation group StoragesOperationsModel AppResource has a new parameter system_dataModel AppResourceProperties has a new parameter addon_configsModel AppResourceProperties has a new parameter custom_persistent_disksModel AppResourceProperties has a new parameter loaded_certificatesModel BindingResource has a new parameter system_dataModel CertificateResource has a new parameter system_dataModel ClusterResourceProperties has a new parameter fqdnModel ClusterResourceProperties has a new parameter power_stateModel ClusterResourceProperties has a new parameter zone_redundantModel ConfigServerResource has a new parameter system_dataModel CustomDomainResource has a new parameter system_dataModel DeploymentInstance has a new parameter zoneModel DeploymentResource has a new parameter system_dataModel DeploymentSettings has a new parameter addon_configsModel DeploymentSettings has a new parameter container_probe_settingsModel MetricSpecification has a new parameter source_mdm_namespaceModel MonitoringSettingResource has a new parameter system_dataModel OperationDetail has a new parameter action_typeModel ProxyResource has a new parameter system_dataModel Resource has a new parameter system_dataModel ServiceResource has a new parameter system_dataModel TrackedResource has a new parameter system_dataBreaking changesModel AppResourceProperties no longer has parameter active_deployment_nameModel AppResourceProperties no longer has parameter created_timeModel CertificateProperties has a new required parameter typeModel CertificateProperties no longer has parameter cert_versionModel CertificateProperties no longer has parameter key_vault_cert_nameModel CertificateProperties no longer has parameter vault_uriModel DeploymentResourceProperties no longer has parameter app_nameModel DeploymentResourceProperties no longer has parameter created_timeModel DeploymentSettings no longer has parameter cpuModel DeploymentSettings no longer has parameter jvm_optionsModel DeploymentSettings no longer has parameter memory_in_gbModel DeploymentSettings no longer has parameter net_core_main_entry_pathModel DeploymentSettings no longer has parameter runtime_versionModel UserSourceInfo no longer has parameter artifact_selectorModel UserSourceInfo no longer has parameter custom_containerModel UserSourceInfo no longer has parameter relative_pathParameter type of model UserSourceInfo is now requiredRemoved operation group SkuOperations6.1.0 (2021-07-09)FeaturesModel UserSourceInfo has a new parameter custom_containerModel MetricDimension has a new parameter to_be_exported_for_shoeboxModel DeploymentSettings has a new parameter resource_requests6.0.0 (2021-04-08)FeaturesModel MonitoringSettingProperties has a new parameter app_insights_agent_versionsModel MonitoringSettingProperties has a new parameter app_insights_sampling_rateModel AppResourceProperties has a new parameter enable_end_to_end_tlsModel NetworkProfile has a new parameter required_traffics6.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 changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute 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 theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of
supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.1.0.0 (2020-08-25)Initial API version Release0.1.0 (2019-10-25)Additional pre-release API changes0.1.0rc1 (2019-10-24)Initial Release