---
title: "azure-mgmt-apimanagement | pypx"
description: "Microsoft Azure API Management Client Library for Python"
canonical_url: "https://pypx.app/packages/azure-mgmt-apimanagement"
meta:
  "og:description": "Microsoft Azure API Management Client Library for Python"
  "og:image": "https://pypx.app/_og/d/h_630%2Cc_PackageCard%2Cname_azure-mgmt-apimanagement%2Cversion_5.0.0%2Csummary_Microsoft%2BAzure%2BAPI%2BManagement%2BClient%2BLibrary%2Bfor%2BPython%2Clicense_MIT%2BLicense%2Cp_Ii9wYWNrYWdlcy9henVyZS1tZ210LWFwaW1hbmFnZW1lbnQi%2Cs_Hpf0Ejp66XWWBZkM.png"
  "og:image:height": "630"
  "og:image:type": image/png
  "og:image:width": "1200"
  "og:title": "azure-mgmt-apimanagement 5.0.0"
  "twitter:image": "https://pypx.app/_og/d/h_630%2Cc_PackageCard%2Cname_azure-mgmt-apimanagement%2Cversion_5.0.0%2Csummary_Microsoft%2BAzure%2BAPI%2BManagement%2BClient%2BLibrary%2Bfor%2BPython%2Clicense_MIT%2BLicense%2Cp_Ii9wYWNrYWdlcy9henVyZS1tZ210LWFwaW1hbmFnZW1lbnQi%2Cs_Hpf0Ejp66XWWBZkM.png"
---

