Package: azure-mgmt-apimanagement
Microsoft Azure SDK for PythonThis is the Microsoft Azure API Management Client Library.
This package has been tested with Python 3.7+.
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.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-apimanagement
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.apimanagementimportApiManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=ApiManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search API 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 History4.0.0 (2023-04-20)Features AddedAdded operation ApiManagementServiceOperations.begin_migrate_to_stv2Added operation group ApiWikiOperationsAdded operation group ApiWikisOperationsAdded operation group AuthorizationAccessPolicyOperationsAdded operation group AuthorizationLoginLinksOperationsAdded operation group AuthorizationOperationsAdded operation group AuthorizationProviderOperationsAdded operation group DocumentationOperationsAdded operation group GraphQLApiResolverOperationsAdded operation group GraphQLApiResolverPolicyOperationsAdded operation group PolicyFragmentOperationsAdded operation group PortalConfigOperationsAdded operation group ProductWikiOperationsAdded operation group ProductWikisOperationsModel AdditionalLocation has a new parameter nat_gateway_stateModel AdditionalLocation has a new parameter outbound_public_ip_addressesModel ApiCreateOrUpdateParameter has a new parameter translate_required_query_parameters_conductModel ApiCreateOrUpdateProperties has a new parameter translate_required_query_parameters_conductModel ApiManagementServiceBaseProperties has a new parameter nat_gateway_stateModel ApiManagementServiceBaseProperties has a new parameter outbound_public_ip_addressesModel ApiManagementServiceProperties has a new parameter nat_gateway_stateModel ApiManagementServiceProperties has a new parameter outbound_public_ip_addressesModel ApiManagementServiceResource has a new parameter nat_gateway_stateModel ApiManagementServiceResource has a new parameter outbound_public_ip_addressesModel ApiManagementServiceUpdateParameters has a new parameter nat_gateway_stateModel ApiManagementServiceUpdateParameters has a new parameter outbound_public_ip_addressesModel ApiManagementServiceUpdateProperties has a new parameter nat_gateway_stateModel ApiManagementServiceUpdateProperties has a new parameter outbound_public_ip_addressesModel AuthenticationSettingsContract has a new parameter o_auth2_authentication_settingsModel AuthenticationSettingsContract has a new parameter openid_authentication_settingsModel AuthorizationServerContract has a new parameter use_in_api_documentationModel AuthorizationServerContract has a new parameter use_in_test_consoleModel AuthorizationServerContractProperties has a new parameter use_in_api_documentationModel AuthorizationServerContractProperties has a new parameter use_in_test_consoleModel AuthorizationServerUpdateContract has a new parameter use_in_api_documentationModel AuthorizationServerUpdateContract has a new parameter use_in_test_consoleModel AuthorizationServerUpdateContractProperties has a new parameter use_in_api_documentationModel AuthorizationServerUpdateContractProperties has a new parameter use_in_test_consoleModel DiagnosticContract has a new parameter metricsModel IdentityProviderBaseParameters has a new parameter client_libraryModel IdentityProviderContract has a new parameter client_libraryModel IdentityProviderContractProperties has a new parameter client_libraryModel IdentityProviderCreateContract has a new parameter client_libraryModel IdentityProviderCreateContractProperties has a new parameter client_libraryModel IdentityProviderUpdateParameters has a new parameter client_libraryModel IdentityProviderUpdateProperties has a new parameter client_libraryModel OpenidConnectProviderContract has a new parameter use_in_api_documentationModel OpenidConnectProviderContract has a new parameter use_in_test_consoleModel OpenidConnectProviderUpdateContract has a new parameter use_in_api_documentationModel OpenidConnectProviderUpdateContract has a new parameter use_in_test_consoleBreaking ChangesOperation ContentItemOperations.create_or_update has a new required parameter parametersOperation ContentTypeOperations.create_or_update has a new required parameter parameters3.1.0b1 (2022-11-11)Features AddedModel DiagnosticContract has a new parameter metrics3.0.0 (2022-01-13)FeaturesAdded operation group ApiManagementClientOperationsMixinAdded operation group GlobalSchemaOperationsAdded operation group OutboundNetworkDependenciesEndpointsOperationsAdded operation group PrivateEndpointConnectionOperationsModel AdditionalLocation has a new parameter platform_versionModel AdditionalLocation has a new parameter public_ip_address_idModel ApiContract has a new parameter contactModel ApiContract has a new parameter licenseModel ApiContract has a new parameter terms_of_service_urlModel ApiContractProperties has a new parameter contactModel ApiContractProperties has a new parameter licenseModel ApiContractProperties has a new parameter terms_of_service_urlModel ApiContractUpdateProperties has a new parameter contactModel ApiContractUpdateProperties has a new parameter licenseModel ApiContractUpdateProperties has a new parameter terms_of_service_urlModel ApiCreateOrUpdateParameter has a new parameter contactModel ApiCreateOrUpdateParameter has a new parameter licenseModel ApiCreateOrUpdateParameter has a new parameter terms_of_service_urlModel ApiCreateOrUpdateProperties has a new parameter contactModel ApiCreateOrUpdateProperties has a new parameter licenseModel ApiCreateOrUpdateProperties has a new parameter terms_of_service_urlModel ApiEntityBaseContract has a new parameter contactModel ApiEntityBaseContract has a new parameter licenseModel ApiEntityBaseContract has a new parameter terms_of_service_urlModel ApiManagementServiceBackupRestoreParameters has a new parameter access_typeModel ApiManagementServiceBackupRestoreParameters has a new parameter client_idModel ApiManagementServiceBaseProperties has a new parameter platform_versionModel ApiManagementServiceBaseProperties has a new parameter private_endpoint_connectionsModel ApiManagementServiceBaseProperties has a new parameter public_ip_address_idModel ApiManagementServiceBaseProperties has a new parameter public_network_accessModel ApiManagementServiceProperties has a new parameter platform_versionModel ApiManagementServiceProperties has a new parameter private_endpoint_connectionsModel ApiManagementServiceProperties has a new parameter public_ip_address_idModel ApiManagementServiceProperties has a new parameter public_network_accessModel ApiManagementServiceResource has a new parameter platform_versionModel ApiManagementServiceResource has a new parameter private_endpoint_connectionsModel ApiManagementServiceResource has a new parameter public_ip_address_idModel ApiManagementServiceResource has a new parameter public_network_accessModel ApiManagementServiceResource has a new parameter system_dataModel ApiManagementServiceUpdateParameters has a new parameter platform_versionModel ApiManagementServiceUpdateParameters has a new parameter private_endpoint_connectionsModel ApiManagementServiceUpdateParameters has a new parameter public_ip_address_idModel ApiManagementServiceUpdateParameters has a new parameter public_network_accessModel ApiManagementServiceUpdateParameters has a new parameter zonesModel ApiManagementServiceUpdateProperties has a new parameter platform_versionModel ApiManagementServiceUpdateProperties has a new parameter private_endpoint_connectionsModel ApiManagementServiceUpdateProperties has a new parameter public_ip_address_idModel ApiManagementServiceUpdateProperties has a new parameter public_network_accessModel ApiTagResourceContractProperties has a new parameter contactModel ApiTagResourceContractProperties has a new parameter licenseModel ApiTagResourceContractProperties has a new parameter terms_of_service_urlModel ApiUpdateContract has a new parameter contactModel ApiUpdateContract has a new parameter licenseModel ApiUpdateContract has a new parameter terms_of_service_urlModel HostnameConfiguration has a new parameter certificate_sourceModel HostnameConfiguration has a new parameter certificate_statusModel ParameterContract has a new parameter examplesModel ParameterContract has a new parameter schema_idModel ParameterContract has a new parameter type_nameModel RepresentationContract has a new parameter examplesModel SchemaContract has a new parameter componentsModel TenantConfigurationSyncStateContract has a new parameter idModel TenantConfigurationSyncStateContract has a new parameter nameModel TenantConfigurationSyncStateContract has a new parameter typeBreaking changesModel RepresentationContract no longer has parameter sample2.1.0 (2021-08-03)FeaturesModel OperationResultContract has a new parameter id_properties_idModel OperationResultContract has a new parameter nameModel OperationResultContract has a new parameter typeModel TenantConfigurationSyncStateContract has a new parameter last_operation_id2.0.0 (2021-03-25)FeaturesModel TagCollection has a new parameter countModel OpenIdConnectProviderCollection has a new parameter countModel TagResourceCollection has a new parameter countModel CertificateCollection has a new parameter countModel PolicyCollection has a new parameter countModel IssueAttachmentCollection has a new parameter countModel BackendServiceFabricClusterProperties has a new parameter client_certificate_idModel BackendCollection has a new parameter countModel SubscriptionCollection has a new parameter countModel RecipientEmailCollection has a new parameter countModel GatewayCollection has a new parameter countModel IssueCommentCollection has a new parameter countModel OperationCollection has a new parameter countModel DiagnosticCollection has a new parameter countModel ApiVersionSetCollection has a new parameter countModel ProductCollection has a new parameter countModel IssueCollection has a new parameter countModel NotificationCollection has a new parameter countModel UserCollection has a new parameter countModel IdentityProviderList has a new parameter countModel ApiReleaseCollection has a new parameter countModel TagDescriptionCollection has a new parameter countModel ApiRevisionCollection has a new parameter countModel CacheCollection has a new parameter countModel RecipientUserCollection has a new parameter countModel NamedValueCollection has a new parameter countModel EmailTemplateCollection has a new parameter countModel BackendCredentialsContract has a new parameter certificate_idsModel ApiCollection has a new parameter countModel GroupCollection has a new parameter countModel SchemaCollection has a new parameter countAdded operation TenantAccessOperations.list_by_serviceAdded operation TenantAccessOperations.createAdded operation ApiManagementServiceOperations.get_domain_ownership_identifierAdded operation NamedValueOperations.begin_refresh_secretAdded operation CertificateOperations.refresh_secretAdded operation DeletedServicesOperations.begin_purgeAdded operation UserSubscriptionOperations.getAdded operation group PortalSettingsOperationsAdded operation group TenantSettingsOperationsAdded operation group GatewayCertificateAuthorityOperationsAdded operation group ApiManagementSkusOperationsBreaking changesOperation CertificateOperations.list_by_service has a new signatureOperation NamedValueOperations.list_by_service has a new signatureRemoved operation DeletedServicesOperations.purgeRemoved operation TenantAccessGitOperations.list_secretsRemoved operation TenantAccessGitOperations.getModel AccessInformationContract has a new signature1.0.0 (2020-12-21)FeaturesAdded operation group ContentItemOperationsAdded operation group PortalRevisionOperationsBreaking changesOperation SignUpSettingsOperations.update has a new signatureOperation TenantAccessOperations.update has a new signatureOperation UserOperations.get_shared_access_token has a new signatureOperation SignInSettingsOperations.update has a new signatureOperation QuotaByPeriodKeysOperations.update has a new signatureOperation TenantConfigurationOperations.begin_save has a new signatureOperation TenantConfigurationOperations.begin_validate has a new signatureOperation TenantConfigurationOperations.begin_deploy has a new signatureOperation BackendOperations.reconnect has a new signatureOperation QuotaByCounterKeysOperations.update has a new signatureOperation ApiReleaseOperations.update has a new signatureOperation TagOperations.update has a new signatureOperation ApiManagementServiceOperations.check_name_availability has a new signatureOperation ApiManagementServiceOperations.begin_apply_network_configuration_updates has a new signatureOperation GatewayOperations.update has a new signatureOperation GatewayOperations.generate_token has a new signatureOperation GatewayOperations.regenerate_key has a new signatureOperation UserOperations.get_shared_access_token has a new signatureOperation TenantConfigurationOperations.begin_validate has a new signatureOperation TenantConfigurationOperations.begin_save has a new signatureOperation TenantConfigurationOperations.begin_deploy has a new signatureOperation TagOperations.create_or_update has a new signatureOperation SignUpSettingsOperations.update has a new signatureOperation QuotaByPeriodKeysOperations.update has a new signatureOperation QuotaByCounterKeysOperations.update has a new signatureOperation GatewayOperations.update has a new signatureOperation GatewayOperations.generate_token has a new signatureOperation ApiReleaseOperations.update has a new signatureOperation GatewayApiOperations.create_or_update has a new signatureOperation TagOperations.create_or_update has a new signatureOperation SignUpSettingsOperations.create_or_update has a new signatureOperation SignInSettingsOperations.create_or_update has a new signatureOperation ApiOperationPolicyOperations.create_or_update has a new signatureOperation PolicyOperations.create_or_update has a new signatureOperation ApiPolicyOperations.create_or_update has a new signatureOperation ApiReleaseOperations.create_or_update has a new signatureOperation GatewayOperations.create_or_update has a new signatureOperation ProductPolicyOperations.create_or_update has a new signatureRemoved operation group ContentTypeContentItemOperations1.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 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.0.2.0 (2020-03-25)FeaturesModel IdentityProviderUpdateParameters has a new parameter signin_tenantModel ApiManagementServiceIdentity has a new parameter user_assigned_identitiesModel AdditionalLocation has a new parameter disable_gatewayModel UserCreateParameters has a new parameter app_typeModel ApiManagementServiceResource has a new parameter disable_gatewayModel ApiManagementServiceResource has a new parameter developer_portal_urlModel ApiManagementServiceResource has a new parameter api_version_constraintModel DiagnosticContract has a new parameter log_client_ipModel DiagnosticContract has a new parameter verbosityModel DiagnosticContract has a new parameter http_correlation_protocolModel SchemaContract has a new parameter valueModel SchemaContract has a new parameter definitionsModel ApiManagementServiceUpdateParameters has a new parameter disable_gatewayModel ApiManagementServiceUpdateParameters has a new parameter developer_portal_urlModel ApiManagementServiceUpdateParameters has a new parameter api_version_constraintModel TagDescriptionContract has a new parameter tag_idModel ApiManagementServiceBaseProperties has a new parameter disable_gatewayModel ApiManagementServiceBaseProperties has a new parameter developer_portal_urlModel ApiManagementServiceBaseProperties has a new parameter api_version_constraintModel IdentityProviderBaseParameters has a new parameter signin_tenantModel IdentityProviderContract has a new parameter signin_tenantAdded operation TenantAccessGitOperations.list_secretsAdded operation DelegationSettingsOperations.list_secretsAdded operation AuthorizationServerOperations.list_secretsAdded operation TenantAccessOperations.list_secretsAdded operation SubscriptionOperations.list_secretsAdded operation IdentityProviderOperations.list_secretsAdded operation OpenIdConnectProviderOperations.list_secretsAdded operation group GatewayApiOperationsAdded operation group PolicyDescriptionOperationsAdded operation group GatewayHostnameConfigurationOperationsAdded operation group NamedValueOperationsAdded operation group GatewayOperationsGeneral breaking changesThis version uses a next-generation code generator thatmightintroduce 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 fromazure.mgmt.apimanagement.api_management_clientanymore (import fromazure.mgmt.apimanagementworks like before)ApiManagementClientConfiguration import has been moved fromazure.mgmt.apimanagement.api_management_clienttoazure.mgmt.apimanagementA modelMyClassfrom a "models" sub-module cannot be imported anymore usingazure.mgmt.apimanagement.models.my_class(import fromazure.mgmt.apimanagement.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.apimanagement.operations.my_class_operations(import fromazure.mgmt.apimanagement.operationsworks 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