azure-mgmt-apimanagement
Microsoft Azure API Management Client Library for Python
Description
Microsoft Azure SDK for Python
This is the Microsoft Azure API 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.
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
Install the package
pip install azure-mgmt-apimanagement
pip install azure-identity
Authentication
By default, Azure Active Directory token authentication depends on correct configuration of the 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 variable AZURE_SUBSCRIPTION_ID.
With above configuration, client can be authenticated by following code:
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ApiManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples
Code samples for this package can be found at:
- Search API Management on docs.microsoft.com
- Azure Python Mgmt SDK Samples Repo
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Release History
5.0.0 (2025-04-21)
Features Added
- Client
ApiManagementClientadded operation groupapi_gateway - Client
ApiManagementClientadded operation groupapi_management_gateway_skus - Client
ApiManagementClientadded operation groupall_policies - Client
ApiManagementClientadded operation groupapi_gateway_config_connection - Client
ApiManagementClientadded operation grouppolicy_restriction - Client
ApiManagementClientadded operation grouppolicy_restriction_validations - Client
ApiManagementClientadded operation groupproduct_api_link - Client
ApiManagementClientadded operation groupproduct_group_link - Client
ApiManagementClientadded operation grouptag_api_link - Client
ApiManagementClientadded operation grouptag_operation_link - Client
ApiManagementClientadded operation grouptag_product_link - Client
ApiManagementClientadded operation groupworkspace_backend - Client
ApiManagementClientadded operation groupworkspace_certificate - Client
ApiManagementClientadded operation groupworkspace_diagnostic - Client
ApiManagementClientadded operation groupworkspace_api_diagnostic - Client
ApiManagementClientadded operation groupapi_management_workspace_links - Client
ApiManagementClientadded operation groupapi_management_workspace_link - Client
ApiManagementClientadded operation groupworkspace_logger - Client
ApiManagementClientadded operation groupworkspace - Client
ApiManagementClientadded operation groupworkspace_policy - Client
ApiManagementClientadded operation groupworkspace_named_value - Client
ApiManagementClientadded operation groupworkspace_global_schema - Client
ApiManagementClientadded operation groupworkspace_notification - Client
ApiManagementClientadded operation groupworkspace_notification_recipient_user - Client
ApiManagementClientadded operation groupworkspace_notification_recipient_email - Client
ApiManagementClientadded operation groupworkspace_policy_fragment - Client
ApiManagementClientadded operation groupworkspace_group - Client
ApiManagementClientadded operation groupworkspace_group_user - Client
ApiManagementClientadded operation groupworkspace_subscription - Client
ApiManagementClientadded operation groupworkspace_api_version_set - Client
ApiManagementClientadded operation groupworkspace_api - Client
ApiManagementClientadded operation groupworkspace_api_revision - Client
ApiManagementClientadded operation groupworkspace_api_release - Client
ApiManagementClientadded operation groupworkspace_api_operation - Client
ApiManagementClientadded operation groupworkspace_api_operation_policy - Client
ApiManagementClientadded operation groupworkspace_api_policy - Client
ApiManagementClientadded operation groupworkspace_api_schema - Client
ApiManagementClientadded operation groupworkspace_product - Client
ApiManagementClientadded operation groupworkspace_product_api_link - Client
ApiManagementClientadded operation groupworkspace_product_group_link - Client
ApiManagementClientadded operation groupworkspace_product_policy - Client
ApiManagementClientadded operation groupworkspace_tag - Client
ApiManagementClientadded operation groupworkspace_tag_api_link - Client
ApiManagementClientadded operation groupworkspace_tag_operation_link - Client
ApiManagementClientadded operation groupworkspace_tag_product_link - Client
ApiManagementClientadded operation groupworkspace_api_export - Client
ApiManagementClientadded operation groupoperation_status - Client
ApiManagementClientadded operation groupoperations_results - Model
ApiContractadded propertyprovisioning_state - Model
ApiContractPropertiesadded propertyprovisioning_state - Model
ApiCreateOrUpdateParameteradded propertyprovisioning_state - Model
ApiCreateOrUpdatePropertiesadded propertyprovisioning_state - Model
ApiManagementServiceBasePropertiesadded propertyconfiguration_api - Model
ApiManagementServiceBasePropertiesadded propertylegacy_portal_status - Model
ApiManagementServiceBasePropertiesadded propertydeveloper_portal_status - Model
ApiManagementServicePropertiesadded propertyconfiguration_api - Model
ApiManagementServicePropertiesadded propertylegacy_portal_status - Model
ApiManagementServicePropertiesadded propertydeveloper_portal_status - Model
ApiManagementServiceResourceadded propertyconfiguration_api - Model
ApiManagementServiceResourceadded propertylegacy_portal_status - Model
ApiManagementServiceResourceadded propertydeveloper_portal_status - Model
ApiManagementServiceUpdateParametersadded propertyconfiguration_api - Model
ApiManagementServiceUpdateParametersadded propertylegacy_portal_status - Model
ApiManagementServiceUpdateParametersadded propertydeveloper_portal_status - Model
ApiManagementServiceUpdatePropertiesadded propertyconfiguration_api - Model
ApiManagementServiceUpdatePropertiesadded propertylegacy_portal_status - Model
ApiManagementServiceUpdatePropertiesadded propertydeveloper_portal_status - Enum
ApiTypeadded memberGRPC - Enum
ApiTypeadded memberODATA - Model
AuthorizationAccessPolicyContractadded propertyapp_ids - Model
BackendBaseParametersadded propertycircuit_breaker - Model
BackendBaseParametersadded propertypool - Model
BackendBaseParametersadded propertytype - Model
BackendContractadded propertycircuit_breaker - Model
BackendContractadded propertypool - Model
BackendContractadded propertytype_properties_type - Model
BackendContractPropertiesadded propertycircuit_breaker - Model
BackendContractPropertiesadded propertypool - Model
BackendContractPropertiesadded propertytype - Model
BackendUpdateParameterPropertiesadded propertycircuit_breaker - Model
BackendUpdateParameterPropertiesadded propertypool - Model
BackendUpdateParameterPropertiesadded propertytype - Model
BackendUpdateParametersadded propertycircuit_breaker - Model
BackendUpdateParametersadded propertypool - Model
BackendUpdateParametersadded propertytype - Enum
ContentFormatadded memberGRPC - Enum
ContentFormatadded memberGRPC_LINK - Enum
ContentFormatadded memberODATA - Enum
ContentFormatadded memberODATA_LINK - Model
ErrorResponseadded propertyerror - Model
GlobalSchemaContractadded propertyprovisioning_state - Enum
HostnameTypeadded memberCONFIGURATION_API - Model
NamedValueContractadded propertyprovisioning_state - Model
NamedValueContractPropertiesadded propertyprovisioning_state - Enum
PlatformVersionadded memberSTV2_1 - Model
PolicyFragmentContractadded propertyprovisioning_state - Model
PortalRevisionContractadded propertyprovisioning_state - Model
SchemaContractadded propertyprovisioning_state - Enum
SkuTypeadded memberBASIC_V2 - Enum
SkuTypeadded memberSTANDARD_V2 - Enum
SoapApiTypeadded memberG_RPC - Enum
SoapApiTypeadded memberO_DATA - Added model
AllPoliciesCollection - Added model
AllPoliciesContract - Added enum
ApiGatewaySkuType - Added model
ApiManagementGatewayBaseProperties - Added model
ApiManagementGatewayConfigConnectionListResult - Added model
ApiManagementGatewayConfigConnectionResource - Added model
ApiManagementGatewayListResult - Added model
ApiManagementGatewayProperties - Added model
ApiManagementGatewayResource - Added model
ApiManagementGatewaySkuProperties - Added model `ApiManagementGatewaySkuPropertiesF