Package: azure-mgmt-cognitiveservices
Microsoft Azure SDK for PythonThis is the Microsoft Azure Cognitive Services 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-cognitiveservices
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.cognitiveservicesimportCognitiveServicesManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=CognitiveServicesManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Cognitive Services 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 History13.5.0 (2023-07-21)Features AddedAdded operation group ModelsOperationsAdded operation group UsagesOperationsModel AccountModel has a new parameter is_default_versionModel AccountModel has a new parameter skusModel AccountModel has a new parameter sourceModel AccountProperties has a new parameter abuse_penaltyModel CommitmentPlanProperties has a new parameter provisioning_issuesModel Deployment has a new parameter skuModel DeploymentModel has a new parameter sourceModel DeploymentProperties has a new parameter rate_limitsModel DeploymentProperties has a new parameter version_upgrade_optionModel UsageListResult has a new parameter next_link13.4.0 (2023-02-15)Features AddedAdded operation CommitmentPlansOperations.begin_create_or_update_associationAdded operation CommitmentPlansOperations.begin_create_or_update_planAdded operation CommitmentPlansOperations.begin_delete_associationAdded operation CommitmentPlansOperations.begin_delete_planAdded operation CommitmentPlansOperations.begin_update_planAdded operation CommitmentPlansOperations.get_associationAdded operation CommitmentPlansOperations.get_planAdded operation CommitmentPlansOperations.list_associationsAdded operation CommitmentPlansOperations.list_plans_by_resource_groupAdded operation CommitmentPlansOperations.list_plans_by_subscriptionModel AccountModel has a new parameter finetune_capabilitiesModel AccountModel has a new parameter lifecycle_statusModel AccountProperties has a new parameter commitment_plan_associationsModel AccountProperties has a new parameter locationsModel CommitmentPlan has a new parameter kindModel CommitmentPlan has a new parameter locationModel CommitmentPlan has a new parameter skuModel CommitmentPlan has a new parameter tagsModel CommitmentPlanProperties has a new parameter commitment_plan_guidModel CommitmentPlanProperties has a new parameter provisioning_state13.4.0b1 (2022-12-29)Features AddedAdded operation CommitmentPlansOperations.begin_create_or_update_associationAdded operation CommitmentPlansOperations.begin_create_or_update_planAdded operation CommitmentPlansOperations.begin_delete_associationAdded operation CommitmentPlansOperations.begin_delete_planAdded operation CommitmentPlansOperations.begin_update_planAdded operation CommitmentPlansOperations.get_associationAdded operation CommitmentPlansOperations.get_planAdded operation CommitmentPlansOperations.list_associationsAdded operation CommitmentPlansOperations.list_plans_by_resource_groupAdded operation CommitmentPlansOperations.list_plans_by_subscriptionModel AccountModel has a new parameter finetune_capabilitiesModel AccountModel has a new parameter lifecycle_statusModel AccountProperties has a new parameter commitment_plan_associationsModel AccountProperties has a new parameter locationsModel CommitmentPlan has a new parameter kindModel CommitmentPlan has a new parameter locationModel CommitmentPlan has a new parameter skuModel CommitmentPlan has a new parameter tagsModel CommitmentPlanProperties has a new parameter commitment_plan_guidModel CommitmentPlanProperties has a new parameter provisioning_state13.3.0 (2022-10-24)Features AddedModel AccountModel has a new parameter call_rate_limitModel DeploymentModel has a new parameter call_rate_limitModel DeploymentProperties has a new parameter call_rate_limitModel DeploymentProperties has a new parameter capabilitiesModel DeploymentProperties has a new parameter rai_policy_name13.2.0 (2022-06-08)Featuresscale_typeof Model DeploymentScaleType has a new Enum type STANDARD13.1.0 (2022-03-25)FeaturesAdded operation AccountsOperations.list_modelsModel AccountProperties has a new parameter deletion_dateModel AccountProperties has a new parameter dynamic_throttling_enabledModel AccountProperties has a new parameter scheduled_purge_dateModel DeploymentScaleSettings has a new parameter active_capacity13.0.0 (2021-11-15)FeaturesModel DomainAvailability has a new parameter kindModel CheckDomainAvailabilityParameter has a new parameter kindAdded operation group CommitmentPlansOperationsAdded operation group CommitmentTiersOperationsAdded operation group DeploymentsOperationsBreaking changesOperation CognitiveServicesManagementClientOperationsMixin.check_domain_availability has a new signature12.0.0 (2021-06-03)FeaturesModel UserOwnedStorage has a new parameter identity_client_idModel Sku has a new parameter familyModel Sku has a new parameter capacityModel Sku has a new parameter sizeModel PrivateEndpointConnection has a new parameter locationModel PrivateEndpointConnection has a new parameter system_dataModel PrivateEndpointConnection has a new parameter etagModel PrivateEndpointConnectionProperties has a new parameter provisioning_stateModel KeyVaultProperties has a new parameter identity_client_idModel PrivateLinkServiceConnectionState has a new parameter actions_requiredAdded operation PrivateEndpointConnectionsOperations.begin_create_or_updateAdded operation PrivateEndpointConnectionsOperations.begin_deleteAdded operation AccountsOperations.list_usagesAdded operation AccountsOperations.begin_deleteAdded operation AccountsOperations.getAdded operation AccountsOperations.begin_createAdded operation AccountsOperations.begin_updateAdded operation group DeletedAccountsOperationsBreaking changesModel PrivateLinkServiceConnectionState no longer has parameter action_requiredRemoved operation PrivateEndpointConnectionsOperations.create_or_updateRemoved operation PrivateEndpointConnectionsOperations.deleteRemoved operation AccountsOperations.deleteRemoved operation AccountsOperations.createRemoved operation AccountsOperations.get_usagesRemoved operation AccountsOperations.updateRemoved operation AccountsOperations.get_properties11.0.0 (2020-12-22)FeaturesModel CognitiveServicesAccountProperties has a new parameter date_created11.0.0b1 (2020-11-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.6.3.0 (2020-10-09)FeaturesModel CognitiveServicesAccountApiProperties has a new parameter website_nameModel CognitiveServicesAccountApiProperties has a new parameter super_userModel CognitiveServicesAccountApiProperties has a new parameter aad_client_idModel CognitiveServicesAccountApiProperties has a new parameter aad_tenant_idAdded operation PrivateEndpointConnectionsOperations.list6.2.0 (2020-05-29)FeaturesModel CognitiveServicesAccountProperties has a new parameter public_network_accessModel CognitiveServicesAccountProperties has a new parameter private_endpoint_connectionsModel CognitiveServicesAccountProperties has a new parameter capabilitiesAdded operation group PrivateEndpointConnectionsOperationsAdded operation group PrivateLinkResourcesOperations6.1.0 (2020-03-25)FeaturesModel CognitiveServicesAccount has a new parameter identityModel CognitiveServicesAccountProperties has a new parameter user_owned_storageModel CognitiveServicesAccountProperties has a new parameter encryption6.0.0 (2020-02-07)FeaturesModel CognitiveServicesAccount has a new parameter propertiesAdded operation CognitiveServicesManagementClientOperationsMixin.check_sku_availabilityBreaking changesOperation AccountsOperations.create has a new signatureModel CognitiveServicesAccount no longer has parameter network_aclsModel CognitiveServicesAccount no longer has parameter provisioning_stateModel CognitiveServicesAccount no longer has parameter internal_idModel CognitiveServicesAccount no longer has parameter custom_sub_domain_nameModel CognitiveServicesAccount no longer has parameter endpointModel NetworkRuleSet no longer has parameter bypassOperation AccountsOperations.update has a new signatureRemoved operation group CheckSkuAvailabilityOperations5.0.0 (2019-06-21)FeaturesModel CognitiveServicesAccount has a new parameter network_aclsAdd operation check_domain_availabilityGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes for some imports. 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.CognitiveServicesManagementClient cannot be imported fromazure.mgmt.cognitiveservices.v20xx_yy_zz.cognitive_services_management_clientanymore (import fromazure.mgmt.cognitiveservices.v20xx_yy_zzworks like before)CognitiveServicesManagementClientConfiguration import has been moved
fromazure.mgmt.cognitiveservices.v20xx_yy_zz.cognitive_services_management_clienttoazure.mgmt.cognitiveservices.v20xx_yy_zzA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.cognitiveservices.v20xx_yy_zz.models.my_class(import fromazure.mgmt.cognitiveservices.v20xx_yy_zz.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.cognitiveservices.v20xx_yy_zz.operations.my_class_operations(import fromazure.mgmt.cognitiveservices.v20xx_yy_zz.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.4.0.0 (2019-05-01)FeaturesModel CognitiveServicesAccount has a new parameter
custom_sub_domain_nameModel CognitiveServicesAccountUpdateParameters has a new parameter
propertiesOperation AccountsOperations.update now takes optional propertiesBreaking changesRemove limited enum Kind and SkuName. Replace all usage by a simple
string (e.g. "Bing.SpellCheck.v7")3.0.0 (2018-05-21)General Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes.Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:https://docs.python.org/3/library/enum.html#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.FeaturesAdd "resource_skus" operation groupUpdate SKU listAdd "accounts.get_usages" operationClient class can be used as a context manager to keep the underlying
HTTP session open for performanceBugfixesCompatibility of the sdist with wheel 0.31.02.0.0 (2017-10-26)Breaking changesremove "location" as a constructor parametersku_name in "check_sku_availability" result is now a str (from an
enum)merge "cognitive_services_accounts" into "accounts" operation
group"key_name" is now required to regenerate keys"location/skus/kind/type" are now required for "list" available skus1.0.0 (2017-05-01)No changes, this is the 0.30.0 approved as stable.0.30.0 (2017-05-01)Initial Release (ApiVersion 2017-04-18)This wheel package is now built with the azure wheel extension