> Index of every page on this site: [llms.txt](https://pypx.app/llms.txt)

# **azure-mgmt-apimanagement**

v5.0.0

Microsoft Azure API Management Client Library for Python

1.1 MB Python 3.8+ py3-none-anyMIT License4 deps

[** Diff **](https://pypx.app/packages/azure-mgmt-apimanagement/diff)

`$ uv add azure-mgmt-apimanagement`

# 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](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

```
pip install azure-mgmt-apimanagement
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the 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:

```
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](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

## 5.0.0 (2025-04-21)

### Features Added

- Client `ApiManagementClient` added operation group `api_gateway`
- Client `ApiManagementClient` added operation group `api_management_gateway_skus`
- Client `ApiManagementClient` added operation group `all_policies`
- Client `ApiManagementClient` added operation group `api_gateway_config_connection`
- Client `ApiManagementClient` added operation group `policy_restriction`
- Client `ApiManagementClient` added operation group `policy_restriction_validations`
- Client `ApiManagementClient` added operation group `product_api_link`
- Client `ApiManagementClient` added operation group `product_group_link`
- Client `ApiManagementClient` added operation group `tag_api_link`
- Client `ApiManagementClient` added operation group `tag_operation_link`
- Client `ApiManagementClient` added operation group `tag_product_link`
- Client `ApiManagementClient` added operation group `workspace_backend`
- Client `ApiManagementClient` added operation group `workspace_certificate`
- Client `ApiManagementClient` added operation group `workspace_diagnostic`
- Client `ApiManagementClient` added operation group `workspace_api_diagnostic`
- Client `ApiManagementClient` added operation group `api_management_workspace_links`
- Client `ApiManagementClient` added operation group `api_management_workspace_link`
- Client `ApiManagementClient` added operation group `workspace_logger`
- Client `ApiManagementClient` added operation group `workspace`
- Client `ApiManagementClient` added operation group `workspace_policy`
- Client `ApiManagementClient` added operation group `workspace_named_value`
- Client `ApiManagementClient` added operation group `workspace_global_schema`
- Client `ApiManagementClient` added operation group `workspace_notification`
- Client `ApiManagementClient` added operation group `workspace_notification_recipient_user`
- Client `ApiManagementClient` added operation group `workspace_notification_recipient_email`
- Client `ApiManagementClient` added operation group `workspace_policy_fragment`
- Client `ApiManagementClient` added operation group `workspace_group`
- Client `ApiManagementClient` added operation group `workspace_group_user`
- Client `ApiManagementClient` added operation group `workspace_subscription`
- Client `ApiManagementClient` added operation group `workspace_api_version_set`
- Client `ApiManagementClient` added operation group `workspace_api`
- Client `ApiManagementClient` added operation group `workspace_api_revision`
- Client `ApiManagementClient` added operation group `workspace_api_release`
- Client `ApiManagementClient` added operation group `workspace_api_operation`
- Client `ApiManagementClient` added operation group `workspace_api_operation_policy`
- Client `ApiManagementClient` added operation group `workspace_api_policy`
- Client `ApiManagementClient` added operation group `workspace_api_schema`
- Client `ApiManagementClient` added operation group `workspace_product`
- Client `ApiManagementClient` added operation group `workspace_product_api_link`
- Client `ApiManagementClient` added operation group `workspace_product_group_link`
- Client `ApiManagementClient` added operation group `workspace_product_policy`
- Client `ApiManagementClient` added operation group `workspace_tag`
- Client `ApiManagementClient` added operation group `workspace_tag_api_link`
- Client `ApiManagementClient` added operation group `workspace_tag_operation_link`
- Client `ApiManagementClient` added operation group `workspace_tag_product_link`
- Client `ApiManagementClient` added operation group `workspace_api_export`
- Client `ApiManagementClient` added operation group `operation_status`
- Client `ApiManagementClient` added operation group `operations_results`
- Model `ApiContract` added property `provisioning_state`
- Model `ApiContractProperties` added property `provisioning_state`
- Model `ApiCreateOrUpdateParameter` added property `provisioning_state`
- Model `ApiCreateOrUpdateProperties` added property `provisioning_state`
- Model `ApiManagementServiceBaseProperties` added property `configuration_api`
- Model `ApiManagementServiceBaseProperties` added property `legacy_portal_status`
- Model `ApiManagementServiceBaseProperties` added property `developer_portal_status`
- Model `ApiManagementServiceProperties` added property `configuration_api`
- Model `ApiManagementServiceProperties` added property `legacy_portal_status`
- Model `ApiManagementServiceProperties` added property `developer_portal_status`
- Model `ApiManagementServiceResource` added property `configuration_api`
- Model `ApiManagementServiceResource` added property `legacy_portal_status`
- Model `ApiManagementServiceResource` added property `developer_portal_status`
- Model `ApiManagementServiceUpdateParameters` added property `configuration_api`
- Model `ApiManagementServiceUpdateParameters` added property `legacy_portal_status`
- Model `ApiManagementServiceUpdateParameters` added property `developer_portal_status`
- Model `ApiManagementServiceUpdateProperties` added property `configuration_api`
- Model `ApiManagementServiceUpdateProperties` added property `legacy_portal_status`
- Model `ApiManagementServiceUpdateProperties` added property `developer_portal_status`
- Enum `ApiType` added member `GRPC`
- Enum `ApiType` added member `ODATA`
- Model `AuthorizationAccessPolicyContract` added property `app_ids`
- Model `BackendBaseParameters` added property `circuit_breaker`
- Model `BackendBaseParameters` added property `pool`
- Model `BackendBaseParameters` added property `type`
- Model `BackendContract` added property `circuit_breaker`
- Model `BackendContract` added property `pool`
- Model `BackendContract` added property `type_properties_type`
- Model `BackendContractProperties` added property `circuit_breaker`
- Model `BackendContractProperties` added property `pool`
- Model `BackendContractProperties` added property `type`
- Model `BackendUpdateParameterProperties` added property `circuit_breaker`
- Model `BackendUpdateParameterProperties` added property `pool`
- Model `BackendUpdateParameterProperties` added property `type`
- Model `BackendUpdateParameters` added property `circuit_breaker`
- Model `BackendUpdateParameters` added property `pool`
- Model `BackendUpdateParameters` added property `type`
- Enum `ContentFormat` added member `GRPC`
- Enum `ContentFormat` added member `GRPC_LINK`
- Enum `ContentFormat` added member `ODATA`
- Enum `ContentFormat` added member `ODATA_LINK`
- Model `ErrorResponse` added property `error`
- Model `GlobalSchemaContract` added property `provisioning_state`
- Enum `HostnameType` added member `CONFIGURATION_API`
- Model `NamedValueContract` added property `provisioning_state`
- Model `NamedValueContractProperties` added property `provisioning_state`
- Enum `PlatformVersion` added member `STV2_1`
- Model `PolicyFragmentContract` added property `provisioning_state`
- Model `PortalRevisionContract` added property `provisioning_state`
- Model `SchemaContract` added property `provisioning_state`
- Enum `SkuType` added member `BASIC_V2`
- Enum `SkuType` added member `STANDARD_V2`
- Enum `SoapApiType` added member `G_RPC`
- Enum `SoapApiType` added member `O_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 `ApiManagementGatewaySkuPropertiesForPatch`
- Added model `ApiManagementGatewayUpdateParameters`
- Added model `ApiManagementGatewayUpdateProperties`
- Added model `ApiManagementWorkspaceLinksListResult`
- Added model `ApiManagementWorkspaceLinksProperties`
- Added model `ApiManagementWorkspaceLinksResource`
- Added model `BackendBaseParametersPool`
- Added model `BackendCircuitBreaker`
- Added model `BackendConfiguration`
- Added model `BackendPool`
- Added model `BackendPoolItem`
- Added model `BackendSubnetConfiguration`
- Added enum `BackendType`
- Added model `CircuitBreakerFailureCondition`
- Added model `CircuitBreakerRule`
- Added model `ConfigurationApi`
- Added enum `DeveloperPortalStatus`
- Added model `DiagnosticUpdateContract`
- Added model `ErrorAdditionalInfo`
- Added model `ErrorDetail`
- Added model `FailureStatusCodeRange`
- Added model `FrontendConfiguration`
- Added model `GatewayConfigurationApi`
- Added model `GatewayDebugCredentialsContract`
- Added model `GatewayListDebugCredentialsContract`
- Added enum `GatewayListDebugCredentialsContractPurpose`
- Added model `GatewayListTraceContract`
- Added model `GatewayResourceSkuResult`
- Added model `GatewayResourceSkuResults`
- Added model `GatewaySku`
- Added model `GatewaySkuCapacity`
- Added enum `GatewaySkuCapacityScaleType`
- Added enum `KeyVaultRefreshState`
- Added enum `LegacyApiState`
- Added enum `LegacyPortalStatus`
- Added model `MigrateToStv2Contract`
- Added enum `MigrateToStv2Mode`
- Added model `OperationStatusResult`
- Added enum `PolicyComplianceState`
- Added model `PolicyRestrictionCollection`
- Added model `PolicyRestrictionContract`
- Added enum `PolicyRestrictionRequireBase`
- Added model `PolicyRestrictionUpdateContract`
- Added model `PolicyWithComplianceCollection`
- Added model `PolicyWithComplianceContract`
- Added model `ProductApiLinkCollection`
- Added model `ProductApiLinkContract`
- Added model `ProductGroupLinkCollection`
- Added model `ProductGroupLinkContract`
- Added model `TagApiLinkCollection`
- Added model `TagApiLinkContract`
- Added model `TagOperationLinkCollection`
- Added model `TagOperationLinkContract`
- Added model `TagProductLinkCollection`
- Added model `TagProductLinkContract`
- Added model `WorkspaceCollection`
- Added model `WorkspaceContract`
- Added model `WorkspaceLinksBaseProperties`
- Added model `WorkspaceLinksGateway`
- Model `ApiOperations` added method `begin_delete`
- Model `GatewayOperations` added method `invalidate_debug_credentials`
- Model `GatewayOperations` added method `list_debug_credentials`
- Model `GatewayOperations` added method `list_trace`
- Model `UserOperations` added method `begin_delete`
- Added model `AllPoliciesOperations`
- Added model `ApiGatewayConfigConnectionOperations`
- Added model `ApiGatewayOperations`
- Added model `ApiManagementGatewaySkusOperations`
- Added model `ApiManagementWorkspaceLinkOperations`
- Added model `ApiManagementWorkspaceLinksOperations`
- Added model `OperationStatusOperations`
- Added model `OperationsResultsOperations`
- Added model `PolicyRestrictionOperations`
- Added model `PolicyRestrictionValidationsOperations`
- Added model `ProductApiLinkOperations`
- Added model `ProductGroupLinkOperations`
- Added model `TagApiLinkOperations`
- Added model `TagOperationLinkOperations`
- Added model `TagProductLinkOperations`
- Added model `WorkspaceApiDiagnosticOperations`
- Added model `WorkspaceApiExportOperations`
- Added model `WorkspaceApiOperationOperations`
- Added model `WorkspaceApiOperationPolicyOperations`
- Added model `WorkspaceApiOperations`
- Added model `WorkspaceApiPolicyOperations`
- Added model `WorkspaceApiReleaseOperations`
- Added model `WorkspaceApiRevisionOperations`
- Added model `WorkspaceApiSchemaOperations`
- Added model `WorkspaceApiVersionSetOperations`
- Added model `WorkspaceBackendOperations`
- Added model `WorkspaceCertificateOperations`
- Added model `WorkspaceDiagnosticOperations`
- Added model `WorkspaceGlobalSchemaOperations`
- Added model `WorkspaceGroupOperations`
- Added model `WorkspaceGroupUserOperations`
- Added model `WorkspaceLoggerOperations`
- Added model `WorkspaceNamedValueOperations`
- Added model `WorkspaceNotificationOperations`
- Added model `WorkspaceNotificationRecipientEmailOperations`
- Added model `WorkspaceNotificationRecipientUserOperations`
- Added model `WorkspaceOperations`
- Added model `WorkspacePolicyFragmentOperations`
- Added model `WorkspacePolicyOperations`
- Added model `WorkspaceProductApiLinkOperations`
- Added model `WorkspaceProductGroupLinkOperations`
- Added model `WorkspaceProductOperations`
- Added model `WorkspaceProductPolicyOperations`
- Added model `WorkspaceSubscriptionOperations`
- Added model `WorkspaceTagApiLinkOperations`
- Added model `WorkspaceTagOperationLinkOperations`
- Added model `WorkspaceTagOperations`
- Added model `WorkspaceTagProductLinkOperations`

### Breaking Changes

- Parameter `virtual_network_type` of model `ApiManagementServiceBaseProperties` is now optional
- Parameter `virtual_network_type` of model `ApiManagementServiceProperties` is now optional
- Parameter `virtual_network_type` of model `ApiManagementServiceResource` is now optional
- Parameter `virtual_network_type` of model `ApiManagementServiceUpdateParameters` is now optional
- Parameter `virtual_network_type` of model `ApiManagementServiceUpdateProperties` is now optional
- Model `ErrorResponse` deleted or renamed its instance variable `code`
- Model `ErrorResponse` deleted or renamed its instance variable `message`
- Model `ErrorResponse` deleted or renamed its instance variable `details`
- Deleted or renamed method `ApiOperations.delete`
- Deleted or renamed method `UserOperations.delete`

## 4.0.1 (2024-03-19)

### Other Changes

- Regenerate samples

## 4.0.0 (2023-04-20)

### Features Added

- Added operation ApiManagementServiceOperations.begin\_migrate\_to\_stv2
- Added operation group ApiWikiOperations
- Added operation group ApiWikisOperations
- Added operation group AuthorizationAccessPolicyOperations
- Added operation group AuthorizationLoginLinksOperations
- Added operation group AuthorizationOperations
- Added operation group AuthorizationProviderOperations
- Added operation group DocumentationOperations
- Added operation group GraphQLApiResolverOperations
- Added operation group GraphQLApiResolverPolicyOperations
- Added operation group PolicyFragmentOperations
- Added operation group PortalConfigOperations
- Added operation group ProductWikiOperations
- Added operation group ProductWikisOperations
- Model AdditionalLocation has a new parameter nat\_gateway\_state
- Model AdditionalLocation has a new parameter outbound\_public\_ip\_addresses
- Model ApiCreateOrUpdateParameter has a new parameter translate\_required\_query\_parameters\_conduct
- Model ApiCreateOrUpdateProperties has a new parameter translate\_required\_query\_parameters\_conduct
- Model ApiManagementServiceBaseProperties has a new parameter nat\_gateway\_state
- Model ApiManagementServiceBaseProperties has a new parameter outbound\_public\_ip\_addresses
- Model ApiManagementServiceProperties has a new parameter nat\_gateway\_state
- Model ApiManagementServiceProperties has a new parameter outbound\_public\_ip\_addresses
- Model ApiManagementServiceResource has a new parameter nat\_gateway\_state
- Model ApiManagementServiceResource has a new parameter outbound\_public\_ip\_addresses
- Model ApiManagementServiceUpdateParameters has a new parameter nat\_gateway\_state
- Model ApiManagementServiceUpdateParameters has a new parameter outbound\_public\_ip\_addresses
- Model ApiManagementServiceUpdateProperties has a new parameter nat\_gateway\_state
- Model ApiManagementServiceUpdateProperties has a new parameter outbound\_public\_ip\_addresses
- Model AuthenticationSettingsContract has a new parameter o\_auth2\_authentication\_settings
- Model AuthenticationSettingsContract has a new parameter openid\_authentication\_settings
- Model AuthorizationServerContract has a new parameter use\_in\_api\_documentation
- Model AuthorizationServerContract has a new parameter use\_in\_test\_console
- Model AuthorizationServerContractProperties has a new parameter use\_in\_api\_documentation
- Model AuthorizationServerContractProperties has a new parameter use\_in\_test\_console
- Model AuthorizationServerUpdateContract has a new parameter use\_in\_api\_documentation
- Model AuthorizationServerUpdateContract has a new parameter use\_in\_test\_console
- Model AuthorizationServerUpdateContractProperties has a new parameter use\_in\_api\_documentation
- Model AuthorizationServerUpdateContractProperties has a new parameter use\_in\_test\_console
- Model DiagnosticContract has a new parameter metrics
- Model IdentityProviderBaseParameters has a new parameter client\_library
- Model IdentityProviderContract has a new parameter client\_library
- Model IdentityProviderContractProperties has a new parameter client\_library
- Model IdentityProviderCreateContract has a new parameter client\_library
- Model IdentityProviderCreateContractProperties has a new parameter client\_library
- Model IdentityProviderUpdateParameters has a new parameter client\_library
- Model IdentityProviderUpdateProperties has a new parameter client\_library
- Model OpenidConnectProviderContract has a new parameter use\_in\_api\_documentation
- Model OpenidConnectProviderContract has a new parameter use\_in\_test\_console
- Model OpenidConnectProviderUpdateContract has a new parameter use\_in\_api\_documentation
- Model OpenidConnectProviderUpdateContract has a new parameter use\_in\_test\_console

### Breaking Changes

- Operation ContentItemOperations.create\_or\_update has a new required parameter parameters
- Operation ContentTypeOperations.create\_or\_update has a new required parameter parameters

## 3.1.0b1 (2022-11-11)

### Features Added

- Model DiagnosticContract has a new parameter metrics

## 3.0.0 (2022-01-13)

**Features**

- Added operation group ApiManagementClientOperationsMixin
- Added operation group GlobalSchemaOperations
- Added operation group OutboundNetworkDependenciesEndpointsOperations
- Added operation group PrivateEndpointConnectionOperations
- Model AdditionalLocation has a new parameter platform\_version
- Model AdditionalLocation has a new parameter public\_ip\_address\_id
- Model ApiContract has a new parameter contact
- Model ApiContract has a new parameter license
- Model ApiContract has a new parameter terms\_of\_service\_url
- Model ApiContractProperties has a new parameter contact
- Model ApiContractProperties has a new parameter license
- Model ApiContractProperties has a new parameter terms\_of\_service\_url
- Model ApiContractUpdateProperties has a new parameter contact
- Model ApiContractUpdateProperties has a new parameter license
- Model ApiContractUpdateProperties has a new parameter terms\_of\_service\_url
- Model ApiCreateOrUpdateParameter has a new parameter contact
- Model ApiCreateOrUpdateParameter has a new parameter license
- Model ApiCreateOrUpdateParameter has a new parameter terms\_of\_service\_url
- Model ApiCreateOrUpdateProperties has a new parameter contact
- Model ApiCreateOrUpdateProperties has a new parameter license
- Model ApiCreateOrUpdateProperties has a new parameter terms\_of\_service\_url
- Model ApiEntityBaseContract has a new parameter contact
- Model ApiEntityBaseContract has a new parameter license
- Model ApiEntityBaseContract has a new parameter terms\_of\_service\_url
- Model ApiManagementServiceBackupRestoreParameters has a new parameter access\_type
- Model ApiManagementServiceBackupRestoreParameters has a new parameter client\_id
- Model ApiManagementServiceBaseProperties has a new parameter platform\_version
- Model ApiManagementServiceBaseProperties has a new parameter private\_endpoint\_connections
- Model ApiManagementServiceBaseProperties has a new parameter public\_ip\_address\_id
- Model ApiManagementServiceBaseProperties has a new parameter public\_network\_access
- Model ApiManagementServiceProperties has a new parameter platform\_version
- Model ApiManagementServiceProperties has a new parameter private\_endpoint\_connections
- Model ApiManagementServiceProperties has a new parameter public\_ip\_address\_id
- Model ApiManagementServiceProperties has a new parameter public\_network\_access
- Model ApiManagementServiceResource has a new parameter platform\_version
- Model ApiManagementServiceResource has a new parameter private\_endpoint\_connections
- Model ApiManagementServiceResource has a new parameter public\_ip\_address\_id
- Model ApiManagementServiceResource has a new parameter public\_network\_access
- Model ApiManagementServiceResource has a new parameter system\_data
- Model ApiManagementServiceUpdateParameters has a new parameter platform\_version
- Model ApiManagementServiceUpdateParameters has a new parameter private\_endpoint\_connections
- Model ApiManagementServiceUpdateParameters has a new parameter public\_ip\_address\_id
- Model ApiManagementServiceUpdateParameters has a new parameter public\_network\_access
- Model ApiManagementServiceUpdateParameters has a new parameter zones
- Model ApiManagementServiceUpdateProperties has a new parameter platform\_version
- Model ApiManagementServiceUpdateProperties has a new parameter private\_endpoint\_connections
- Model ApiManagementServiceUpdateProperties has a new parameter public\_ip\_address\_id
- Model ApiManagementServiceUpdateProperties has a new parameter public\_network\_access
- Model ApiTagResourceContractProperties has a new parameter contact
- Model ApiTagResourceContractProperties has a new parameter license
- Model ApiTagResourceContractProperties has a new parameter terms\_of\_service\_url
- Model ApiUpdateContract has a new parameter contact
- Model ApiUpdateContract has a new parameter license
- Model ApiUpdateContract has a new parameter terms\_of\_service\_url
- Model HostnameConfiguration has a new parameter certificate\_source
- Model HostnameConfiguration has a new parameter certificate\_status
- Model ParameterContract has a new parameter examples
- Model ParameterContract has a new parameter schema\_id
- Model ParameterContract has a new parameter type\_name
- Model RepresentationContract has a new parameter examples
- Model SchemaContract has a new parameter components
- Model TenantConfigurationSyncStateContract has a new parameter id
- Model TenantConfigurationSyncStateContract has a new parameter name
- Model TenantConfigurationSyncStateContract has a new parameter type

**Breaking changes**

- Model RepresentationContract no longer has parameter sample

## 2.1.0 (2021-08-03)

**Features**

- Model OperationResultContract has a new parameter id\_properties\_id
- Model OperationResultContract has a new parameter name
- Model OperationResultContract has a new parameter type
- Model TenantConfigurationSyncStateContract has a new parameter last\_operation\_id

## 2.0.0 (2021-03-25)

**Features**

- Model TagCollection has a new parameter count
- Model OpenIdConnectProviderCollection has a new parameter count
- Model TagResourceCollection has a new parameter count
- Model CertificateCollection has a new parameter count
- Model PolicyCollection has a new parameter count
- Model IssueAttachmentCollection has a new parameter count
- Model BackendServiceFabricClusterProperties has a new parameter client\_certificate\_id
- Model BackendCollection has a new parameter count
- Model SubscriptionCollection has a new parameter count
- Model RecipientEmailCollection has a new parameter count
- Model GatewayCollection has a new parameter count
- Model IssueCommentCollection has a new parameter count
- Model OperationCollection has a new parameter count
- Model DiagnosticCollection has a new parameter count
- Model ApiVersionSetCollection has a new parameter count
- Model ProductCollection has a new parameter count
- Model IssueCollection has a new parameter count
- Model NotificationCollection has a new parameter count
- Model UserCollection has a new parameter count
- Model IdentityProviderList has a new parameter count
- Model ApiReleaseCollection has a new parameter count
- Model TagDescriptionCollection has a new parameter count
- Model ApiRevisionCollection has a new parameter count
- Model CacheCollection has a new parameter count
- Model RecipientUserCollection has a new parameter count
- Model NamedValueCollection has a new parameter count
- Model EmailTemplateCollection has a new parameter count
- Model BackendCredentialsContract has a new parameter certificate\_ids
- Model ApiCollection has a new parameter count
- Model GroupCollection has a new parameter count
- Model SchemaCollection has a new parameter count
- Added operation TenantAccessOperations.list\_by\_service
- Added operation TenantAccessOperations.create
- Added operation ApiManagementServiceOperations.get\_domain\_ownership\_identifier
- Added operation NamedValueOperations.begin\_refresh\_secret
- Added operation CertificateOperations.refresh\_secret
- Added operation DeletedServicesOperations.begin\_purge
- Added operation UserSubscriptionOperations.get
- Added operation group PortalSettingsOperations
- Added operation group TenantSettingsOperations
- Added operation group GatewayCertificateAuthorityOperations
- Added operation group ApiManagementSkusOperations

**Breaking changes**

- Operation CertificateOperations.list\_by\_service has a new signature
- Operation NamedValueOperations.list\_by\_service has a new signature
- Removed operation DeletedServicesOperations.purge
- Removed operation TenantAccessGitOperations.list\_secrets
- Removed operation TenantAccessGitOperations.get
- Model AccessInformationContract has a new signature

## 1.0.0 (2020-12-21)

**Features**

- Added operation group ContentItemOperations
- Added operation group PortalRevisionOperations

**Breaking changes**

- Operation SignUpSettingsOperations.update has a new signature
- Operation TenantAccessOperations.update has a new signature
- Operation UserOperations.get\_shared\_access\_token has a new signature
- Operation SignInSettingsOperations.update has a new signature
- Operation QuotaByPeriodKeysOperations.update has a new signature
- Operation TenantConfigurationOperations.begin\_save has a new signature
- Operation TenantConfigurationOperations.begin\_validate has a new signature
- Operation TenantConfigurationOperations.begin\_deploy has a new signature
- Operation BackendOperations.reconnect has a new signature
- Operation QuotaByCounterKeysOperations.update has a new signature
- Operation ApiReleaseOperations.update has a new signature
- Operation TagOperations.update has a new signature
- Operation ApiManagementServiceOperations.check\_name\_availability has a new signature
- Operation ApiManagementServiceOperations.begin\_apply\_network\_configuration\_updates has a new signature
- Operation GatewayOperations.update has a new signature
- Operation GatewayOperations.generate\_token has a new signature
- Operation GatewayOperations.regenerate\_key has a new signature
- Operation UserOperations.get\_shared\_access\_token has a new signature
- Operation TenantConfigurationOperations.begin\_validate has a new signature
- Operation TenantConfigurationOperations.begin\_save has a new signature
- Operation TenantConfigurationOperations.begin\_deploy has a new signature
- Operation TagOperations.create\_or\_update has a new signature
- Operation SignUpSettingsOperations.update has a new signature
- Operation QuotaByPeriodKeysOperations.update has a new signature
- Operation QuotaByCounterKeysOperations.update has a new signature
- Operation GatewayOperations.update has a new signature
- Operation GatewayOperations.generate\_token has a new signature
- Operation ApiReleaseOperations.update has a new signature
- Operation GatewayApiOperations.create\_or\_update has a new signature
- Operation TagOperations.create\_or\_update has a new signature
- Operation SignUpSettingsOperations.create\_or\_update has a new signature
- Operation SignInSettingsOperations.create\_or\_update has a new signature
- Operation ApiOperationPolicyOperations.create\_or\_update has a new signature
- Operation PolicyOperations.create\_or\_update has a new signature
- Operation ApiPolicyOperations.create\_or\_update has a new signature
- Operation ApiReleaseOperations.create\_or\_update has a new signature
- Operation GatewayOperations.create\_or\_update has a new signature
- Operation ProductPolicyOperations.create\_or\_update has a new signature
- Removed operation group ContentTypeContentItemOperations

## 1.0.0b1 (2020-10-31)

This is beta preview version. For detailed changelog please refer to equivalent stable version 0.2.0(https://pypi.org/project/azure-mgmt-apimanagement/0.2.0/)

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.

## 0.2.0 (2020-03-25)

**Features**

- Model IdentityProviderUpdateParameters has a new parameter signin\_tenant
- Model ApiManagementServiceIdentity has a new parameter user\_assigned\_identities
- Model AdditionalLocation has a new parameter disable\_gateway
- Model UserCreateParameters has a new parameter app\_type
- Model ApiManagementServiceResource has a new parameter disable\_gateway
- Model ApiManagementServiceResource has a new parameter developer\_portal\_url
- Model ApiManagementServiceResource has a new parameter api\_version\_constraint
- Model DiagnosticContract has a new parameter log\_client\_ip
- Model DiagnosticContract has a new parameter verbosity
- Model DiagnosticContract has a new parameter http\_correlation\_protocol
- Model SchemaContract has a new parameter value
- Model SchemaContract has a new parameter definitions
- Model ApiManagementServiceUpdateParameters has a new parameter disable\_gateway
- Model ApiManagementServiceUpdateParameters has a new parameter developer\_portal\_url
- Model ApiManagementServiceUpdateParameters has a new parameter api\_version\_constraint
- Model TagDescriptionContract has a new parameter tag\_id
- Model ApiManagementServiceBaseProperties has a new parameter disable\_gateway
- Model ApiManagementServiceBaseProperties has a new parameter developer\_portal\_url
- Model ApiManagementServiceBaseProperties has a new parameter api\_version\_constraint
- Model IdentityProviderBaseParameters has a new parameter signin\_tenant
- Model IdentityProviderContract has a new parameter signin\_tenant
- Added operation TenantAccessGitOperations.list\_secrets
- Added operation DelegationSettingsOperations.list\_secrets
- Added operation AuthorizationServerOperations.list\_secrets
- Added operation TenantAccessOperations.list\_secrets
- Added operation SubscriptionOperations.list\_secrets
- Added operation IdentityProviderOperations.list\_secrets
- Added operation OpenIdConnectProviderOperations.list\_secrets
- Added operation group GatewayApiOperations
- Added operation group PolicyDescriptionOperations
- Added operation group GatewayHostnameConfigurationOperations
- Added operation group NamedValueOperations
- Added operation group GatewayOperations

**General breaking changes**

This version uses a next-generation code generator that *might* introduce breaking changes if from some import. In summary, some modules were incorrectly visible/importable and have been renamed. This fixed several issues caused by usage of classes that were not supposed to be used in the first place.

- ApiManagementClient cannot be imported from `azure.mgmt.apimanagement.api_management_client` anymore (import from `azure.mgmt.apimanagement` works like before)
- ApiManagementClientConfiguration import has been moved from `azure.mgmt.apimanagement.api_management_client` to `azure.mgmt.apimanagement`
- A model `MyClass` from a "models" sub-module cannot be imported anymore using `azure.mgmt.apimanagement.models.my_class` (import from `azure.mgmt.apimanagement.models` works like before)
- An operation class `MyClassOperations` from an `operations` sub-module cannot be imported anymore using `azure.mgmt.apimanagement.operations.my_class_operations` (import from `azure.mgmt.apimanagement.operations` works like before)

Last but not least, HTTP connection pooling is now enabled by default. You should always use a client as a context manager, or call close(), or use no more than one client per process.

## 0.1.0 (2019-05-01)

- Initial Release

## **Details **

<dl>

<dt>Version</dt>
<dd>5.0.0</dd>

<dt>License</dt>
<dd>MIT License</dd>

<dt>Python</dt>
<dd>&gt;=3.8</dd>

<dt>Maintainer</dt>
<dd>Microsoft Corporation</dd></dl>

## **Links**

- [Homepage](https://github.com/Azure/azure-sdk-for-python)
- [View on PyPI](https://pypi.org/project/azure-mgmt-apimanagement/)

## **Release Cadence **

**1**

releases in the past year

avg 210 days between releases

## **Maintainers **

- Microsoft Corporation · [azpysdkhelp@microsoft.com](mailto:azpysdkhelp@microsoft.com)

```json
{"@context":"https://schema.org","@graph":[{"@id":"https://pypx.app/#website","@type":"WebSite","description":"The Python Package Index, reimagined. Fast search, dependency insights, download trends, and changelogs — all in one place.","name":"pypx","url":"https://pypx.app/"},{"@id":"https://pypx.app/packages/azure-mgmt-apimanagement#webpage","@type":"WebPage","description":"Microsoft Azure API Management Client Library for Python","name":"azure-mgmt-apimanagement","url":"https://pypx.app/packages/azure-mgmt-apimanagement","isPartOf":{"@id":"https://pypx.app/#website"},"potentialAction":[{"@type":"ReadAction","target":["https://pypx.app/packages/azure-mgmt-apimanagement"]}]},{"@id":"https://pypx.app/packages/azure-mgmt-apimanagement#/schema/software-application/1","@type":"SoftwareApplication","applicationCategory":"DeveloperApplication","description":"Microsoft Azure API Management Client Library for Python","license":"MIT License","name":"azure-mgmt-apimanagement","softwareVersion":"5.0.0"}]}
```

## Sitemap

See the full [sitemap](https://pypx.app/sitemap.md) for all pages.
