diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index cbb5f2ce..1ae1c586 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -5,31 +5,111 @@ "build_source_folder": ".", "build_output_subfolder": "python-sdk-archive", "locale": "en-us", - "monikers": [], + "moniker_ranges": [ + "azure-python-previous" + ], "open_to_public_contributors": false, "type_mapping": { - "Conceptual": "Content" + "Conceptual": "Content", + "ManagedReference": "Content", + "RestApi": "Content", + "UniversalReference": "Content", + "PythonEnum": "Content", + "PythonModule": "Content", + "PythonClass": "Content", + "PythonPackage": "Content", + "ReferenceContainer": "Content", + "LandingData": "Content", + "APIConnector": "Content", + "Tutorial": "Content" }, "build_entry_point": "docs", "template_folder": "_themes", - "base_path": "python", - "site_name": "Docs", - "template": "Python_basic" + "customized_template_paths": [ + "_dependentPackages/uref/content" + ], + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/CommonPlugins/tools/SplitTOC.ps1", + "_dependentPackages/CommonPlugins/tools/JoinTOC.ps1", + "_dependentPackages/CommonPlugins/tools/DiffFolder.ps1" + ] + }, + "DiffFolder": [ + "api" + ], + "version": 0 } ], "notification_subscribers": [], + "sync_notification_subscribers": null, "branches_to_filter": [], + "git_repository_branch_open_to_public_contributors": "main", + "skip_source_output_uploading": false, "need_preview_pull_request": true, + "enable_incremental_build": false, + "contribution_branch_mappings": null, "dependent_repositories": [ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", + "branch": "main", + "branch_mapping": {} + }, + { + "path_to_root": "aci-docs-sample-python", + "url": "https://github.com/Azure-Samples/aci-docs-sample-python", "branch": "master", "branch_mapping": {} } ], - "branch_target_mapping": {}, - "skip_source_output_uploading": false, - "contribution_branch_mappings": {}, - "need_generate_pdf_url_template": false + "branch_target_mapping": null, + "need_generate_pdf": false, + "need_generate_intellisense": false, + "error_log_codes": [ + "DuplicateOutputFiles" + ], + "SplitTOC": [ + "docs-ref-autogen/toc.yml" + ], + "dependent_packages": [ + { + "id": "opbuild.templates.uref", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/uref", + "target_framework": "net45", + "version": "latest" + }, + { + "id": "Microsoft.OpenPublishing.CommonPlugins", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/CommonPlugins", + "target_framework": "net45", + "version": "latest" + } + ], + "JoinTOCPlugin": [ + { + "TopLevelTOC": "docs-ref-mapping/reference-previous.yml", + "ReferenceTOC": "previous/docs-ref-autogen/toc.yml", + "ReferenceTOCUrl": "/previous-versions/python/api/toc.json", + "ConceptualTOCUrl": "/azure/developer/python/toc.json", + "OutputFolder": "previous/docs-ref-autogen/overview/azure", + "ContainerPageMetadata": { + "langs": [ + "python" + ] + } + } + ], + "DiffFolder": [ + "docs-ref-autogen/overview/azure" + ], + "need_generate_pdf_url_template": false, + "docs_build_engine": { + "name": "docfx_v3" + }, + "redirection_files": [ + "redirections/.openpublishing.redirection.simplify-package-structure.json" + ] } \ No newline at end of file diff --git a/bread/toc.yml b/bread/toc.yml new file mode 100644 index 00000000..2afd021b --- /dev/null +++ b/bread/toc.yml @@ -0,0 +1,3 @@ +- name: Azure + tocHref: /python/azure/ + topicHref: /azure/index diff --git a/breadcrumb/toc.yml b/breadcrumb/toc.yml deleted file mode 100644 index 748c822f..00000000 --- a/breadcrumb/toc.yml +++ /dev/null @@ -1,3 +0,0 @@ -- name: - tocHref: / - topicHref: / diff --git a/ci-configs/packages-legacy.json b/ci-configs/packages-legacy.json new file mode 100644 index 00000000..1838f129 --- /dev/null +++ b/ci-configs/packages-legacy.json @@ -0,0 +1,845 @@ +{ + "target_repo": { + "branch": "smoke-test", + "url": "https://github.com/MicrosoftDocs/azure-docs-sdk-python", + "folder": "previous" + }, + "packages": [ + { + "package_info": { + "name": "azure-00-data-lake-store-python", + "install_type": "source_code", + "prefer_source_distribution": "true", + "version": "==IGNORE", + "url": "https://github.com/Azure/azure-data-lake-store-python", + "branch": "master" + }, + "exclude_path": [ + "azure_bdist_wheel.py", + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-ai-metricsadvisor", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-ai-vision", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.15.1b1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-applicationinsights", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.1.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-anomalydetector", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==0.3.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-knowledge-qnamaker", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.3.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-language-luis", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.7.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-language-spellcheck", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.0.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*", + "azure_bdist_wheel.py" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-language-textanalytics", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==0.2.2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-search-newssearch", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.0.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-search-visualsearch", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.2.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-vision-computervision", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.9.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*", + "azure_bdist_wheel.py" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-vision-contentmoderator", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.0.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-vision-customvision", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==3.1.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*", + "azure_bdist_wheel.py" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cognitiveservices-vision-face", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==0.6.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-common", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.1.28" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*", + "testutils", + "azure_bdist_wheel.py" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-communication-networktraversal", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.1.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-cosmos", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==3.2.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-graphrbac", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==0.61.2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-iot-modelsrepository", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-keyvault", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-loganalytics", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==0.1.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-media-videoanalyzer-edge", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b4" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-mgmt-agfood", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-app", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-azureadb2c", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-azurelargeinstance", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-batchai", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==7.0.0b1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-edgegateway", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-logz", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.1.1" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-networkanalytics", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-powerbiembedded", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==3.0.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-scheduler", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==7.0.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-storageimportexport", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-testbase", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-videoanalyzer", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b4" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-mgmt-workloadmonitor", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==1.0.0b4" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ] + }, + { + "package_info": { + "name": "azure-purview-catalog", + "install_type": "pypi", + "prefer_source_distribution": "true", + "version": "==1.0.0b4" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-servicemanagement-legacy", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.20.8" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-storage-blob", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-storage-common", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-storage-file", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-storage-queue", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==2.1.0" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + }, + { + "package_info": { + "name": "azure-synapse", + "install_type": "pypi", + "prefer_source_distribution": false, + "version": "==0.1.2" + }, + "exclude_path": [ + "test*", + "example*", + "sample*", + "doc*" + ], + "extension_config": { + "autodoc_default_options": { + "inherited-members": 1 + } + } + } + ], + "required_packages": [ + { + "install_type": "pypi", + "name": "msrestazure" + }, + { + "version": null, + "name": "promptflow", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "json-five", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "azure-keyvault", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "aiohttp_retry", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "azureml-metrics", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "pyarrow", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": "1.47.0", + "name": "openai", + "comment": "Needed for azure-ai-generative and azure-ai-evalation which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "mmh3", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": null, + "name": "jsonpath-ng", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + }, + { + "version": "1.23.0", + "name": "azure-ai-ml", + "comment": "Needed for azure-ai-generative which has extras in it setup.py", + "install_type": "pypi" + } + ], + "run_post_toc_script": false +} diff --git a/ci_scripts/autorest_generated_packages.rst b/ci_scripts/autorest_generated_packages.rst new file mode 100644 index 00000000..d2c8a035 --- /dev/null +++ b/ci_scripts/autorest_generated_packages.rst @@ -0,0 +1,60 @@ +.. toctree:: + :maxdepth: 5 + :glob: + :caption: Developer Documentation + + ./ref/azure.common.rst + ./ref/azure.batch.rst + ./ref/azure.graphrbac.rst + ./ref/azure.keyvault.rst + ./ref/azure.mgmt.authorization.rst + ./ref/azure.mgmt.batch.rst + ./ref/azure.mgmt.billing.rst + ./ref/azure.mgmt.cdn.rst + ./ref/azure.mgmt.cognitiveservices.rst + ./ref/azure.mgmt.commerce.rst + ./ref/azure.mgmt.compute.compute.rst + ./ref/azure.mgmt.compute.containerservice.rst + ./ref/azure.mgmt.consumption.rst + ./ref/azure.mgmt.containerregistry.rst + ./ref/azure.mgmt.datalake.analytics.account.rst + ./ref/azure.mgmt.datalake.analytics.catalog.rst + ./ref/azure.mgmt.datalake.analytics.job.rst + ./ref/azure.mgmt.datalake.store.rst + ./ref/azure.mgmt.devtestlabs.rst + ./ref/azure.mgmt.dns.rst + ./ref/azure.mgmt.documentdb.rst + ./ref/azure.mgmt.eventhub.rst + ./ref/azure.mgmt.iothub.rst + ./ref/azure.mgmt.keyvault.rst + ./ref/azure.mgmt.logic.rst + ./ref/azure.mgmt.media.rst + ./ref/azure.mgmt.monitor.rst + ./ref/azure.mgmt.network.rst + ./ref/azure.mgmt.notificationhubs.rst + ./ref/azure.mgmt.powerbiembedded.rst + ./ref/azure.mgmt.rdbms.mysql.rst + ./ref/azure.mgmt.rdbms.postgresql.rst + ./ref/azure.mgmt.rdbms.recoveryservicesbackup.rst + ./ref/azure.mgmt.redis.rst + ./ref/azure.mgmt.resource.features.rst + ./ref/azure.mgmt.resource.links.rst + ./ref/azure.mgmt.resource.locks.rst + ./ref/azure.mgmt.resource.managedapplications.rst + ./ref/azure.mgmt.resource.policy.rst + ./ref/azure.mgmt.resource.resources.rst + ./ref/azure.mgmt.resource.subscriptions.rst + ./ref/azure.mgmt.scheduler.rst + ./ref/azure.mgmt.search.rst + ./ref/azure.mgmt.servermanager.rst + ./ref/azure.mgmt.servicebus.rst + ./ref/azure.mgmt.sql.rst + ./ref/azure.mgmt.storage.rst + ./ref/azure.mgmt.trafficmanager.rst + ./ref/azure.mgmt.web.rst + ./ref/azure.monitor.rst + ./ref/azure.servicefabric.rst + ./ref/azure.servicebus.rst + ./ref/azure.servicemanagement.rst + ./ref/azure.cosmosdb.rst + ./ref/azure.cosmosdb.table.rst diff --git a/ci_scripts/conf.py b/ci_scripts/conf.py new file mode 100644 index 00000000..c77d1d44 --- /dev/null +++ b/ci_scripts/conf.py @@ -0,0 +1,86 @@ +# -*- coding: utf-8 -*- + +import sys +import os + +sys.path.insert(0, os.path.abspath('.')) +sys.path.append(os.path.abspath('.')) + +templates_path = ['_templates'] +source_suffix = '.rst' +master_doc = 'index' +project = u'pyexample' +copyright = u'2015, rtfd' +author = u'rtfd' +version = '0.1' +release = '0.1' +language = None +pygments_style = 'sphinx' +todo_include_todos = False +html_theme = 'alabaster' +html_static_path = ['_static'] +htmlhelp_basename = 'pyexampledoc' + + + +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.napoleon', + 'docfx_yaml.extension'] + +napoleon_use_admonition_for_examples = True + +exclude_patterns = [ + '_build', + '*.tests.rst' +] + + +namespace_package_dict = { + 'azure_batch-([A-Za-z0-9\-\.]*).egg': 'azure-batch', + 'azure_common-([A-Za-z0-9\-\.]*).egg': 'azure-common', + 'azure_graphrbac-([A-Za-z0-9\-\.]*).egg': 'azure-graphrbac', + 'azure_keyvault-([A-Za-z0-9\-\.]*).egg': 'azure-keyvault', + 'azure_mgmt_authorization-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-authorization', + 'azure_mgmt_batch-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-batch', + 'azure_mgmt_billing-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-billing', + 'azure_mgmt_cdn-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-cdn', + 'azure_mgmt_cognitiveservices-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-cognitiveservices', + 'azure_mgmt_commerce-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-commerce', + 'azure_mgmt_compute-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-compute', + 'azure_mgmt_consumption-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-consumption', + 'azure_mgmt_containerregistry-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-containerregistry', + 'azure_mgmt_datalake_analytics-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-datalake_analytics', + 'azure_mgmt_datalake_store-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-datalake-store', + 'azure_mgmt_devtestlabs-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-devtestlabs', + 'azure_mgmt_dns-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-dns', + 'azure_mgmt_documentdb-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-documentdb', + 'azure_mgmt_eventhub-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-eventhub', + 'azure_mgmt_iothub-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-iothub', + 'azure_mgmt_keyvault-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-keyvault', + 'azure_mgmt_logic-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-logic', + 'azure_mgmt_media-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-media', + 'azure_mgmt_monitor-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-monitor', + 'azure_mgmt_network-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-network', + 'azure_mgmt_notificationhubs-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-notificationhubs', + 'azure_mgmt_powerbiembedded-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-powerbiembedded', + 'azure_mgmt_rdbms-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-rdbms', + 'azure_mgmt_recoveryservicesbackup-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-recoveryservicesbackup', + 'azure_mgmt_redis-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-redis', + 'azure_mgmt_resource-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-resource', + 'azure_mgmt_scheduler-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-scheduler', + 'azure_mgmt_search-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-search', + 'azure_mgmt_servermanager-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-servermanager', + 'azure_mgmt_servicebus-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-servicebus', + 'azure_mgmt_sql-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-sql', + 'azure_mgmt_storage-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-storage', + 'azure_mgmt_trafficmanager-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-trafficmanager', + 'azure_mgmt_web-([A-Za-z0-9\-\.]*).egg': 'azure-mgmt-web', + 'azure_monitor-([A-Za-z0-9\-\.]*).egg': 'azure-monitor', + 'azure_servicebus-([A-Za-z0-9\-\.]*).egg': 'azure-servicebus', + 'azure_servicefabric-([A-Za-z0-9\-\.]*).egg': 'azure-servicefabric', + 'azure_servicemanagement-([A-Za-z0-9\-\.]*).egg': 'azure-servicemanagement-legacy', + 'azure_storage_common-([A-Za-z0-9\-\.]*).egg': 'azure-storage-common', + 'azure_storage_blob-([A-Za-z0-9\-\.]*).egg': 'azure-storage-blob', + 'azure_storage_file-([A-Za-z0-9\-\.]*).egg': 'azure-storage-file', + 'azure_storage_queue-([A-Za-z0-9\-\.]*).egg': 'azure-storage-queue', +} diff --git a/ci_scripts/generate_doc.py b/ci_scripts/generate_doc.py new file mode 100644 index 00000000..e4d9d5cb --- /dev/null +++ b/ci_scripts/generate_doc.py @@ -0,0 +1,163 @@ +import os +import argparse +import logging +import json +import re +from pathlib import Path + +CONFIG_FILE = '../package_service_mapping.json' +GENERATED_PACKAGES_LIST_FILE = 'autorest_generated_packages.rst' + +_LOGGER = logging.getLogger(__name__) + +def make_title(title): + """Create a underlined title with the correct number of =.""" + return "\n".join([title, len(title)*"="]) + +SUBMODULE_TEMPLATE = """{title} + +.. automodule:: {namespace}.{submodule} + :members: + :undoc-members: + :show-inheritance: +""" +PACKAGE_TEMPLATE = """{title} + +Submodules +---------- + +.. toctree:: + + {namespace}.models + {namespace}.operations + +Module contents +--------------- + +.. automodule:: {namespace} + :members: + :undoc-members: + :show-inheritance: +""" + + +RST_AUTODOC_TOCTREE = """.. toctree:: + :maxdepth: 5 + :glob: + :caption: Developer Documentation + +{generated_packages} +""" + +MULTIAPI_VERSION_PACKAGE_TEMPLATE = """{title} + +Module contents +--------------- + +.. automodule:: {namespace} + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + +""" + +def generate_doc(config_path, project_pattern=None): + + multiapi_found_apiversion = {} + multiapi_regex_pattern = re.compile('v\d{4}_\d{2}_\d{2}(_preview)?\Z') + + with Path(config_path).open() as config_fd: + config = json.load(config_fd) + package_list_path = [] + + for project, local_conf in config.items(): + if project_pattern and not any(project.startswith(p) for p in project_pattern): + _LOGGER.info("Skip project %s", project) + continue + + _LOGGER.info("Working on %s", project) + if 'namespaces' in local_conf: + namespaces = local_conf['namespaces'] + + for namespace in namespaces: + rst_path = './ref/{}.rst'.format(namespace) + with Path(rst_path).open('w') as rst_file: + rst_file.write(PACKAGE_TEMPLATE.format( + title=make_title(namespace+" package"), + namespace=namespace + )) + + for module in ["operations", "models"]: + with Path('./ref/{}.{}.rst'.format(namespace, module)).open('w') as rst_file: + rst_file.write(SUBMODULE_TEMPLATE.format( + title=make_title(namespace+"."+module+" module"), + namespace=namespace, + submodule=module + )) + + match = multiapi_regex_pattern.search(namespace) + if match: + start_index = match.start() + multiapi_namespace = namespace[:start_index-1] + api_package = namespace[start_index:] + multiapi_found_apiversion.setdefault(multiapi_namespace, []).append(api_package) + + package_list_path.append(rst_path) + + for multiapi_namespace, apilist in multiapi_found_apiversion.items(): + apilist.sort() + apilist.reverse() + rst_path = './ref/{}.rst'.format(multiapi_namespace) + with Path(rst_path).open('w') as rst_file: + rst_file.write(MULTIAPI_VERSION_PACKAGE_TEMPLATE.format( + title=make_title(multiapi_namespace+" package"), + namespace=multiapi_namespace + )) + for version in apilist: + rst_file.write(" {namespace}.{version}\n".format( + namespace=multiapi_namespace, + version=version)) + package_list_path.append(rst_path) + + package_list_path.sort() + with Path(GENERATED_PACKAGES_LIST_FILE).open('w') as generate_file_list_fd: + lines_to_write = "\n".join([" "+package for package in package_list_path]) + generate_file_list_fd.write(RST_AUTODOC_TOCTREE.format(generated_packages=lines_to_write)) + +def main(): + cwd = os.getcwd() # Get the current working directory (cwd) + print("cwd '%s'" % (cwd)) + + parser = argparse.ArgumentParser( + description='Generate documentation file.' + ) + parser.add_argument('--project', '-p', + dest='project', action='append', + help='Select a specific project. Do all by default. You can use a substring for several projects.') + parser.add_argument('--config', '-c', + dest='config_path', default=CONFIG_FILE, + help='The JSON configuration format path [default: %(default)s]') + parser.add_argument("-v", "--verbose", + dest="verbose", action="store_true", + help="Verbosity in INFO mode") + parser.add_argument("--debug", + dest="debug", action="store_true", + help="Verbosity in DEBUG mode") + + args = parser.parse_args() + + main_logger = logging.getLogger() + if args.verbose or args.debug: + logging.basicConfig() + main_logger.setLevel(logging.DEBUG if args.debug else logging.INFO) + + generate_doc(args.config_path, args.project) + + +if __name__ == "__main__": + main() diff --git a/ci_scripts/generate_xrefmap.py b/ci_scripts/generate_xrefmap.py new file mode 100644 index 00000000..3f23198d --- /dev/null +++ b/ci_scripts/generate_xrefmap.py @@ -0,0 +1,28 @@ +"""This module generates xrefmap from external links.""" +import os +import urllib.request +import yaml + +from sphinx.ext.intersphinx import read_inventory + +EXTERNAL_LINKS = ['https://docs.python.org/3.5/', + 'http://msrestazure.readthedocs.io/en/latest/', + 'http://msrest.readthedocs.io/en/latest/'] +xref_map = [] + +for external_Link in EXTERNAL_LINKS: + obj_link = os.path.join(external_Link, 'objects.inv') + stream = urllib.request.urlopen(obj_link) + inventory = read_inventory(stream, external_Link, os.path.join) + for role_key, role_value in inventory.items(): + if role_key.startswith('py:'): + for ref_name, ref_value in role_value.items(): + # Only use last element in ref_name + title_name = ref_name.split('.')[-1] + xref_map.append({'uid': ref_name, + 'name': title_name, + 'href': ref_value[2], + 'fullName': ref_name}) + +with open('xrefmap.yml', 'w', encoding='utf8') as out_file: + yaml.dump({'references': xref_map}, out_file, default_flow_style=False, allow_unicode=True) diff --git a/ci_scripts/index.rst b/ci_scripts/index.rst new file mode 100644 index 00000000..88777770 --- /dev/null +++ b/ci_scripts/index.rst @@ -0,0 +1,5 @@ +==================== +Azure SDK for Python +==================== + +.. include:: autorest_generated_packages.rst diff --git a/ci_scripts/postprocess_toc_yml.py b/ci_scripts/postprocess_toc_yml.py new file mode 100644 index 00000000..cda06d31 --- /dev/null +++ b/ci_scripts/postprocess_toc_yml.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- + +import io +import yaml + +skipped_level2_packages = [ + 'azure.mgmt.resource.features', + 'azure.mgmt.resource.links', + 'azure.mgmt.resource.locks', + 'azure.mgmt.resource.managedapplications', + 'azure.mgmt.resource.policy', + 'azure.mgmt.resource.resources', + 'azure.mgmt.resource.subscriptions', + 'azure.mgmt.compute.containerservice', + 'azure.mgmt.compute.compute' +] + +def rewrite_yml(data): + with io.open('toc.yml', 'w', encoding='utf8') as outfile: + yaml.dump(data, outfile, default_flow_style=False, allow_unicode=True) + +with open("toc.yml", 'r') as stream: + try: + data_loaded = yaml.load(stream) + for node in data_loaded: + if 'name' in node: + if node['name'].startswith('azure.') and node['name'] not in skipped_level2_packages: + node['name'] = node['name'].replace('.', '-') + print('update old name to %s' % node['name']) + + rewrite_yml(data_loaded) + except yaml.YAMLError as exc: + print(exc) diff --git a/docfx.json b/docfx.json index 3a163595..e83f35ec 100644 --- a/docfx.json +++ b/docfx.json @@ -1,28 +1,45 @@ { "build": { - "markdownEngineName": "markdig", "content": [ { "files": [ "**/*.md", "**/*.yml" ], - "src": "docs-ref-autogen", + "exclude": ["**/*-index.md"], + "src": "docs-ref-services/legacy", + "group": "previous", + "dest": "api/overview/azure" + }, + { + "files": [ + "*.md", + "*.yml" + ], + "exclude": ["**/*-index.md"], + "src": "docs-ref-services", + "group": "all", + "dest": "api/overview/azure" + }, + { + "files": [ + "**/*.yml" + ], + "src": "previous/docs-ref-autogen", + "group": "previous", + "dest": "api", "exclude": [ "**/obj/**", - "**/includes/**", - "README.md", - "LICENSE", - "LICENSE-CODE", - "ThirdPartyNotices" + "**/includes/**" ] }, - { + { "files": [ "**/*.yml" ], - "src": "breadcrumb", - "dest": "breadcrumb", + "src": "bread", + "dest": "azure/bread", + "group": "all", "exclude": [ "**/obj/**", "**/includes/**" @@ -35,27 +52,77 @@ "**/*.png", "**/*.jpg" ], + "src": "docs-ref-conceptual", + "dest": "azure", "exclude": [ "**/obj/**", "**/includes/**" ] } ], + "groups": { + "previous": { + "dest": "previous", + "moniker_range": "azure-python-previous" + }, + "all": { + "dest": "all", + "moniker_range": "azure-python-preview || azure-python || azure-python-previous" + } + }, "overwrite": [], "externalReference": [], "globalMetadata": { "ROBOTS": "NOINDEX,NOFOLLOW", "is_archived": true, "is_retired": false, - "feedback_system": "None", - "learn_archive": "manual", - "breadcrumb_path": "~/breadcrumb/toc.yml" + "learn_archive": "manual", + "uhfHeaderId": "Azure", + "feedback_system": "OpenSource", + "feedback_github_repo": "Azure/azure-sdk-for-python", + "feedback_product_url": "https://github.com/Azure/azure-sdk-for-python/issues", + "open_source_feedback_contributorGuideUrl": "https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md", + "open_source_feedback_issueTitle": "", + "open_source_feedback_issueUrl": "https://github.com/Azure/azure-sdk-for-python/issues/new?template=z-learn-feedback.yml", + "open_source_feedback_productLogoDarkUrl": "https://azure.github.io/azure-sdk/images/azure-sdk-glyph.svg", + "open_source_feedback_productLogoLightUrl": "https://azure.github.io/azure-sdk/images/azure-sdk-glyph.svg", + "open_source_feedback_productName": "Azure SDK for Python", + "breadcrumb_path": "/python/azure/bread/toc.json", + "apiPlatform": "python", + "brand": "azure", + "searchScope": [ + "Azure", + "Azure SDK for Python" + ], + "contributors_to_exclude": [ + "danieljurek", + "JimSuplizio" + ] + }, + "fileMetadata": { + "monikers": { + "docs-ref-services/legacy/**": [ + "azure-python-previous" + ] + }, + "author": { + "docs-ref-services/**": "azure-sdk" + }, + "ms.author": { + "docs-ref-services/**": "azsdkdocs" + }, + "ms.custom": { + "docs-ref-services/**/*.md": "tracking-python" + }, + "ms.topic": { + "previous/docs-ref-autogen/**/*.yml": "generated-reference" + } }, - "fileMetadata": {}, "template": [], - "dest": "_site", - "xref": [ - "../xrefmap.yml" - ] + "dest": "azure-python-sdk", + "xref": [ + "xrefmap.yml" + ], + "markdownEngineName": "markdig" } } diff --git a/docs-ref-mapping/reference-preview.yml b/docs-ref-mapping/reference-preview.yml new file mode 100644 index 00000000..906e1d29 --- /dev/null +++ b/docs-ref-mapping/reference-preview.yml @@ -0,0 +1,1937 @@ +- name: Reference + landingPageType: Root + expanded: false + items: + - name: Advisor + href: ~/docs-ref-services/preview/advisor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Advisor + href: ~/docs-ref-services/preview/mgmt-advisor-readme.md + children: + - azure.mgmt.advisor + - name: Agrifood + href: ~/docs-ref-services/preview/agrifood.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Agrifood + href: ~/docs-ref-services/preview/mgmt-agrifood-readme.md + children: + - azure.mgmt.agrifood + - name: AKS Developer Hub + href: ~/docs-ref-services/preview/aks-developer-hub.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - AKS Developer Hub + href: ~/docs-ref-services/preview/mgmt-devhub-readme.md + children: + - azure.mgmt.devhub + - name: Alerts Management + href: ~/docs-ref-services/preview/alerts-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Alerts Management + href: ~/docs-ref-services/preview/mgmt-alertsmanagement-readme.md + children: + - azure.mgmt.alertsmanagement + - name: API Center + href: ~/docs-ref-services/preview/api-center.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - API Center + href: ~/docs-ref-services/preview/mgmt-apicenter-readme.md + children: + - azure.mgmt.apicenter + - name: App Compliance Automation + href: ~/docs-ref-services/preview/app-compliance-automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Compliance Automation + href: ~/docs-ref-services/preview/mgmt-appcomplianceautomation-readme.md + children: + - azure.mgmt.appcomplianceautomation + - name: App Configuration + href: ~/docs-ref-services/preview/app-configuration.md + landingPageType: Service + items: + - name: App Configuration + href: ~/docs-ref-services/preview/appconfiguration-readme.md + children: + - azure.appconfiguration + - name: App Configuration Provider + href: ~/docs-ref-services/preview/appconfiguration-provider-readme.md + children: + - azure.appconfiguration.provider + - name: Arc Data + href: ~/docs-ref-services/preview/arc-data.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Arc Data + href: ~/docs-ref-services/preview/mgmt-azurearcdata-readme.md + children: + - azure.mgmt.azurearcdata + - name: Astro + href: ~/docs-ref-services/preview/astro.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Astro + href: ~/docs-ref-services/preview/mgmt-astro-readme.md + children: + - azure.mgmt.astro + - name: Attestation + href: ~/docs-ref-services/preview/attestation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Attestation + href: ~/docs-ref-services/preview/mgmt-attestation-readme.md + children: + - azure.mgmt.attestation + - name: Auto Suggest + href: ~/docs-ref-services/preview/auto-suggest.md + landingPageType: Service + items: + - name: Auto Suggest (deprecated) + href: ~/docs-ref-services/preview/cognitiveservices-search-autosuggest-readme.md + children: + - azure.cognitiveservices.search.autosuggest + - name: Automanage + href: ~/docs-ref-services/preview/automanage.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automanage + href: ~/docs-ref-services/preview/mgmt-automanage-readme.md + children: + - azure.mgmt.automanage + - name: Automation + href: ~/docs-ref-services/preview/automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automation + href: ~/docs-ref-services/preview/mgmt-automation-readme.md + children: + - azure.mgmt.automation + - name: Azure Remote Rendering + href: ~/docs-ref-services/preview/azure-remote-rendering.md + landingPageType: Service + items: + - name: Azure Remote Rendering + href: ~/docs-ref-services/preview/mixedreality-remoterendering-readme.md + children: + - azure.mixedreality.remoterendering + - name: Azure Stack + href: ~/docs-ref-services/preview/azure-stack.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack + href: ~/docs-ref-services/preview/mgmt-azurestack-readme.md + children: + - azure.mgmt.azurestack + - name: Azure Stack HCI + href: ~/docs-ref-services/preview/azure-stack-hci.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack HCI + href: ~/docs-ref-services/preview/mgmt-azurestackhci-readme.md + children: + - azure.mgmt.azurestackhci + - name: Azure VMware Solution + href: ~/docs-ref-services/preview/azure-vmware-solution.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure VMware Solution + href: ~/docs-ref-services/preview/mgmt-avs-readme.md + children: + - azure.mgmt.avs + - name: BareMetal Infrastructure + href: ~/docs-ref-services/preview/baremetal-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - BareMetal Infrastructure + href: ~/docs-ref-services/preview/mgmt-baremetalinfrastructure-readme.md + children: + - azure.mgmt.baremetalinfrastructure + - name: Batch + href: ~/docs-ref-services/preview/batch.md + landingPageType: Service + items: + - name: Batch + href: ~/docs-ref-services/preview/batch-readme.md + children: + - azure.batch + - name: Billing + href: ~/docs-ref-services/preview/billing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Billing + href: ~/docs-ref-services/preview/mgmt-billing-readme.md + children: + - azure.mgmt.billing + - name: Billing Benefits + href: ~/docs-ref-services/preview/billing-benefits.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Billing Benefits + href: ~/docs-ref-services/preview/mgmt-billingbenefits-readme.md + children: + - azure.mgmt.billingbenefits + - name: Chaos + href: ~/docs-ref-services/preview/chaos.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Chaos + href: ~/docs-ref-services/preview/mgmt-chaos-readme.md + children: + - azure.mgmt.chaos + - name: Cognitive Services + href: ~/docs-ref-services/preview/cognitive-services.md + landingPageType: Service + items: + - name: Anomaly Detector + href: ~/docs-ref-services/preview/ai-anomalydetector-readme.md + children: + - azure.ai.anomalydetector + - name: Content Safety + href: ~/docs-ref-services/preview/ai-contentsafety-readme.md + children: + - azure.ai.contentsafety + - name: Document Intelligence + href: ~/docs-ref-services/preview/ai-documentintelligence-readme.md + children: + - azure.ai.documentintelligence + - name: AI Evaluation + href: ~/docs-ref-services/preview/ai-evaluation-readme.md + children: + - azure.ai.evaluation + - name: AI Model Inference + href: ~/docs-ref-services/preview/ai-inference-readme.md + children: + - azure.ai.inference + - name: Personalizer + children: + - azure.ai.personalizer + landingPageType: Service + - name: AI Projects + href: ~/docs-ref-services/preview/ai-projects-readme.md + children: + - azure.ai.projects + - name: Document Translation + href: ~/docs-ref-services/preview/ai-translation-document-readme.md + children: + - azure.ai.translation.document + - name: Text Translation + href: ~/docs-ref-services/preview/ai-translation-text-readme.md + children: + - azure.ai.translation.text + - name: Face + href: ~/docs-ref-services/preview/ai-vision-face-readme.md + children: + - azure.ai.vision.face + - name: Image Analysis + href: ~/docs-ref-services/preview/ai-vision-imageanalysis-readme.md + children: + - azure.ai.vision.imageanalysis + - name: Personalizer + href: ~/docs-ref-services/preview/cognitiveservices-personalizer-readme.md + children: + - azure.cognitiveservices.personalizer + - name: Health Insights Cancer Profiling + href: ~/docs-ref-services/preview/healthinsights-cancerprofiling-readme.md + children: + - azure.healthinsights.cancerprofiling + - name: Health Insights Clinical Matching + href: ~/docs-ref-services/preview/healthinsights-clinicalmatching-readme.md + children: + - azure.healthinsights.clinicalmatching + - name: Health Insights Radiology Insights + href: ~/docs-ref-services/preview/healthinsights-radiologyinsights-readme.md + children: + - azure.healthinsights.radiologyinsights + - name: Commerce + href: ~/docs-ref-services/preview/commerce.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Commerce + href: ~/docs-ref-services/preview/mgmt-commerce-readme.md + children: + - azure.mgmt.commerce + - name: Communication + href: ~/docs-ref-services/preview/communication.md + landingPageType: Service + items: + - name: Communication Call Automation + href: ~/docs-ref-services/preview/communication-callautomation-readme.md + children: + - azure.communication.callautomation + - name: Communication Email + href: ~/docs-ref-services/preview/communication-email-readme.md + children: + - azure.communication.email + - name: Communication Identity + href: ~/docs-ref-services/preview/communication-identity-readme.md + children: + - azure.communication.identity + - name: Communication JobRouter + href: ~/docs-ref-services/preview/communication-jobrouter-readme.md + children: + - azure.communication.jobrouter + - name: Communication Messages + href: ~/docs-ref-services/preview/communication-messages-readme.md + children: + - azure.communication.messages + - name: Communication Phone Numbers + href: ~/docs-ref-services/preview/communication-phonenumbers-readme.md + children: + - azure.communication.phonenumbers + - name: Communication Rooms + href: ~/docs-ref-services/preview/communication-rooms-readme.md + children: + - azure.communication.rooms + - name: Management + items: + - name: Resource Management - Communication + href: ~/docs-ref-services/preview/mgmt-communication-readme.md + children: + - azure.mgmt.communication + - name: Compute Fleet + href: ~/docs-ref-services/preview/compute-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Compute Fleet + href: ~/docs-ref-services/preview/mgmt-computefleet-readme.md + children: + - azure.mgmt.computefleet + - name: Computeschedule + href: ~/docs-ref-services/preview/computeschedule.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Computeschedule + href: ~/docs-ref-services/preview/mgmt-computeschedule-readme.md + children: + - azure.mgmt.computeschedule + - name: Confidential Ledger + href: ~/docs-ref-services/preview/confidential-ledger.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Confidential Ledger + href: ~/docs-ref-services/preview/mgmt-confidentialledger-readme.md + children: + - azure.mgmt.confidentialledger + - name: Confluent + href: ~/docs-ref-services/preview/confluent.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Confluent + href: ~/docs-ref-services/preview/mgmt-confluent-readme.md + children: + - azure.mgmt.confluent + - name: Connected VMware + href: ~/docs-ref-services/preview/connected-vmware.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Connected VMware + href: ~/docs-ref-services/preview/mgmt-connectedvmware-readme.md + children: + - azure.mgmt.connectedvmware + - name: Connectedcache + href: ~/docs-ref-services/preview/connectedcache.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Connectedcache + href: ~/docs-ref-services/preview/mgmt-connectedcache-readme.md + children: + - azure.mgmt.connectedcache + - name: Consumption + href: ~/docs-ref-services/preview/consumption.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Consumption + href: ~/docs-ref-services/preview/mgmt-consumption-readme.md + children: + - azure.mgmt.consumption + - name: Container Apps + href: ~/docs-ref-services/preview/container-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Apps + href: ~/docs-ref-services/preview/mgmt-appcontainers-readme.md + children: + - azure.mgmt.appcontainers + - name: Container Instances + href: ~/docs-ref-services/preview/container-instances.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Instances + href: ~/docs-ref-services/preview/mgmt-containerinstance-readme.md + children: + - azure.mgmt.containerinstance + - name: Container Service Fleet + href: ~/docs-ref-services/preview/container-service-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Service Fleet + href: ~/docs-ref-services/preview/mgmt-containerservicefleet-readme.md + children: + - azure.mgmt.containerservicefleet + - name: Containerorchestratorruntime + href: ~/docs-ref-services/preview/containerorchestratorruntime.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Containerorchestratorruntime + href: ~/docs-ref-services/preview/mgmt-containerorchestratorruntime-readme.md + children: + - azure.mgmt.containerorchestratorruntime + - name: Content Delivery Network + href: ~/docs-ref-services/preview/content-delivery-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Content Delivery Network + href: ~/docs-ref-services/preview/mgmt-cdn-readme.md + children: + - azure.mgmt.cdn + - name: Core + href: ~/docs-ref-services/preview/core.md + landingPageType: Service + items: + - name: Core Tracing Opencensus + href: ~/docs-ref-services/preview/core-tracing-opencensus-readme.md + children: + - azure.core.tracing.ext.opencensus_span + - name: Cosmos DB + href: ~/docs-ref-services/preview/cosmos-db.md + landingPageType: Service + items: + - name: Cosmos DB + href: ~/docs-ref-services/preview/cosmos-readme.md + children: + - azure.cosmos + - name: Management + items: + - name: Resource Management - Cosmos DB + href: ~/docs-ref-services/preview/mgmt-cosmosdb-readme.md + children: + - azure.mgmt.cosmosdb + - name: Cosmos DB for PostgreSQL + href: ~/docs-ref-services/preview/cosmos-db-for-postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Cosmos DB for PostgreSQL + href: ~/docs-ref-services/preview/mgmt-cosmosdbforpostgresql-readme.md + children: + - azure.mgmt.cosmosdbforpostgresql + - name: Custom Image Search + href: ~/docs-ref-services/preview/custom-image-search.md + landingPageType: Service + items: + - name: Custom Image Search (deprecated) + href: ~/docs-ref-services/preview/cognitiveservices-search-customimagesearch-readme.md + children: + - azure.cognitiveservices.search.customimagesearch + - name: Custom Providers + href: ~/docs-ref-services/preview/custom-providers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Custom Providers + href: ~/docs-ref-services/preview/mgmt-customproviders-readme.md + children: + - azure.mgmt.customproviders + - name: Custom Search + href: ~/docs-ref-services/preview/custom-search.md + landingPageType: Service + items: + - name: Custom Search (deprecated) + href: ~/docs-ref-services/preview/cognitiveservices-search-customsearch-readme.md + children: + - azure.cognitiveservices.search.customsearch + - name: Data Box Edge + href: ~/docs-ref-services/preview/data-box-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Box Edge + href: ~/docs-ref-services/preview/mgmt-databoxedge-readme.md + children: + - azure.mgmt.databoxedge + - name: Data Share + href: ~/docs-ref-services/preview/data-share.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Share + href: ~/docs-ref-services/preview/mgmt-datashare-readme.md + children: + - azure.mgmt.datashare + - name: Database Migration Service + href: ~/docs-ref-services/preview/database-migration-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Migration + href: ~/docs-ref-services/preview/mgmt-datamigration-readme.md + children: + - azure.mgmt.datamigration + - name: Databasewatcher + href: ~/docs-ref-services/preview/databasewatcher.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Databasewatcher + href: ~/docs-ref-services/preview/mgmt-databasewatcher-readme.md + children: + - azure.mgmt.databasewatcher + - name: Datadog + href: ~/docs-ref-services/preview/datadog.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Datadog + href: ~/docs-ref-services/preview/mgmt-datadog-readme.md + children: + - azure.mgmt.datadog + - name: Defender EASM + href: ~/docs-ref-services/preview/defender-easm.md + landingPageType: Service + items: + - name: Defender EASM + href: ~/docs-ref-services/preview/defender-easm-readme.md + children: + - azure.defender.easm + - name: Management + items: + - name: Resource Management - Defender EASM + href: ~/docs-ref-services/preview/mgmt-defendereasm-readme.md + children: + - azure.mgmt.defendereasm + - name: Deployment Manager + href: ~/docs-ref-services/preview/deployment-manager.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Deployment Manager + href: ~/docs-ref-services/preview/mgmt-deploymentmanager-readme.md + children: + - azure.mgmt.deploymentmanager + - name: Dev Center + href: ~/docs-ref-services/preview/dev-center.md + landingPageType: Service + items: + - name: Dev Center + href: ~/docs-ref-services/preview/developer-devcenter-readme.md + children: + - azure.developer.devcenter + - name: Management + items: + - name: Resource Management - Dev Center + href: ~/docs-ref-services/preview/mgmt-devcenter-readme.md + children: + - azure.mgmt.devcenter + - name: Dev Spaces + href: ~/docs-ref-services/preview/dev-spaces.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Dev Spaces + href: ~/docs-ref-services/preview/mgmt-devspaces-readme.md + children: + - azure.mgmt.devspaces + - name: Device Registry + href: ~/docs-ref-services/preview/device-registry.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Device Registry + href: ~/docs-ref-services/preview/mgmt-deviceregistry-readme.md + children: + - azure.mgmt.deviceregistry + - name: DevOps Infrastructure + href: ~/docs-ref-services/preview/devops-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevOps Infrastructure + href: ~/docs-ref-services/preview/mgmt-devopsinfrastructure-readme.md + children: + - azure.mgmt.devopsinfrastructure + - name: DevTest Labs + href: ~/docs-ref-services/preview/devtest-labs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevTest Labs + href: ~/docs-ref-services/preview/mgmt-devtestlabs-readme.md + children: + - azure.mgmt.devtestlabs + - name: DNS Resolver + href: ~/docs-ref-services/preview/dns-resolver.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DNS Resolver + href: ~/docs-ref-services/preview/mgmt-dnsresolver-readme.md + children: + - azure.mgmt.dnsresolver + - name: Edge Order + href: ~/docs-ref-services/preview/edge-order.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Order + href: ~/docs-ref-services/preview/mgmt-edgeorder-readme.md + children: + - azure.mgmt.edgeorder + - name: Edge Zones + href: ~/docs-ref-services/preview/edge-zones.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Zones + href: ~/docs-ref-services/preview/mgmt-edgezones-readme.md + children: + - azure.mgmt.edgezones + - name: Education + href: ~/docs-ref-services/preview/education.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Education + href: ~/docs-ref-services/preview/mgmt-education-readme.md + children: + - azure.mgmt.education + - name: Elastic + href: ~/docs-ref-services/preview/elastic.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic + href: ~/docs-ref-services/preview/mgmt-elastic-readme.md + children: + - azure.mgmt.elastic + - name: Elastic SAN + href: ~/docs-ref-services/preview/elastic-san.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic SAN + href: ~/docs-ref-services/preview/mgmt-elasticsan-readme.md + children: + - azure.mgmt.elasticsan + - name: Event Grid + href: ~/docs-ref-services/preview/event-grid.md + landingPageType: Service + items: + - name: Event Grid + href: ~/docs-ref-services/preview/eventgrid-readme.md + children: + - azure.eventgrid + - name: Management + items: + - name: Resource Management - Event Grid + href: ~/docs-ref-services/preview/mgmt-eventgrid-readme.md + children: + - azure.mgmt.eventgrid + - name: Event Hubs + href: ~/docs-ref-services/preview/event-hubs.md + landingPageType: Service + items: + - name: Event Hubs + href: ~/docs-ref-services/preview/eventhub-readme.md + children: + - azure.eventhub + - name: Extended Location + href: ~/docs-ref-services/preview/extended-location.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Extended Location + href: ~/docs-ref-services/preview/mgmt-extendedlocation-readme.md + children: + - azure.mgmt.extendedlocation + - name: Fabric + href: ~/docs-ref-services/preview/fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fabric + href: ~/docs-ref-services/preview/mgmt-fabric-readme.md + children: + - azure.mgmt.fabric + - name: FarmBeats + href: ~/docs-ref-services/preview/farmbeats.md + landingPageType: Service + items: + - name: FarmBeats + href: ~/docs-ref-services/preview/agrifood-farming-readme.md + children: + - azure.agrifood.farming + - name: Fluid Relay + href: ~/docs-ref-services/preview/fluid-relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fluid Relay + href: ~/docs-ref-services/preview/mgmt-fluidrelay-readme.md + children: + - azure.mgmt.fluidrelay + - name: Grafana + href: ~/docs-ref-services/preview/grafana.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Grafana + href: ~/docs-ref-services/preview/mgmt-dashboard-readme.md + children: + - azure.mgmt.dashboard + - name: Guest Configuration + href: ~/docs-ref-services/preview/guest-configuration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Guest Configuration + href: ~/docs-ref-services/preview/mgmt-guestconfig-readme.md + children: + - azure.mgmt.guestconfig + - name: HANA on Azure + href: ~/docs-ref-services/preview/hana-on-azure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HANA on Azure + href: ~/docs-ref-services/preview/mgmt-hanaonazure-readme.md + children: + - azure.mgmt.hanaonazure + - name: Hardware Security Modules + href: ~/docs-ref-services/preview/hardware-security-modules.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hardware Security Modules + href: ~/docs-ref-services/preview/mgmt-hardwaresecuritymodules-readme.md + children: + - azure.mgmt.hardwaresecuritymodules + - name: HDInsight + href: ~/docs-ref-services/preview/hdinsight.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HDInsight + href: ~/docs-ref-services/preview/mgmt-hdinsight-readme.md + children: + - azure.mgmt.hdinsight + - name: HDInsight Containers + href: ~/docs-ref-services/preview/hdinsight-containers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HDInsight Containers + href: ~/docs-ref-services/preview/mgmt-hdinsightcontainers-readme.md + children: + - azure.mgmt.hdinsightcontainers + - name: Health Bot + href: ~/docs-ref-services/preview/health-bot.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Health Bot + href: ~/docs-ref-services/preview/mgmt-healthbot-readme.md + children: + - azure.mgmt.healthbot + - name: Health Data AI Services + href: ~/docs-ref-services/preview/health-data-ai-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Health Data AI Services + href: ~/docs-ref-services/preview/mgmt-healthdataaiservices-readme.md + children: + - azure.mgmt.healthdataaiservices + - name: Health Deidentification + href: ~/docs-ref-services/preview/health-deidentification.md + landingPageType: Service + items: + - name: Health Deidentification + href: ~/docs-ref-services/preview/health-deidentification-readme.md + children: + - azure.health.deidentification + - name: Healthcare APIs + href: ~/docs-ref-services/preview/healthcare-apis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Healthcare APIs + href: ~/docs-ref-services/preview/mgmt-healthcareapis-readme.md + children: + - azure.mgmt.healthcareapis + - name: Hybrid Compute + href: ~/docs-ref-services/preview/hybrid-compute.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Compute + href: ~/docs-ref-services/preview/mgmt-hybridcompute-readme.md + children: + - azure.mgmt.hybridcompute + - name: Hybrid Container Service + href: ~/docs-ref-services/preview/hybrid-container-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Container Service + href: ~/docs-ref-services/preview/mgmt-hybridcontainerservice-readme.md + children: + - azure.mgmt.hybridcontainerservice + - name: Hybrid Kubernetes + href: ~/docs-ref-services/preview/hybrid-kubernetes.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Kubernetes + href: ~/docs-ref-services/preview/mgmt-hybridkubernetes-readme.md + children: + - azure.mgmt.hybridkubernetes + - name: Hybrid Network + href: ~/docs-ref-services/preview/hybrid-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Network + href: ~/docs-ref-services/preview/mgmt-hybridnetwork-readme.md + children: + - azure.mgmt.hybridnetwork + - name: Identity + href: ~/docs-ref-services/preview/identity.md + landingPageType: Service + items: + - name: Identity + href: ~/docs-ref-services/preview/identity-readme.md + children: + - azure.identity + - name: Identity Broker + href: ~/docs-ref-services/preview/identity-broker-readme.md + children: + - azure.identity.broker + - name: Impactreporting + href: ~/docs-ref-services/preview/impactreporting.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Impactreporting + href: ~/docs-ref-services/preview/mgmt-impactreporting-readme.md + children: + - azure.mgmt.impactreporting + - name: Informatica Data Management + href: ~/docs-ref-services/preview/informatica-data-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Informatica Data Management + href: ~/docs-ref-services/preview/mgmt-informaticadatamanagement-readme.md + children: + - azure.mgmt.informaticadatamanagement + - name: IoT + href: ~/docs-ref-services/preview/iot.md + landingPageType: Service + items: + - name: IoT Device + children: + - azure.iot.device + landingPageType: Service + - name: Device Provisioning Services + href: ~/docs-ref-services/preview/iot-deviceprovisioning-readme.md + children: + - azure.iot.deviceprovisioning + - name: Management + items: + - name: Resource Management - Device Update + href: ~/docs-ref-services/preview/mgmt-deviceupdate-readme.md + children: + - azure.mgmt.deviceupdate + - name: Resource Management - IoT Central + href: ~/docs-ref-services/preview/mgmt-iotcentral-readme.md + children: + - azure.mgmt.iotcentral + - name: Resource Management - IoT Firmware Defense + href: ~/docs-ref-services/preview/mgmt-iotfirmwaredefense-readme.md + children: + - azure.mgmt.iotfirmwaredefense + - name: Resource Management - Device Provisioning Services + href: ~/docs-ref-services/preview/mgmt-iothubprovisioningservices-readme.md + children: + - azure.mgmt.iothubprovisioningservices + - name: Resource Management - Time Series Insights + href: ~/docs-ref-services/preview/mgmt-timeseriesinsights-readme.md + children: + - azure.mgmt.timeseriesinsights + - name: Iotoperations + href: ~/docs-ref-services/preview/iotoperations.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Iotoperations + href: ~/docs-ref-services/preview/mgmt-iotoperations-readme.md + children: + - azure.mgmt.iotoperations + - name: Key Vault + href: ~/docs-ref-services/preview/key-vault.md + landingPageType: Service + items: + - name: Key Vault - Administration + href: ~/docs-ref-services/preview/keyvault-administration-readme.md + children: + - azure.keyvault.administration + - name: Key Vault - Certificates + href: ~/docs-ref-services/preview/keyvault-certificates-readme.md + children: + - azure.keyvault.certificates + - name: Key Vault - Keys + href: ~/docs-ref-services/preview/keyvault-keys-readme.md + children: + - azure.keyvault.keys + - name: Key Vault - Secrets + href: ~/docs-ref-services/preview/keyvault-secrets-readme.md + children: + - azure.keyvault.secrets + - name: Lab Services + href: ~/docs-ref-services/preview/lab-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Lab Services + href: ~/docs-ref-services/preview/mgmt-labservices-readme.md + children: + - azure.mgmt.labservices + - name: Large Instance + href: ~/docs-ref-services/preview/large-instance.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Large Instance + href: ~/docs-ref-services/preview/mgmt-largeinstance-readme.md + children: + - azure.mgmt.largeinstance + - name: Log Analytics + href: ~/docs-ref-services/preview/log-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Log Analytics + href: ~/docs-ref-services/preview/mgmt-loganalytics-readme.md + children: + - azure.mgmt.loganalytics + - name: Logic Apps + href: ~/docs-ref-services/preview/logic-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logic Apps + href: ~/docs-ref-services/preview/mgmt-logic-readme.md + children: + - azure.mgmt.logic + - name: Logz + href: ~/docs-ref-services/preview/logz.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logz (deprecated) + children: + - azure.mgmt.logz + landingPageType: Service + - name: Machine Learning + href: ~/docs-ref-services/preview/machine-learning.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Machine Learning Compute + href: ~/docs-ref-services/preview/mgmt-machinelearningcompute-readme.md + children: + - azure.mgmt.machinelearningcompute + - name: Resource Management - Machine Learning Services + href: ~/docs-ref-services/preview/mgmt-machinelearningservices-readme.md + children: + - azure.mgmt.machinelearningservices + - name: Maintenance + href: ~/docs-ref-services/preview/maintenance.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Maintenance + href: ~/docs-ref-services/preview/mgmt-maintenance-readme.md + children: + - azure.mgmt.maintenance + - name: Managed Applications + href: ~/docs-ref-services/preview/managed-applications.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Applications + href: ~/docs-ref-services/preview/mgmt-managedapplications-readme.md + children: + - azure.mgmt.managedapplications + - name: Managed Service Identity + href: ~/docs-ref-services/preview/managed-service-identity.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Service Identity + href: ~/docs-ref-services/preview/mgmt-msi-readme.md + children: + - azure.mgmt.msi + - name: Managed Services + href: ~/docs-ref-services/preview/managed-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Services + href: ~/docs-ref-services/preview/mgmt-managedservices-readme.md + children: + - azure.mgmt.managedservices + - name: Management Groups + href: ~/docs-ref-services/preview/management-groups.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Groups + href: ~/docs-ref-services/preview/mgmt-managementgroups-readme.md + children: + - azure.mgmt.managementgroups + - name: Management Partner + href: ~/docs-ref-services/preview/management-partner.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Partner + href: ~/docs-ref-services/preview/mgmt-managementpartner-readme.md + children: + - azure.mgmt.managementpartner + - name: Maps + href: ~/docs-ref-services/preview/maps.md + landingPageType: Service + items: + - name: Maps Geolocation + href: ~/docs-ref-services/preview/maps-geolocation-readme.md + children: + - azure.maps.geolocation + - name: Maps Render + href: ~/docs-ref-services/preview/maps-render-readme.md + children: + - azure.maps.render + - name: Maps Route + href: ~/docs-ref-services/preview/maps-route-readme.md + children: + - azure.maps.route + - name: Maps Search + href: ~/docs-ref-services/preview/maps-search-readme.md + children: + - azure.maps.search + - name: Marketplace Ordering + href: ~/docs-ref-services/preview/marketplace-ordering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Marketplace Ordering + href: ~/docs-ref-services/preview/mgmt-marketplaceordering-readme.md + children: + - azure.mgmt.marketplaceordering + - name: Media + href: ~/docs-ref-services/preview/media.md + landingPageType: Service + items: + - name: Media Analytics Edge + href: ~/docs-ref-services/preview/media-analytics-edge-readme.md + children: + - azure.media.analyticsedge + - name: Migration + href: ~/docs-ref-services/preview/migration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Migration Discovery SAP + href: ~/docs-ref-services/preview/mgmt-migrationdiscoverysap-readme.md + children: + - azure.mgmt.migrationdiscoverysap + - name: Migrationassessment + href: ~/docs-ref-services/preview/migrationassessment.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Migrationassessment + href: ~/docs-ref-services/preview/mgmt-migrationassessment-readme.md + children: + - azure.mgmt.migrationassessment + - name: Mixed Reality + href: ~/docs-ref-services/preview/mixed-reality.md + landingPageType: Service + items: + - name: Mixed Reality Authentication + href: ~/docs-ref-services/preview/mixedreality-authentication-readme.md + children: + - azure.mixedreality.authentication + - name: Management + items: + - name: Resource Management - Mixed Reality + href: ~/docs-ref-services/preview/mgmt-mixedreality-readme.md + children: + - azure.mgmt.mixedreality + - name: Mongo Cluster + href: ~/docs-ref-services/preview/mongo-cluster.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mongo Cluster + href: ~/docs-ref-services/preview/mgmt-mongocluster-readme.md + children: + - azure.mgmt.mongocluster + - name: Monitor + href: ~/docs-ref-services/preview/monitor.md + landingPageType: Service + items: + - name: OpenTelemetry Exporter + href: ~/docs-ref-services/preview/monitor-opentelemetry-exporter-readme.md + children: + - azure.monitor.opentelemetry.exporter + - name: Monitor Query + href: ~/docs-ref-services/preview/monitor-query-readme.md + children: + - azure.monitor.query + - name: Management + items: + - name: Resource Management - Monitor + href: ~/docs-ref-services/preview/mgmt-monitor-readme.md + children: + - azure.mgmt.monitor + - name: Mysqlflexibleservers + href: ~/docs-ref-services/preview/mysqlflexibleservers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mysqlflexibleservers + href: ~/docs-ref-services/preview/mgmt-mysqlflexibleservers-readme.md + children: + - azure.mgmt.mysqlflexibleservers + - name: Neonpostgres + href: ~/docs-ref-services/preview/neonpostgres.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Neonpostgres + href: ~/docs-ref-services/preview/mgmt-neonpostgres-readme.md + children: + - azure.mgmt.neonpostgres + - name: NetApp Files + href: ~/docs-ref-services/preview/netapp-files.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - NetApp Files + href: ~/docs-ref-services/preview/mgmt-netapp-readme.md + children: + - azure.mgmt.netapp + - name: Network Analytics + href: ~/docs-ref-services/preview/network-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Analytics (deprecated) + children: + - azure.mgmt.networkanalytics + landingPageType: Service + - name: Network Function + href: ~/docs-ref-services/preview/network-function.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Function + href: ~/docs-ref-services/preview/mgmt-networkfunction-readme.md + children: + - azure.mgmt.networkfunction + - name: Nginx + href: ~/docs-ref-services/preview/nginx.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Nginx + href: ~/docs-ref-services/preview/mgmt-nginx-readme.md + children: + - azure.mgmt.nginx + - name: Notification Hubs + href: ~/docs-ref-services/preview/notification-hubs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Notification Hubs + href: ~/docs-ref-services/preview/mgmt-notificationhubs-readme.md + children: + - azure.mgmt.notificationhubs + - name: Oep + href: ~/docs-ref-services/preview/oep.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Oep + href: ~/docs-ref-services/preview/mgmt-oep-readme.md + children: + - azure.mgmt.oep + - name: Operations Management + href: ~/docs-ref-services/preview/operations-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Operations Management + href: ~/docs-ref-services/preview/mgmt-operationsmanagement-readme.md + children: + - azure.mgmt.operationsmanagement + - name: Operator Nexus - Network Cloud + href: ~/docs-ref-services/preview/operator-nexus---network-cloud.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Networkcloud + href: ~/docs-ref-services/preview/mgmt-networkcloud-readme.md + children: + - azure.mgmt.networkcloud + - name: Oracle Database + href: ~/docs-ref-services/preview/oracle-database.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Oracle Database + href: ~/docs-ref-services/preview/mgmt-oracledatabase-readme.md + children: + - azure.mgmt.oracledatabase + - name: Palo Alto Networks + href: ~/docs-ref-services/preview/palo-alto-networks.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Palo Alto Networks - Next Generation Firewall + href: ~/docs-ref-services/preview/mgmt-paloaltonetworksngfw-readme.md + children: + - azure.mgmt.paloaltonetworksngfw + - name: Peering + href: ~/docs-ref-services/preview/peering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Peering + href: ~/docs-ref-services/preview/mgmt-peering-readme.md + children: + - azure.mgmt.peering + - name: Pineconevectordb + href: ~/docs-ref-services/preview/pineconevectordb.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Pineconevectordb + href: ~/docs-ref-services/preview/mgmt-pineconevectordb-readme.md + children: + - azure.mgmt.pineconevectordb + - name: Playwright Testing + href: ~/docs-ref-services/preview/playwright-testing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Playwright Testing + href: ~/docs-ref-services/preview/mgmt-playwrighttesting-readme.md + children: + - azure.mgmt.playwrighttesting + - name: Policy Insights + href: ~/docs-ref-services/preview/policy-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Policy Insights + href: ~/docs-ref-services/preview/mgmt-policyinsights-readme.md + children: + - azure.mgmt.policyinsights + - name: Portal + href: ~/docs-ref-services/preview/portal.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Portal + href: ~/docs-ref-services/preview/mgmt-portal-readme.md + children: + - azure.mgmt.portal + - name: PostgreSQL + href: ~/docs-ref-services/preview/postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - PostgreSQL + href: ~/docs-ref-services/preview/mgmt-rdbms-readme.md + children: + - azure.mgmt.rdbms + - name: Postgresqlflexibleservers + href: ~/docs-ref-services/preview/postgresqlflexibleservers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Postgresqlflexibleservers + href: ~/docs-ref-services/preview/mgmt-postgresqlflexibleservers-readme.md + children: + - azure.mgmt.postgresqlflexibleservers + - name: Power BI Dedicated + href: ~/docs-ref-services/preview/power-bi-dedicated.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Power BI Dedicated + href: ~/docs-ref-services/preview/mgmt-powerbidedicated-readme.md + children: + - azure.mgmt.powerbidedicated + - name: Purview + href: ~/docs-ref-services/preview/purview.md + landingPageType: Service + items: + - name: Purview Account + href: ~/docs-ref-services/preview/purview-account-readme.md + children: + - azure.purview.account + - name: Purview Administration + href: ~/docs-ref-services/preview/purview-administration-readme.md + children: + - azure.purview.administration + - name: Purview Data Map + href: ~/docs-ref-services/preview/purview-datamap-readme.md + children: + - azure.purview.datamap + - name: Purview Scanning + href: ~/docs-ref-services/preview/purview-scanning-readme.md + children: + - azure.purview.scanning + - name: Purview Sharing + href: ~/docs-ref-services/preview/purview-sharing-readme.md + children: + - azure.purview.sharing + - name: Purview Workflow + href: ~/docs-ref-services/preview/purview-workflow-readme.md + children: + - azure.purview.workflow + - name: Management + items: + - name: Resource Management - Purview + href: ~/docs-ref-services/preview/mgmt-purview-readme.md + children: + - azure.mgmt.purview + - name: Quantum + href: ~/docs-ref-services/preview/quantum.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Quantum + href: ~/docs-ref-services/preview/mgmt-quantum-readme.md + children: + - azure.mgmt.quantum + - name: Quota + href: ~/docs-ref-services/preview/quota.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Quota + href: ~/docs-ref-services/preview/mgmt-quota-readme.md + children: + - azure.mgmt.quota + - name: Recovery Services + href: ~/docs-ref-services/preview/recovery-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Recovery Services Data Replication + href: ~/docs-ref-services/preview/mgmt-recoveryservicesdatareplication-readme.md + children: + - azure.mgmt.recoveryservicesdatareplication + - name: Redis + href: ~/docs-ref-services/preview/redis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Redis Enterprise + href: ~/docs-ref-services/preview/mgmt-redisenterprise-readme.md + children: + - azure.mgmt.redisenterprise + - name: Relay + href: ~/docs-ref-services/preview/relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Relay + href: ~/docs-ref-services/preview/mgmt-relay-readme.md + children: + - azure.mgmt.relay + - name: Resource Graph + href: ~/docs-ref-services/preview/resource-graph.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Graph + href: ~/docs-ref-services/preview/mgmt-resourcegraph-readme.md + children: + - azure.mgmt.resourcegraph + - name: Resource Health + href: ~/docs-ref-services/preview/resource-health.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Health + href: ~/docs-ref-services/preview/mgmt-resourcehealth-readme.md + children: + - azure.mgmt.resourcehealth + - name: Resource Mover + href: ~/docs-ref-services/preview/resource-mover.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Mover + href: ~/docs-ref-services/preview/mgmt-resourcemover-readme.md + children: + - azure.mgmt.resourcemover + - name: Resources + href: ~/docs-ref-services/preview/resources.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resources + href: ~/docs-ref-services/preview/mgmt-resource-readme.md + children: + - azure.mgmt.resource + - name: Scheduler + href: ~/docs-ref-services/preview/scheduler.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scheduler (deprecated) + children: + - azure.mgmt.scheduler + landingPageType: Service + - name: Schema Registry + href: ~/docs-ref-services/preview/schema-registry.md + landingPageType: Service + items: + - name: Schema Registry + href: ~/docs-ref-services/preview/schemaregistry-readme.md + children: + - azure.schemaregistry + - name: Schema Registry - Avro (deprecated) + href: ~/docs-ref-services/preview/schemaregistry-avroserializer-readme.md + children: + - azure.schemaregistry.serializer + - name: Scvmm + href: ~/docs-ref-services/preview/scvmm.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scvmm + href: ~/docs-ref-services/preview/mgmt-scvmm-readme.md + children: + - azure.mgmt.scvmm + - name: Search + href: ~/docs-ref-services/preview/search.md + landingPageType: Service + items: + - name: Azure AI Search + href: ~/docs-ref-services/preview/search-documents-readme.md + children: + - azure.search.documents + - name: Management + items: + - name: Resource Management - Azure AI Search + href: ~/docs-ref-services/preview/mgmt-search-readme.md + children: + - azure.mgmt.search + - name: Security DevOps + href: ~/docs-ref-services/preview/security-devops.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security DevOps + href: ~/docs-ref-services/preview/mgmt-securitydevops-readme.md + children: + - azure.mgmt.securitydevops + - name: Security Insights + href: ~/docs-ref-services/preview/security-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security Insights + href: ~/docs-ref-services/preview/mgmt-securityinsight-readme.md + children: + - azure.mgmt.securityinsight + - name: Self Help + href: ~/docs-ref-services/preview/self-help.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Self Help + href: ~/docs-ref-services/preview/mgmt-selfhelp-readme.md + children: + - azure.mgmt.selfhelp + - name: Serial Console + href: ~/docs-ref-services/preview/serial-console.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Serial Console + href: ~/docs-ref-services/preview/mgmt-serialconsole-readme.md + children: + - azure.mgmt.serialconsole + - name: Service Bus + href: ~/docs-ref-services/preview/service-bus.md + landingPageType: Service + items: + - name: Service Bus + href: ~/docs-ref-services/preview/servicebus-readme.md + children: + - azure.servicebus + - name: Service Fabric + href: ~/docs-ref-services/preview/service-fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Fabric + href: ~/docs-ref-services/preview/mgmt-servicefabric-readme.md + children: + - azure.mgmt.servicefabric + - name: Resource Management - Service Fabric Managed Clusters + href: ~/docs-ref-services/preview/mgmt-servicefabricmanagedclusters-readme.md + children: + - azure.mgmt.servicefabricmanagedclusters + - name: Service Linker + href: ~/docs-ref-services/preview/service-linker.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Linker + href: ~/docs-ref-services/preview/mgmt-servicelinker-readme.md + children: + - azure.mgmt.servicelinker + - name: Service Networking + href: ~/docs-ref-services/preview/service-networking.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Networking + href: ~/docs-ref-services/preview/mgmt-servicenetworking-readme.md + children: + - azure.mgmt.servicenetworking + - name: SignalR + href: ~/docs-ref-services/preview/signalr.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SignalR + href: ~/docs-ref-services/preview/mgmt-signalr-readme.md + children: + - azure.mgmt.signalr + - name: Sphere + href: ~/docs-ref-services/preview/sphere.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Sphere + href: ~/docs-ref-services/preview/mgmt-sphere-readme.md + children: + - azure.mgmt.sphere + - name: Spring App Discovery + href: ~/docs-ref-services/preview/spring-app-discovery.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Spring App Discovery + href: ~/docs-ref-services/preview/mgmt-springappdiscovery-readme.md + children: + - azure.mgmt.springappdiscovery + - name: SQL + href: ~/docs-ref-services/preview/sql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SQL + href: ~/docs-ref-services/preview/mgmt-sql-readme.md + children: + - azure.mgmt.sql + - name: SQL Virtual Machine + href: ~/docs-ref-services/preview/sql-virtual-machine.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SQL Virtual Machine + href: ~/docs-ref-services/preview/mgmt-sqlvirtualmachine-readme.md + children: + - azure.mgmt.sqlvirtualmachine + - name: Standby Pool + href: ~/docs-ref-services/preview/standby-pool.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Standby Pool + href: ~/docs-ref-services/preview/mgmt-standbypool-readme.md + children: + - azure.mgmt.standbypool + - name: Storage + href: ~/docs-ref-services/preview/storage.md + landingPageType: Service + items: + - name: Storage - Blobs + href: ~/docs-ref-services/preview/storage-blob-readme.md + children: + - azure.storage.blob + - name: Storage - Blobs Changefeed + href: ~/docs-ref-services/preview/storage-blob-changefeed-readme.md + children: + - azure.storage.blob.changefeed + - name: Storage - Files Data Lake + href: ~/docs-ref-services/preview/storage-file-datalake-readme.md + children: + - azure.storage.filedatalake + - name: Storage - Files Share + href: ~/docs-ref-services/preview/storage-file-share-readme.md + children: + - azure.storage.fileshare + - name: Storage - Queues + href: ~/docs-ref-services/preview/storage-queue-readme.md + children: + - azure.storage.queue + - name: Management + items: + - name: Resource Management - Data Lake Analytics + href: ~/docs-ref-services/preview/mgmt-datalake-analytics-readme.md + children: + - azure.mgmt.datalake.analytics + - name: Resource Management - Data Lake Store + href: ~/docs-ref-services/preview/mgmt-datalake-store-readme.md + children: + - azure.mgmt.datalake.store + - name: Resource Management - Storage Actions + href: ~/docs-ref-services/preview/mgmt-storageactions-readme.md + children: + - azure.mgmt.storageactions + - name: Resource Management - Storage Cache + href: ~/docs-ref-services/preview/mgmt-storagecache-readme.md + children: + - azure.mgmt.storagecache + - name: Resource Management - Storage Mover + href: ~/docs-ref-services/preview/mgmt-storagemover-readme.md + children: + - azure.mgmt.storagemover + - name: Resource Management - Storage Pool + href: ~/docs-ref-services/preview/mgmt-storagepool-readme.md + children: + - azure.mgmt.storagepool + - name: Resource Management - Storage Sync + href: ~/docs-ref-services/preview/mgmt-storagesync-readme.md + children: + - azure.mgmt.storagesync + - name: Stream Analytics + href: ~/docs-ref-services/preview/stream-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Stream Analytics + href: ~/docs-ref-services/preview/mgmt-streamanalytics-readme.md + children: + - azure.mgmt.streamanalytics + - name: Subscriptions + href: ~/docs-ref-services/preview/subscriptions.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Subscriptions + href: ~/docs-ref-services/preview/mgmt-subscription-readme.md + children: + - azure.mgmt.subscription + - name: Support + href: ~/docs-ref-services/preview/support.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Support + href: ~/docs-ref-services/preview/mgmt-support-readme.md + children: + - azure.mgmt.support + - name: Synapse + href: ~/docs-ref-services/preview/synapse.md + landingPageType: Service + items: + - name: Synapse - AccessControl + href: ~/docs-ref-services/preview/synapse-accesscontrol-readme.md + children: + - azure.synapse.accesscontrol + - name: Managed Private Endpoints + href: ~/docs-ref-services/preview/synapse-managedprivateendpoints-readme.md + children: + - azure.synapse.managedprivateendpoints + - name: Synapse - Monitoring + href: ~/docs-ref-services/preview/synapse-monitoring-readme.md + children: + - azure.synapse.monitoring + - name: Spark + href: ~/docs-ref-services/preview/synapse-spark-readme.md + children: + - azure.synapse.spark + - name: Management + items: + - name: Resource Management - Synapse + href: ~/docs-ref-services/preview/mgmt-synapse-readme.md + children: + - azure.mgmt.synapse + - name: Synapse Analytics + href: ~/docs-ref-services/preview/synapse-analytics.md + landingPageType: Service + items: + - name: Synapse - Artifacts + href: ~/docs-ref-services/preview/synapse-artifacts-readme.md + children: + - azure.synapse.artifacts + - name: Terraform + href: ~/docs-ref-services/preview/terraform.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Terraform + href: ~/docs-ref-services/preview/mgmt-terraform-readme.md + children: + - azure.mgmt.terraform + - name: Timezone + href: ~/docs-ref-services/preview/timezone.md + landingPageType: Service + items: + - name: Timezone + href: ~/docs-ref-services/preview/maps-timezone-readme.md + children: + - azure.maps.timezone + - name: Trustedsigning + href: ~/docs-ref-services/preview/trustedsigning.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Trustedsigning + href: ~/docs-ref-services/preview/mgmt-trustedsigning-readme.md + children: + - azure.mgmt.trustedsigning + - name: VMware Solution by CloudSimple + href: ~/docs-ref-services/preview/vmware-solution-by-cloudsimple.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - VMware Solution by CloudSimple + href: ~/docs-ref-services/preview/mgmt-vmwarecloudsimple-readme.md + children: + - azure.mgmt.vmwarecloudsimple + - name: Web PubSub + href: ~/docs-ref-services/preview/web-pubsub.md + landingPageType: Service + items: + - name: Web PubSub Client + href: ~/docs-ref-services/preview/messaging-webpubsubclient-readme.md + children: + - azure.messaging.webpubsubclient + - name: Web PubSub + href: ~/docs-ref-services/preview/messaging-webpubsubservice-readme.md + children: + - azure.messaging.webpubsubservice + - name: Management + items: + - name: Resource Management - Web PubSub + href: ~/docs-ref-services/preview/mgmt-webpubsub-readme.md + children: + - azure.mgmt.webpubsub + - name: Workloads + href: ~/docs-ref-services/preview/workloads.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workloads SAP Virtual Instance + href: ~/docs-ref-services/preview/mgmt-workloadssapvirtualinstance-readme.md + children: + - azure.mgmt.workloadssapvirtualinstance + - name: Other + landingPageType: Service + items: + - name: Core + landingPageType: Service + items: + - name: Client + landingPageType: Service + items: + - name: Core HTTP + href: ~/docs-ref-services/preview/corehttp-readme.md + children: + - corehttp + - name: Experimental + href: ~/docs-ref-services/preview/core-experimental-readme.md + children: + - azure.core.experimental + - name: Tracing Opentelemetry + href: ~/docs-ref-services/preview/core-tracing-opentelemetry-readme.md + children: + - azure.core.tracing.ext.opentelemetry_span + - name: Uncategorized Packages + landingPageType: Service + children: + - '**' diff --git a/docs-ref-mapping/reference-previous.yml b/docs-ref-mapping/reference-previous.yml new file mode 100644 index 00000000..573fd180 --- /dev/null +++ b/docs-ref-mapping/reference-previous.yml @@ -0,0 +1,275 @@ +- name: Reference + landingPageType: Root + expanded: false + items: + - name: Agrifood + href: ~/docs-ref-services/legacy/agrifood.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Agrifood (deprecated) + href: ~/docs-ref-services/legacy/mgmt-agfood-readme.md + children: + - azure.mgmt.agfood + - name: Application Insights + href: ~/docs-ref-services/legacy/application-insights.md + landingPageType: Service + items: + - name: Application Insights - Query (deprecated) + href: ~/docs-ref-services/legacy/applicationinsights-readme.md + children: + - azure.applicationinsights + - name: Azure AD B2C + href: ~/docs-ref-services/legacy/azure-ad-b2c.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure AD B2C (deprecated) + href: ~/docs-ref-services/legacy/mgmt-azureadb2c-readme.md + children: + - azure.mgmt.azureadb2c + - name: Batch AI + href: ~/docs-ref-services/legacy/batch-ai.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Batch AI (deprecated) + href: ~/docs-ref-services/legacy/mgmt-batchai-readme.md + children: + - azure.mgmt.batchai + - name: Cognitive Services + href: ~/docs-ref-services/legacy/cognitive-services.md + landingPageType: Service + items: + - name: Azure AI Vision SDK (deprecated) + children: + - azure.ai.vision + landingPageType: Service + - name: Anomaly Detector (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-anomalydetector-readme.md + children: + - azure.cognitiveservices.anomalydetector + - name: Question Answering (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-knowledge-qnamaker-readme.md + children: + - azure.cognitiveservices.knowledge.qnamaker + - name: Conversational Language Understanding (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-luis-readme.md + children: + - azure.cognitiveservices.language.luis + - name: Spell Check (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-spellcheck-readme.md + children: + - azure.cognitiveservices.language.spellcheck + - name: Text Analytics (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-textanalytics-readme.md + children: + - azure.cognitiveservices.language.textanalytics + - name: Computer Vision (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-computervision-readme.md + children: + - azure.cognitiveservices.vision.computervision + - name: Content Safety (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-contentmoderator-readme.md + children: + - azure.cognitiveservices.vision.contentmoderator + - name: Custom Vision (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-customvision-readme.md + children: + - azure.cognitiveservices.vision.customvision + - name: Communication + href: ~/docs-ref-services/legacy/communication.md + landingPageType: Service + items: + - name: Communication Network Traversal (deprecated) + href: ~/docs-ref-services/legacy/communication-networktraversal-readme.md + children: + - azure.communication.networktraversal + - name: Cosmos DB + href: ~/docs-ref-services/legacy/cosmos-db.md + landingPageType: Service + items: + - name: Cosmos DB + href: ~/docs-ref-services/legacy/cosmos-readme.md + children: + - azure.cosmos + - name: Face + href: ~/docs-ref-services/legacy/face.md + landingPageType: Service + items: + - name: Face (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-face-readme.md + children: + - azure.cognitiveservices.vision.face + - name: Graph RBAC + href: ~/docs-ref-services/legacy/graph-rbac.md + landingPageType: Service + items: + - name: Graph RBAC (deprecated) + href: ~/docs-ref-services/legacy/graphrbac-readme.md + children: + - azure.graphrbac + - name: IoT + href: ~/docs-ref-services/legacy/iot.md + landingPageType: Service + items: + - name: Models Repository (deprecated) + href: ~/docs-ref-services/legacy/iot-modelsrepository-readme.md + children: + - azure.iot.modelsrepository + - name: Key Vault + href: ~/docs-ref-services/legacy/key-vault.md + landingPageType: Service + items: + - name: Key Vault + children: + - azure.keyvault + landingPageType: Service + - name: Log Analytics + href: ~/docs-ref-services/legacy/log-analytics.md + landingPageType: Service + items: + - name: Log Analytics - Query (deprecated) + href: ~/docs-ref-services/legacy/loganalytics-readme.md + children: + - azure.loganalytics + - name: Logz + href: ~/docs-ref-services/legacy/logz.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logz (deprecated) + href: ~/docs-ref-services/legacy/mgmt-logz-readme.md + children: + - azure.mgmt.logz + - name: Metrics Advisor + href: ~/docs-ref-services/legacy/metrics-advisor.md + landingPageType: Service + items: + - name: Metrics Advisor (deprecated) + href: ~/docs-ref-services/legacy/ai-metricsadvisor-readme.md + children: + - azure.ai.metricsadvisor + - name: Network Analytics + href: ~/docs-ref-services/legacy/network-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Analytics (deprecated) + href: ~/docs-ref-services/legacy/mgmt-networkanalytics-readme.md + children: + - azure.mgmt.networkanalytics + - name: News Search + href: ~/docs-ref-services/legacy/news-search.md + landingPageType: Service + items: + - name: News Search (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-search-newssearch-readme.md + children: + - azure.cognitiveservices.search.newssearch + - name: Purview + href: ~/docs-ref-services/legacy/purview.md + landingPageType: Service + items: + - name: Purview Catalog (deprecated) + href: ~/docs-ref-services/legacy/purview-catalog-readme.md + children: + - azure.purview.catalog + - name: Scheduler + href: ~/docs-ref-services/legacy/scheduler.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scheduler (deprecated) + href: ~/docs-ref-services/legacy/mgmt-scheduler-readme.md + children: + - azure.mgmt.scheduler + - name: Stack Edge + href: ~/docs-ref-services/legacy/stack-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Gateway (deprecated) + children: + - azure.mgmt.edgegateway + landingPageType: Service + - name: Storage + href: ~/docs-ref-services/legacy/storage.md + landingPageType: Service + items: + - name: Storage - Blobs + href: ~/docs-ref-services/legacy/storage-blob-readme.md + children: + - azure.storage.blob + - name: Storage - Queues + href: ~/docs-ref-services/legacy/storage-queue-readme.md + children: + - azure.storage.queue + - name: Management + items: + - name: Resource Management - Storage Import/Export (deprecated) + href: ~/docs-ref-services/legacy/mgmt-storageimportexport-readme.md + children: + - azure.mgmt.storageimportexport + - name: Synapse + href: ~/docs-ref-services/legacy/synapse.md + landingPageType: Service + items: + - name: Synapse (deprecated) + href: ~/docs-ref-services/legacy/synapse-readme.md + children: + - azure.synapse + - name: Test Base + href: ~/docs-ref-services/legacy/test-base.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Test Base (deprecated) + href: ~/docs-ref-services/legacy/mgmt-testbase-readme.md + children: + - azure.mgmt.testbase + - name: Video Analyzer + href: ~/docs-ref-services/legacy/video-analyzer.md + landingPageType: Service + items: + - name: Video Analyzer Edge (deprecated) + href: ~/docs-ref-services/legacy/media-videoanalyzer-edge-readme.md + children: + - azure.media.videoanalyzeredge + - name: Visual Search + href: ~/docs-ref-services/legacy/visual-search.md + landingPageType: Service + items: + - name: Visual Search (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-search-visualsearch-readme.md + children: + - azure.cognitiveservices.search.visualsearch + - name: Workload Monitor + href: ~/docs-ref-services/legacy/workload-monitor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workload Monitor (deprecated) + href: ~/docs-ref-services/legacy/mgmt-workloadmonitor-readme.md + children: + - azure.mgmt.workloadmonitor + - name: Other + landingPageType: Service + items: + - name: Common (deprecated) + href: ~/docs-ref-services/legacy/common-readme.md + children: + - azure.common + - name: Uncategorized Packages + landingPageType: Service + children: + - '**' diff --git a/docs-ref-mapping/reference-unified.yml b/docs-ref-mapping/reference-unified.yml new file mode 100644 index 00000000..25a3467c --- /dev/null +++ b/docs-ref-mapping/reference-unified.yml @@ -0,0 +1,2722 @@ +- name: Reference + landingPageType: Root + expanded: false + items: + - name: Advisor + href: ~/docs-ref-services/{moniker}/advisor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Advisor + href: ~/docs-ref-services/{moniker}/mgmt-advisor-readme.md + children: + - azure.mgmt.advisor + - name: Agrifood + href: ~/docs-ref-services/{moniker}/agrifood.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Agrifood (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-agfood-readme.md + children: + - azure.mgmt.agfood + - name: Resource Management - Agrifood + href: ~/docs-ref-services/{moniker}/mgmt-agrifood-readme.md + children: + - azure.mgmt.agrifood + - name: AKS Developer Hub + href: ~/docs-ref-services/{moniker}/aks-developer-hub.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - AKS Developer Hub + href: ~/docs-ref-services/{moniker}/mgmt-devhub-readme.md + children: + - azure.mgmt.devhub + - name: Alerts Management + href: ~/docs-ref-services/{moniker}/alerts-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Alerts Management + href: ~/docs-ref-services/{moniker}/mgmt-alertsmanagement-readme.md + children: + - azure.mgmt.alertsmanagement + - name: API Center + href: ~/docs-ref-services/{moniker}/api-center.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - API Center + href: ~/docs-ref-services/{moniker}/mgmt-apicenter-readme.md + children: + - azure.mgmt.apicenter + - name: App Compliance Automation + href: ~/docs-ref-services/{moniker}/app-compliance-automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Compliance Automation + href: ~/docs-ref-services/{moniker}/mgmt-appcomplianceautomation-readme.md + children: + - azure.mgmt.appcomplianceautomation + - name: App Configuration + href: ~/docs-ref-services/{moniker}/app-configuration.md + landingPageType: Service + items: + - name: App Configuration + href: ~/docs-ref-services/{moniker}/appconfiguration-readme.md + children: + - azure.appconfiguration + - name: App Configuration Provider + href: ~/docs-ref-services/{moniker}/appconfiguration-provider-readme.md + children: + - azure.appconfiguration.provider + - name: Management + items: + - name: Resource Management - App Configuration + href: ~/docs-ref-services/{moniker}/mgmt-appconfiguration-readme.md + children: + - azure.mgmt.appconfiguration + - name: App Platform + href: ~/docs-ref-services/{moniker}/app-platform.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Platform + href: ~/docs-ref-services/{moniker}/mgmt-appplatform-readme.md + children: + - azure.mgmt.appplatform + - name: App Service + href: ~/docs-ref-services/{moniker}/app-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Service + href: ~/docs-ref-services/{moniker}/mgmt-web-readme.md + children: + - azure.mgmt.web + - name: Application Insights + href: ~/docs-ref-services/{moniker}/application-insights.md + landingPageType: Service + items: + - name: Application Insights - Query (deprecated) + href: ~/docs-ref-services/{moniker}/applicationinsights-readme.md + children: + - azure.applicationinsights + - name: Management + items: + - name: Resource Management - Application Insights + href: ~/docs-ref-services/{moniker}/mgmt-applicationinsights-readme.md + children: + - azure.mgmt.applicationinsights + - name: Arc Data + href: ~/docs-ref-services/{moniker}/arc-data.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Arc Data + href: ~/docs-ref-services/{moniker}/mgmt-azurearcdata-readme.md + children: + - azure.mgmt.azurearcdata + - name: Astro + href: ~/docs-ref-services/{moniker}/astro.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Astro + href: ~/docs-ref-services/{moniker}/mgmt-astro-readme.md + children: + - azure.mgmt.astro + - name: Attestation + href: ~/docs-ref-services/{moniker}/attestation.md + landingPageType: Service + items: + - name: Attestation + href: ~/docs-ref-services/{moniker}/security-attestation-readme.md + children: + - azure.security.attestation + - name: Management + items: + - name: Resource Management - Attestation + href: ~/docs-ref-services/{moniker}/mgmt-attestation-readme.md + children: + - azure.mgmt.attestation + - name: Authorization + href: ~/docs-ref-services/{moniker}/authorization.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Authorization + href: ~/docs-ref-services/{moniker}/mgmt-authorization-readme.md + children: + - azure.mgmt.authorization + - name: Auto Suggest + href: ~/docs-ref-services/{moniker}/auto-suggest.md + landingPageType: Service + items: + - name: Auto Suggest (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-autosuggest-readme.md + children: + - azure.cognitiveservices.search.autosuggest + - name: Automanage + href: ~/docs-ref-services/{moniker}/automanage.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automanage + href: ~/docs-ref-services/{moniker}/mgmt-automanage-readme.md + children: + - azure.mgmt.automanage + - name: Automation + href: ~/docs-ref-services/{moniker}/automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automation + href: ~/docs-ref-services/{moniker}/mgmt-automation-readme.md + children: + - azure.mgmt.automation + - name: Azure AD B2C + href: ~/docs-ref-services/{moniker}/azure-ad-b2c.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure AD B2C (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-azureadb2c-readme.md + children: + - azure.mgmt.azureadb2c + - name: Azure Remote Rendering + href: ~/docs-ref-services/{moniker}/azure-remote-rendering.md + landingPageType: Service + items: + - name: Azure Remote Rendering + href: ~/docs-ref-services/{moniker}/mixedreality-remoterendering-readme.md + children: + - azure.mixedreality.remoterendering + - name: Azure Stack + href: ~/docs-ref-services/{moniker}/azure-stack.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack + href: ~/docs-ref-services/{moniker}/mgmt-azurestack-readme.md + children: + - azure.mgmt.azurestack + - name: Azure Stack HCI + href: ~/docs-ref-services/{moniker}/azure-stack-hci.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack HCI + href: ~/docs-ref-services/{moniker}/mgmt-azurestackhci-readme.md + children: + - azure.mgmt.azurestackhci + - name: Azure VMware Solution + href: ~/docs-ref-services/{moniker}/azure-vmware-solution.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure VMware Solution + href: ~/docs-ref-services/{moniker}/mgmt-avs-readme.md + children: + - azure.mgmt.avs + - name: BareMetal Infrastructure + href: ~/docs-ref-services/{moniker}/baremetal-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - BareMetal Infrastructure + href: ~/docs-ref-services/{moniker}/mgmt-baremetalinfrastructure-readme.md + children: + - azure.mgmt.baremetalinfrastructure + - name: Batch + href: ~/docs-ref-services/{moniker}/batch.md + landingPageType: Service + items: + - name: Batch + href: ~/docs-ref-services/{moniker}/batch-readme.md + children: + - azure.batch + - name: Management + items: + - name: Resource Management - Batch + href: ~/docs-ref-services/{moniker}/mgmt-batch-readme.md + children: + - azure.mgmt.batch + - name: Batch AI + href: ~/docs-ref-services/{moniker}/batch-ai.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Batch AI (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-batchai-readme.md + children: + - azure.mgmt.batchai + - name: Billing + href: ~/docs-ref-services/{moniker}/billing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Billing + href: ~/docs-ref-services/{moniker}/mgmt-billing-readme.md + children: + - azure.mgmt.billing + - name: Billing Benefits + href: ~/docs-ref-services/{moniker}/billing-benefits.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Billing Benefits + href: ~/docs-ref-services/{moniker}/mgmt-billingbenefits-readme.md + children: + - azure.mgmt.billingbenefits + - name: Bot Service + href: ~/docs-ref-services/{moniker}/bot-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Bot Service + href: ~/docs-ref-services/{moniker}/mgmt-botservice-readme.md + children: + - azure.mgmt.botservice + - name: Change Analysis + href: ~/docs-ref-services/{moniker}/change-analysis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Change Analysis + href: ~/docs-ref-services/{moniker}/mgmt-changeanalysis-readme.md + children: + - azure.mgmt.changeanalysis + - name: Chaos + href: ~/docs-ref-services/{moniker}/chaos.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Chaos + href: ~/docs-ref-services/{moniker}/mgmt-chaos-readme.md + children: + - azure.mgmt.chaos + - name: Cognitive Services + href: ~/docs-ref-services/{moniker}/cognitive-services.md + landingPageType: Service + items: + - name: Anomaly Detector + href: ~/docs-ref-services/{moniker}/ai-anomalydetector-readme.md + children: + - azure.ai.anomalydetector + - name: Content Safety + href: ~/docs-ref-services/{moniker}/ai-contentsafety-readme.md + children: + - azure.ai.contentsafety + - name: Document Intelligence + href: ~/docs-ref-services/{moniker}/ai-documentintelligence-readme.md + children: + - azure.ai.documentintelligence + - name: AI Evaluation + href: ~/docs-ref-services/{moniker}/ai-evaluation-readme.md + children: + - azure.ai.evaluation + - name: Form Recognizer + href: ~/docs-ref-services/{moniker}/ai-formrecognizer-readme.md + children: + - azure.ai.formrecognizer + - name: AI Model Inference + href: ~/docs-ref-services/{moniker}/ai-inference-readme.md + children: + - azure.ai.inference + - name: Conversational Language Understanding + href: ~/docs-ref-services/{moniker}/ai-language-conversations-readme.md + children: + - azure.ai.language.conversations + - name: Question Answering + href: ~/docs-ref-services/{moniker}/ai-language-questionanswering-readme.md + children: + - azure.ai.language.questionanswering + - name: Personalizer + href: ~/docs-ref-services/{moniker}/ai-personalizer-readme.md + children: + - azure.ai.personalizer + - name: AI Projects + href: ~/docs-ref-services/{moniker}/ai-projects-readme.md + children: + - azure.ai.projects + - name: Text Analytics + href: ~/docs-ref-services/{moniker}/ai-textanalytics-readme.md + children: + - azure.ai.textanalytics + - name: Document Translation + href: ~/docs-ref-services/{moniker}/ai-translation-document-readme.md + children: + - azure.ai.translation.document + - name: Text Translation + href: ~/docs-ref-services/{moniker}/ai-translation-text-readme.md + children: + - azure.ai.translation.text + - name: Azure AI Vision SDK (deprecated) + href: ~/docs-ref-services/{moniker}/ai-vision-readme.md + children: + - azure.ai.vision + - name: Face + href: ~/docs-ref-services/{moniker}/ai-vision-face-readme.md + children: + - azure.ai.vision.face + - name: Image Analysis + href: ~/docs-ref-services/{moniker}/ai-vision-imageanalysis-readme.md + children: + - azure.ai.vision.imageanalysis + - name: Anomaly Detector (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-anomalydetector-readme.md + children: + - azure.cognitiveservices.anomalydetector + - name: Question Answering (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-knowledge-qnamaker-readme.md + children: + - azure.cognitiveservices.knowledge.qnamaker + - name: Conversational Language Understanding (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-language-luis-readme.md + children: + - azure.cognitiveservices.language.luis + - name: Spell Check (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-language-spellcheck-readme.md + children: + - azure.cognitiveservices.language.spellcheck + - name: Text Analytics (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-language-textanalytics-readme.md + children: + - azure.cognitiveservices.language.textanalytics + - name: Personalizer + href: ~/docs-ref-services/{moniker}/cognitiveservices-personalizer-readme.md + children: + - azure.cognitiveservices.personalizer + - name: Speech + href: ~/docs-ref-services/{moniker}/cognitiveservices-speech-readme.md + children: + - azure.cognitiveservices.speech + - name: Computer Vision (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-vision-computervision-readme.md + children: + - azure.cognitiveservices.vision.computervision + - name: Content Safety (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-vision-contentmoderator-readme.md + children: + - azure.cognitiveservices.vision.contentmoderator + - name: Custom Vision (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-vision-customvision-readme.md + children: + - azure.cognitiveservices.vision.customvision + - name: Health Insights Cancer Profiling + href: ~/docs-ref-services/{moniker}/healthinsights-cancerprofiling-readme.md + children: + - azure.healthinsights.cancerprofiling + - name: Health Insights Clinical Matching + href: ~/docs-ref-services/{moniker}/healthinsights-clinicalmatching-readme.md + children: + - azure.healthinsights.clinicalmatching + - name: Health Insights Radiology Insights + href: ~/docs-ref-services/{moniker}/healthinsights-radiologyinsights-readme.md + children: + - azure.healthinsights.radiologyinsights + - name: Management + items: + - name: Resource Management - Cognitive Services + href: ~/docs-ref-services/{moniker}/mgmt-cognitiveservices-readme.md + children: + - azure.mgmt.cognitiveservices + - name: Commerce + href: ~/docs-ref-services/{moniker}/commerce.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Commerce + href: ~/docs-ref-services/{moniker}/mgmt-commerce-readme.md + children: + - azure.mgmt.commerce + - name: Communication + href: ~/docs-ref-services/{moniker}/communication.md + landingPageType: Service + items: + - name: Communication Call Automation + href: ~/docs-ref-services/{moniker}/communication-callautomation-readme.md + children: + - azure.communication.callautomation + - name: Communication Chat + href: ~/docs-ref-services/{moniker}/communication-chat-readme.md + children: + - azure.communication.chat + - name: Communication Email + href: ~/docs-ref-services/{moniker}/communication-email-readme.md + children: + - azure.communication.email + - name: Communication Identity + href: ~/docs-ref-services/{moniker}/communication-identity-readme.md + children: + - azure.communication.identity + - name: Communication JobRouter + href: ~/docs-ref-services/{moniker}/communication-jobrouter-readme.md + children: + - azure.communication.jobrouter + - name: Communication Messages + href: ~/docs-ref-services/{moniker}/communication-messages-readme.md + children: + - azure.communication.messages + - name: Communication Network Traversal (deprecated) + href: ~/docs-ref-services/{moniker}/communication-networktraversal-readme.md + children: + - azure.communication.networktraversal + - name: Communication Phone Numbers + href: ~/docs-ref-services/{moniker}/communication-phonenumbers-readme.md + children: + - azure.communication.phonenumbers + - name: Communication Rooms + href: ~/docs-ref-services/{moniker}/communication-rooms-readme.md + children: + - azure.communication.rooms + - name: Communication Sms + href: ~/docs-ref-services/{moniker}/communication-sms-readme.md + children: + - azure.communication.sms + - name: Management + items: + - name: Resource Management - Communication + href: ~/docs-ref-services/{moniker}/mgmt-communication-readme.md + children: + - azure.mgmt.communication + - name: Compute + href: ~/docs-ref-services/{moniker}/compute.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Compute + href: ~/docs-ref-services/{moniker}/mgmt-compute-readme.md + children: + - azure.mgmt.compute + - name: Compute Fleet + href: ~/docs-ref-services/{moniker}/compute-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Compute Fleet + href: ~/docs-ref-services/{moniker}/mgmt-computefleet-readme.md + children: + - azure.mgmt.computefleet + - name: Computeschedule + href: ~/docs-ref-services/{moniker}/computeschedule.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Computeschedule + href: ~/docs-ref-services/{moniker}/mgmt-computeschedule-readme.md + children: + - azure.mgmt.computeschedule + - name: Confidential Ledger + href: ~/docs-ref-services/{moniker}/confidential-ledger.md + landingPageType: Service + items: + - name: Confidential Ledger + href: ~/docs-ref-services/{moniker}/confidentialledger-readme.md + children: + - azure.confidentialledger + - name: Management + items: + - name: Resource Management - Confidential Ledger + href: ~/docs-ref-services/{moniker}/mgmt-confidentialledger-readme.md + children: + - azure.mgmt.confidentialledger + - name: Confluent + href: ~/docs-ref-services/{moniker}/confluent.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Confluent + href: ~/docs-ref-services/{moniker}/mgmt-confluent-readme.md + children: + - azure.mgmt.confluent + - name: Connected VMware + href: ~/docs-ref-services/{moniker}/connected-vmware.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Connected VMware + href: ~/docs-ref-services/{moniker}/mgmt-connectedvmware-readme.md + children: + - azure.mgmt.connectedvmware + - name: Connectedcache + href: ~/docs-ref-services/{moniker}/connectedcache.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Connectedcache + href: ~/docs-ref-services/{moniker}/mgmt-connectedcache-readme.md + children: + - azure.mgmt.connectedcache + - name: Consumption + href: ~/docs-ref-services/{moniker}/consumption.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Consumption + href: ~/docs-ref-services/{moniker}/mgmt-consumption-readme.md + children: + - azure.mgmt.consumption + - name: Container Apps + href: ~/docs-ref-services/{moniker}/container-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Apps + href: ~/docs-ref-services/{moniker}/mgmt-appcontainers-readme.md + children: + - azure.mgmt.appcontainers + - name: Container Instances + href: ~/docs-ref-services/{moniker}/container-instances.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Instances + href: ~/docs-ref-services/{moniker}/mgmt-containerinstance-readme.md + children: + - azure.mgmt.containerinstance + - name: Container Registry + href: ~/docs-ref-services/{moniker}/container-registry.md + landingPageType: Service + items: + - name: Container Registry + href: ~/docs-ref-services/{moniker}/containerregistry-readme.md + children: + - azure.containerregistry + - name: Management + items: + - name: Resource Management - Container Registry + href: ~/docs-ref-services/{moniker}/mgmt-containerregistry-readme.md + children: + - azure.mgmt.containerregistry + - name: Container Service + href: ~/docs-ref-services/{moniker}/container-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Service + href: ~/docs-ref-services/{moniker}/mgmt-containerservice-readme.md + children: + - azure.mgmt.containerservice + - name: Container Service Fleet + href: ~/docs-ref-services/{moniker}/container-service-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Service Fleet + href: ~/docs-ref-services/{moniker}/mgmt-containerservicefleet-readme.md + children: + - azure.mgmt.containerservicefleet + - name: Containerorchestratorruntime + href: ~/docs-ref-services/{moniker}/containerorchestratorruntime.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Containerorchestratorruntime + href: ~/docs-ref-services/{moniker}/mgmt-containerorchestratorruntime-readme.md + children: + - azure.mgmt.containerorchestratorruntime + - name: Content Delivery Network + href: ~/docs-ref-services/{moniker}/content-delivery-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Content Delivery Network + href: ~/docs-ref-services/{moniker}/mgmt-cdn-readme.md + children: + - azure.mgmt.cdn + - name: Core + href: ~/docs-ref-services/{moniker}/core.md + landingPageType: Service + items: + - name: Core Tracing Opencensus + href: ~/docs-ref-services/{moniker}/core-tracing-opencensus-readme.md + children: + - azure.core.tracing.ext.opencensus_span + - name: Cosmos DB + href: ~/docs-ref-services/{moniker}/cosmos-db.md + landingPageType: Service + items: + - name: Cosmos DB + href: ~/docs-ref-services/{moniker}/cosmos-readme.md + children: + - azure.cosmos + - name: Management + items: + - name: Resource Management - Cosmos DB + href: ~/docs-ref-services/{moniker}/mgmt-cosmosdb-readme.md + children: + - azure.mgmt.cosmosdb + - name: Cosmos DB for PostgreSQL + href: ~/docs-ref-services/{moniker}/cosmos-db-for-postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Cosmos DB for PostgreSQL + href: ~/docs-ref-services/{moniker}/mgmt-cosmosdbforpostgresql-readme.md + children: + - azure.mgmt.cosmosdbforpostgresql + - name: Cost Management + href: ~/docs-ref-services/{moniker}/cost-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Cost Management + href: ~/docs-ref-services/{moniker}/mgmt-costmanagement-readme.md + children: + - azure.mgmt.costmanagement + - name: Custom Image Search + href: ~/docs-ref-services/{moniker}/custom-image-search.md + landingPageType: Service + items: + - name: Custom Image Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-customimagesearch-readme.md + children: + - azure.cognitiveservices.search.customimagesearch + - name: Custom Providers + href: ~/docs-ref-services/{moniker}/custom-providers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Custom Providers + href: ~/docs-ref-services/{moniker}/mgmt-customproviders-readme.md + children: + - azure.mgmt.customproviders + - name: Custom Search + href: ~/docs-ref-services/{moniker}/custom-search.md + landingPageType: Service + items: + - name: Custom Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-customsearch-readme.md + children: + - azure.cognitiveservices.search.customsearch + - name: Data Box + href: ~/docs-ref-services/{moniker}/data-box.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Box + href: ~/docs-ref-services/{moniker}/mgmt-databox-readme.md + children: + - azure.mgmt.databox + - name: Data Box Edge + href: ~/docs-ref-services/{moniker}/data-box-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Box Edge + href: ~/docs-ref-services/{moniker}/mgmt-databoxedge-readme.md + children: + - azure.mgmt.databoxedge + - name: Data Explorer + href: ~/docs-ref-services/{moniker}/data-explorer.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Kusto + href: ~/docs-ref-services/{moniker}/mgmt-kusto-readme.md + children: + - azure.mgmt.kusto + - name: Data Factory + href: ~/docs-ref-services/{moniker}/data-factory.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Factory + href: ~/docs-ref-services/{moniker}/mgmt-datafactory-readme.md + children: + - azure.mgmt.datafactory + - name: Data Protection + href: ~/docs-ref-services/{moniker}/data-protection.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Protection + href: ~/docs-ref-services/{moniker}/mgmt-dataprotection-readme.md + children: + - azure.mgmt.dataprotection + - name: Data Share + href: ~/docs-ref-services/{moniker}/data-share.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Share + href: ~/docs-ref-services/{moniker}/mgmt-datashare-readme.md + children: + - azure.mgmt.datashare + - name: Database Migration Service + href: ~/docs-ref-services/{moniker}/database-migration-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Migration + href: ~/docs-ref-services/{moniker}/mgmt-datamigration-readme.md + children: + - azure.mgmt.datamigration + - name: Databasewatcher + href: ~/docs-ref-services/{moniker}/databasewatcher.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Databasewatcher + href: ~/docs-ref-services/{moniker}/mgmt-databasewatcher-readme.md + children: + - azure.mgmt.databasewatcher + - name: Databricks + href: ~/docs-ref-services/{moniker}/databricks.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Databricks + href: ~/docs-ref-services/{moniker}/mgmt-databricks-readme.md + children: + - azure.mgmt.databricks + - name: Datadog + href: ~/docs-ref-services/{moniker}/datadog.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Datadog + href: ~/docs-ref-services/{moniker}/mgmt-datadog-readme.md + children: + - azure.mgmt.datadog + - name: Defender EASM + href: ~/docs-ref-services/{moniker}/defender-easm.md + landingPageType: Service + items: + - name: Defender EASM + href: ~/docs-ref-services/{moniker}/defender-easm-readme.md + children: + - azure.defender.easm + - name: Management + items: + - name: Resource Management - Defender EASM + href: ~/docs-ref-services/{moniker}/mgmt-defendereasm-readme.md + children: + - azure.mgmt.defendereasm + - name: Deployment Manager + href: ~/docs-ref-services/{moniker}/deployment-manager.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Deployment Manager + href: ~/docs-ref-services/{moniker}/mgmt-deploymentmanager-readme.md + children: + - azure.mgmt.deploymentmanager + - name: Desktop Virtualization + href: ~/docs-ref-services/{moniker}/desktop-virtualization.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Desktop Virtualization + href: ~/docs-ref-services/{moniker}/mgmt-desktopvirtualization-readme.md + children: + - azure.mgmt.desktopvirtualization + - name: Dev Center + href: ~/docs-ref-services/{moniker}/dev-center.md + landingPageType: Service + items: + - name: Dev Center + href: ~/docs-ref-services/{moniker}/developer-devcenter-readme.md + children: + - azure.developer.devcenter + - name: Management + items: + - name: Resource Management - Dev Center + href: ~/docs-ref-services/{moniker}/mgmt-devcenter-readme.md + children: + - azure.mgmt.devcenter + - name: Dev Spaces + href: ~/docs-ref-services/{moniker}/dev-spaces.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Dev Spaces + href: ~/docs-ref-services/{moniker}/mgmt-devspaces-readme.md + children: + - azure.mgmt.devspaces + - name: Device Registry + href: ~/docs-ref-services/{moniker}/device-registry.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Device Registry + href: ~/docs-ref-services/{moniker}/mgmt-deviceregistry-readme.md + children: + - azure.mgmt.deviceregistry + - name: DevOps Infrastructure + href: ~/docs-ref-services/{moniker}/devops-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevOps Infrastructure + href: ~/docs-ref-services/{moniker}/mgmt-devopsinfrastructure-readme.md + children: + - azure.mgmt.devopsinfrastructure + - name: DevTest Labs + href: ~/docs-ref-services/{moniker}/devtest-labs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevTest Labs + href: ~/docs-ref-services/{moniker}/mgmt-devtestlabs-readme.md + children: + - azure.mgmt.devtestlabs + - name: DNS + href: ~/docs-ref-services/{moniker}/dns.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DNS + href: ~/docs-ref-services/{moniker}/mgmt-dns-readme.md + children: + - azure.mgmt.dns + - name: DNS Resolver + href: ~/docs-ref-services/{moniker}/dns-resolver.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DNS Resolver + href: ~/docs-ref-services/{moniker}/mgmt-dnsresolver-readme.md + children: + - azure.mgmt.dnsresolver + - name: Dynatrace + href: ~/docs-ref-services/{moniker}/dynatrace.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Dynatrace + href: ~/docs-ref-services/{moniker}/mgmt-dynatrace-readme.md + children: + - azure.mgmt.dynatrace + - name: Edge Order + href: ~/docs-ref-services/{moniker}/edge-order.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Order + href: ~/docs-ref-services/{moniker}/mgmt-edgeorder-readme.md + children: + - azure.mgmt.edgeorder + - name: Edge Zones + href: ~/docs-ref-services/{moniker}/edge-zones.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Zones + href: ~/docs-ref-services/{moniker}/mgmt-edgezones-readme.md + children: + - azure.mgmt.edgezones + - name: Education + href: ~/docs-ref-services/{moniker}/education.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Education + href: ~/docs-ref-services/{moniker}/mgmt-education-readme.md + children: + - azure.mgmt.education + - name: Elastic + href: ~/docs-ref-services/{moniker}/elastic.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic + href: ~/docs-ref-services/{moniker}/mgmt-elastic-readme.md + children: + - azure.mgmt.elastic + - name: Elastic SAN + href: ~/docs-ref-services/{moniker}/elastic-san.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic SAN + href: ~/docs-ref-services/{moniker}/mgmt-elasticsan-readme.md + children: + - azure.mgmt.elasticsan + - name: Entity Search + href: ~/docs-ref-services/{moniker}/entity-search.md + landingPageType: Service + items: + - name: Entity Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-entitysearch-readme.md + children: + - azure.cognitiveservices.search.entitysearch + - name: Event Grid + href: ~/docs-ref-services/{moniker}/event-grid.md + landingPageType: Service + items: + - name: Event Grid + href: ~/docs-ref-services/{moniker}/eventgrid-readme.md + children: + - azure.eventgrid + - name: Management + items: + - name: Resource Management - Event Grid + href: ~/docs-ref-services/{moniker}/mgmt-eventgrid-readme.md + children: + - azure.mgmt.eventgrid + - name: Event Hubs + href: ~/docs-ref-services/{moniker}/event-hubs.md + landingPageType: Service + items: + - name: Event Hubs + href: ~/docs-ref-services/{moniker}/eventhub-readme.md + children: + - azure.eventhub + - name: Azure Blob Storage Checkpoint Store + href: ~/docs-ref-services/{moniker}/eventhub-checkpointstoreblob-readme.md + children: + - azure.eventhub.extensions.checkpointstoreblob + - name: Azure Blob Storage Checkpoint Store AIO + href: ~/docs-ref-services/{moniker}/eventhub-checkpointstoreblob-aio-readme.md + children: + - azure.eventhub.extensions.checkpointstoreblobaio + - name: Management + items: + - name: Resource Management - Event Hubs + href: ~/docs-ref-services/{moniker}/mgmt-eventhub-readme.md + children: + - azure.mgmt.eventhub + - name: Extended Location + href: ~/docs-ref-services/{moniker}/extended-location.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Extended Location + href: ~/docs-ref-services/{moniker}/mgmt-extendedlocation-readme.md + children: + - azure.mgmt.extendedlocation + - name: Fabric + href: ~/docs-ref-services/{moniker}/fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fabric + href: ~/docs-ref-services/{moniker}/mgmt-fabric-readme.md + children: + - azure.mgmt.fabric + - name: Face + href: ~/docs-ref-services/{moniker}/face.md + landingPageType: Service + items: + - name: Face (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-vision-face-readme.md + children: + - azure.cognitiveservices.vision.face + - name: FarmBeats + href: ~/docs-ref-services/{moniker}/farmbeats.md + landingPageType: Service + items: + - name: FarmBeats + href: ~/docs-ref-services/{moniker}/agrifood-farming-readme.md + children: + - azure.agrifood.farming + - name: Fluid Relay + href: ~/docs-ref-services/{moniker}/fluid-relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fluid Relay + href: ~/docs-ref-services/{moniker}/mgmt-fluidrelay-readme.md + children: + - azure.mgmt.fluidrelay + - name: Front Door + href: ~/docs-ref-services/{moniker}/front-door.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Front Door + href: ~/docs-ref-services/{moniker}/mgmt-frontdoor-readme.md + children: + - azure.mgmt.frontdoor + - name: Functions + href: ~/docs-ref-services/{moniker}/functions.md + landingPageType: Service + items: + - name: Functions + href: ~/docs-ref-services/{moniker}/functions-readme.md + children: + - azure.functions + - name: Durable Functions + href: ~/docs-ref-services/{moniker}/functions-durable-readme.md + children: + - azure.durable_functions + - name: Grafana + href: ~/docs-ref-services/{moniker}/grafana.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Grafana + href: ~/docs-ref-services/{moniker}/mgmt-dashboard-readme.md + children: + - azure.mgmt.dashboard + - name: Graph RBAC + href: ~/docs-ref-services/{moniker}/graph-rbac.md + landingPageType: Service + items: + - name: Graph RBAC (deprecated) + href: ~/docs-ref-services/{moniker}/graphrbac-readme.md + children: + - azure.graphrbac + - name: Graph Services + href: ~/docs-ref-services/{moniker}/graph-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Graph Services + href: ~/docs-ref-services/{moniker}/mgmt-graphservices-readme.md + children: + - azure.mgmt.graphservices + - name: Guest Configuration + href: ~/docs-ref-services/{moniker}/guest-configuration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Guest Configuration + href: ~/docs-ref-services/{moniker}/mgmt-guestconfig-readme.md + children: + - azure.mgmt.guestconfig + - name: HANA on Azure + href: ~/docs-ref-services/{moniker}/hana-on-azure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HANA on Azure + href: ~/docs-ref-services/{moniker}/mgmt-hanaonazure-readme.md + children: + - azure.mgmt.hanaonazure + - name: Hardware Security Modules + href: ~/docs-ref-services/{moniker}/hardware-security-modules.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hardware Security Modules + href: ~/docs-ref-services/{moniker}/mgmt-hardwaresecuritymodules-readme.md + children: + - azure.mgmt.hardwaresecuritymodules + - name: HDInsight + href: ~/docs-ref-services/{moniker}/hdinsight.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HDInsight + href: ~/docs-ref-services/{moniker}/mgmt-hdinsight-readme.md + children: + - azure.mgmt.hdinsight + - name: HDInsight Containers + href: ~/docs-ref-services/{moniker}/hdinsight-containers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HDInsight Containers + href: ~/docs-ref-services/{moniker}/mgmt-hdinsightcontainers-readme.md + children: + - azure.mgmt.hdinsightcontainers + - name: Health Bot + href: ~/docs-ref-services/{moniker}/health-bot.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Health Bot + href: ~/docs-ref-services/{moniker}/mgmt-healthbot-readme.md + children: + - azure.mgmt.healthbot + - name: Health Data AI Services + href: ~/docs-ref-services/{moniker}/health-data-ai-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Health Data AI Services + href: ~/docs-ref-services/{moniker}/mgmt-healthdataaiservices-readme.md + children: + - azure.mgmt.healthdataaiservices + - name: Health Deidentification + href: ~/docs-ref-services/{moniker}/health-deidentification.md + landingPageType: Service + items: + - name: Health Deidentification + href: ~/docs-ref-services/{moniker}/health-deidentification-readme.md + children: + - azure.health.deidentification + - name: Healthcare APIs + href: ~/docs-ref-services/{moniker}/healthcare-apis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Healthcare APIs + href: ~/docs-ref-services/{moniker}/mgmt-healthcareapis-readme.md + children: + - azure.mgmt.healthcareapis + - name: Hybrid Compute + href: ~/docs-ref-services/{moniker}/hybrid-compute.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Compute + href: ~/docs-ref-services/{moniker}/mgmt-hybridcompute-readme.md + children: + - azure.mgmt.hybridcompute + - name: Hybrid Connectivity + href: ~/docs-ref-services/{moniker}/hybrid-connectivity.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Connectivity + href: ~/docs-ref-services/{moniker}/mgmt-hybridconnectivity-readme.md + children: + - azure.mgmt.hybridconnectivity + - name: Hybrid Container Service + href: ~/docs-ref-services/{moniker}/hybrid-container-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Container Service + href: ~/docs-ref-services/{moniker}/mgmt-hybridcontainerservice-readme.md + children: + - azure.mgmt.hybridcontainerservice + - name: Hybrid Kubernetes + href: ~/docs-ref-services/{moniker}/hybrid-kubernetes.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Kubernetes + href: ~/docs-ref-services/{moniker}/mgmt-hybridkubernetes-readme.md + children: + - azure.mgmt.hybridkubernetes + - name: Hybrid Network + href: ~/docs-ref-services/{moniker}/hybrid-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Network + href: ~/docs-ref-services/{moniker}/mgmt-hybridnetwork-readme.md + children: + - azure.mgmt.hybridnetwork + - name: Identity + href: ~/docs-ref-services/{moniker}/identity.md + landingPageType: Service + items: + - name: Identity + href: ~/docs-ref-services/{moniker}/identity-readme.md + children: + - azure.identity + - name: Identity Broker + href: ~/docs-ref-services/{moniker}/identity-broker-readme.md + children: + - azure.identity.broker + - name: Image Builder + href: ~/docs-ref-services/{moniker}/image-builder.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Image Builder + href: ~/docs-ref-services/{moniker}/mgmt-imagebuilder-readme.md + children: + - azure.mgmt.imagebuilder + - name: Image Search + href: ~/docs-ref-services/{moniker}/image-search.md + landingPageType: Service + items: + - name: Image Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-imagesearch-readme.md + children: + - azure.cognitiveservices.search.imagesearch + - name: Impactreporting + href: ~/docs-ref-services/{moniker}/impactreporting.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Impactreporting + href: ~/docs-ref-services/{moniker}/mgmt-impactreporting-readme.md + children: + - azure.mgmt.impactreporting + - name: Informatica Data Management + href: ~/docs-ref-services/{moniker}/informatica-data-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Informatica Data Management + href: ~/docs-ref-services/{moniker}/mgmt-informaticadatamanagement-readme.md + children: + - azure.mgmt.informaticadatamanagement + - name: IoT + href: ~/docs-ref-services/{moniker}/iot.md + landingPageType: Service + items: + - name: Digital Twins + href: ~/docs-ref-services/{moniker}/digitaltwins-core-readme.md + children: + - azure.digitaltwins.core + - name: IoT Device + href: ~/docs-ref-services/{moniker}/iot-device-readme.md + children: + - azure.iot.device + - name: Device Provisioning Services + href: ~/docs-ref-services/{moniker}/iot-deviceprovisioning-readme.md + children: + - azure.iot.deviceprovisioning + - name: Device Update + href: ~/docs-ref-services/{moniker}/iot-deviceupdate-readme.md + children: + - azure.iot.deviceupdate + - name: IoT Hub + href: ~/docs-ref-services/{moniker}/iot-hub-readme.md + children: + - azure.iot.hub + - name: Models Repository (deprecated) + href: ~/docs-ref-services/{moniker}/iot-modelsrepository-readme.md + children: + - azure.iot.modelsrepository + - name: Management + items: + - name: Resource Management - Device Update + href: ~/docs-ref-services/{moniker}/mgmt-deviceupdate-readme.md + children: + - azure.mgmt.deviceupdate + - name: Resource Management - Digital Twins + href: ~/docs-ref-services/{moniker}/mgmt-digitaltwins-readme.md + children: + - azure.mgmt.digitaltwins + - name: Resource Management - IoT Central + href: ~/docs-ref-services/{moniker}/mgmt-iotcentral-readme.md + children: + - azure.mgmt.iotcentral + - name: Resource Management - IoT Firmware Defense + href: ~/docs-ref-services/{moniker}/mgmt-iotfirmwaredefense-readme.md + children: + - azure.mgmt.iotfirmwaredefense + - name: Resource Management - IoT Hub + href: ~/docs-ref-services/{moniker}/mgmt-iothub-readme.md + children: + - azure.mgmt.iothub + - name: Resource Management - Device Provisioning Services + href: ~/docs-ref-services/{moniker}/mgmt-iothubprovisioningservices-readme.md + children: + - azure.mgmt.iothubprovisioningservices + - name: Resource Management - Time Series Insights + href: ~/docs-ref-services/{moniker}/mgmt-timeseriesinsights-readme.md + children: + - azure.mgmt.timeseriesinsights + - name: Iotoperations + href: ~/docs-ref-services/{moniker}/iotoperations.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Iotoperations + href: ~/docs-ref-services/{moniker}/mgmt-iotoperations-readme.md + children: + - azure.mgmt.iotoperations + - name: Key Vault + href: ~/docs-ref-services/{moniker}/key-vault.md + landingPageType: Service + items: + - name: Key Vault + href: ~/docs-ref-services/{moniker}/keyvault-readme.md + children: + - azure.keyvault + - name: Key Vault - Administration + href: ~/docs-ref-services/{moniker}/keyvault-administration-readme.md + children: + - azure.keyvault.administration + - name: Key Vault - Certificates + href: ~/docs-ref-services/{moniker}/keyvault-certificates-readme.md + children: + - azure.keyvault.certificates + - name: Key Vault - Keys + href: ~/docs-ref-services/{moniker}/keyvault-keys-readme.md + children: + - azure.keyvault.keys + - name: Key Vault - Secrets + href: ~/docs-ref-services/{moniker}/keyvault-secrets-readme.md + children: + - azure.keyvault.secrets + - name: Management + items: + - name: Resource Management - Key Vault + href: ~/docs-ref-services/{moniker}/mgmt-keyvault-readme.md + children: + - azure.mgmt.keyvault + - name: Kubernetes Configuration + href: ~/docs-ref-services/{moniker}/kubernetes-configuration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Kubernetes Configuration + href: ~/docs-ref-services/{moniker}/mgmt-kubernetesconfiguration-readme.md + children: + - azure.mgmt.kubernetesconfiguration + - name: Lab Services + href: ~/docs-ref-services/{moniker}/lab-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Lab Services + href: ~/docs-ref-services/{moniker}/mgmt-labservices-readme.md + children: + - azure.mgmt.labservices + - name: Large Instance + href: ~/docs-ref-services/{moniker}/large-instance.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Large Instance + href: ~/docs-ref-services/{moniker}/mgmt-largeinstance-readme.md + children: + - azure.mgmt.largeinstance + - name: Load Testing + href: ~/docs-ref-services/{moniker}/load-testing.md + landingPageType: Service + items: + - name: Load Testing + href: ~/docs-ref-services/{moniker}/developer-loadtesting-readme.md + children: + - azure.developer.loadtesting + - name: Management + items: + - name: Resource Management - Load Testing + href: ~/docs-ref-services/{moniker}/mgmt-loadtesting-readme.md + children: + - azure.mgmt.loadtesting + - name: Log Analytics + href: ~/docs-ref-services/{moniker}/log-analytics.md + landingPageType: Service + items: + - name: Log Analytics - Query (deprecated) + href: ~/docs-ref-services/{moniker}/loganalytics-readme.md + children: + - azure.loganalytics + - name: Management + items: + - name: Resource Management - Log Analytics + href: ~/docs-ref-services/{moniker}/mgmt-loganalytics-readme.md + children: + - azure.mgmt.loganalytics + - name: Logic Apps + href: ~/docs-ref-services/{moniker}/logic-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logic Apps + href: ~/docs-ref-services/{moniker}/mgmt-logic-readme.md + children: + - azure.mgmt.logic + - name: Logz + href: ~/docs-ref-services/{moniker}/logz.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logz (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-logz-readme.md + children: + - azure.mgmt.logz + - name: Machine Learning + href: ~/docs-ref-services/{moniker}/machine-learning.md + landingPageType: Service + items: + - name: Machine Learning + href: ~/docs-ref-services/{moniker}/ai-ml-readme.md + children: + - azure.ai.ml + - name: Machine Learning - Feature Store + href: ~/docs-ref-services/{moniker}/azureml-featurestore-readme.md + children: + - azureml.featurestore + - name: Management + items: + - name: Resource Management - Machine Learning Compute + href: ~/docs-ref-services/{moniker}/mgmt-machinelearningcompute-readme.md + children: + - azure.mgmt.machinelearningcompute + - name: Resource Management - Machine Learning Services + href: ~/docs-ref-services/{moniker}/mgmt-machinelearningservices-readme.md + children: + - azure.mgmt.machinelearningservices + - name: Maintenance + href: ~/docs-ref-services/{moniker}/maintenance.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Maintenance + href: ~/docs-ref-services/{moniker}/mgmt-maintenance-readme.md + children: + - azure.mgmt.maintenance + - name: Managed Applications + href: ~/docs-ref-services/{moniker}/managed-applications.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Applications + href: ~/docs-ref-services/{moniker}/mgmt-managedapplications-readme.md + children: + - azure.mgmt.managedapplications + - name: Managed Network Fabric + href: ~/docs-ref-services/{moniker}/managed-network-fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Network Fabric + href: ~/docs-ref-services/{moniker}/mgmt-managednetworkfabric-readme.md + children: + - azure.mgmt.managednetworkfabric + - name: Managed Service Identity + href: ~/docs-ref-services/{moniker}/managed-service-identity.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Service Identity + href: ~/docs-ref-services/{moniker}/mgmt-msi-readme.md + children: + - azure.mgmt.msi + - name: Managed Services + href: ~/docs-ref-services/{moniker}/managed-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Services + href: ~/docs-ref-services/{moniker}/mgmt-managedservices-readme.md + children: + - azure.mgmt.managedservices + - name: Management Groups + href: ~/docs-ref-services/{moniker}/management-groups.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Groups + href: ~/docs-ref-services/{moniker}/mgmt-managementgroups-readme.md + children: + - azure.mgmt.managementgroups + - name: Management Partner + href: ~/docs-ref-services/{moniker}/management-partner.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Partner + href: ~/docs-ref-services/{moniker}/mgmt-managementpartner-readme.md + children: + - azure.mgmt.managementpartner + - name: Maps + href: ~/docs-ref-services/{moniker}/maps.md + landingPageType: Service + items: + - name: Maps Geolocation + href: ~/docs-ref-services/{moniker}/maps-geolocation-readme.md + children: + - azure.maps.geolocation + - name: Maps Render + href: ~/docs-ref-services/{moniker}/maps-render-readme.md + children: + - azure.maps.render + - name: Maps Route + href: ~/docs-ref-services/{moniker}/maps-route-readme.md + children: + - azure.maps.route + - name: Maps Search + href: ~/docs-ref-services/{moniker}/maps-search-readme.md + children: + - azure.maps.search + - name: Management + items: + - name: Resource Management - Maps + href: ~/docs-ref-services/{moniker}/mgmt-maps-readme.md + children: + - azure.mgmt.maps + - name: Marketplace Ordering + href: ~/docs-ref-services/{moniker}/marketplace-ordering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Marketplace Ordering + href: ~/docs-ref-services/{moniker}/mgmt-marketplaceordering-readme.md + children: + - azure.mgmt.marketplaceordering + - name: Media + href: ~/docs-ref-services/{moniker}/media.md + landingPageType: Service + items: + - name: Media Analytics Edge + href: ~/docs-ref-services/{moniker}/media-analytics-edge-readme.md + children: + - azure.media.analyticsedge + - name: Media Services + href: ~/docs-ref-services/{moniker}/media-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Media Services + href: ~/docs-ref-services/{moniker}/mgmt-media-readme.md + children: + - azure.mgmt.media + - name: Metrics Advisor + href: ~/docs-ref-services/{moniker}/metrics-advisor.md + landingPageType: Service + items: + - name: Metrics Advisor (deprecated) + href: ~/docs-ref-services/{moniker}/ai-metricsadvisor-readme.md + children: + - azure.ai.metricsadvisor + - name: Migration + href: ~/docs-ref-services/{moniker}/migration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Migration Discovery SAP + href: ~/docs-ref-services/{moniker}/mgmt-migrationdiscoverysap-readme.md + children: + - azure.mgmt.migrationdiscoverysap + - name: Migrationassessment + href: ~/docs-ref-services/{moniker}/migrationassessment.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Migrationassessment + href: ~/docs-ref-services/{moniker}/mgmt-migrationassessment-readme.md + children: + - azure.mgmt.migrationassessment + - name: Mixed Reality + href: ~/docs-ref-services/{moniker}/mixed-reality.md + landingPageType: Service + items: + - name: Mixed Reality Authentication + href: ~/docs-ref-services/{moniker}/mixedreality-authentication-readme.md + children: + - azure.mixedreality.authentication + - name: Management + items: + - name: Resource Management - Mixed Reality + href: ~/docs-ref-services/{moniker}/mgmt-mixedreality-readme.md + children: + - azure.mgmt.mixedreality + - name: Mobile Network + href: ~/docs-ref-services/{moniker}/mobile-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mobile Network + href: ~/docs-ref-services/{moniker}/mgmt-mobilenetwork-readme.md + children: + - azure.mgmt.mobilenetwork + - name: Mongo Cluster + href: ~/docs-ref-services/{moniker}/mongo-cluster.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mongo Cluster + href: ~/docs-ref-services/{moniker}/mgmt-mongocluster-readme.md + children: + - azure.mgmt.mongocluster + - name: Monitor + href: ~/docs-ref-services/{moniker}/monitor.md + landingPageType: Service + items: + - name: Monitor Ingestion + href: ~/docs-ref-services/{moniker}/monitor-ingestion-readme.md + children: + - azure.monitor.ingestion + - name: Azure Monitor OpenTelemetry + href: ~/docs-ref-services/{moniker}/monitor-opentelemetry-readme.md + children: + - azure.monitor.opentelemetry + - name: OpenTelemetry Exporter + href: ~/docs-ref-services/{moniker}/monitor-opentelemetry-exporter-readme.md + children: + - azure.monitor.opentelemetry.exporter + - name: Monitor Query + href: ~/docs-ref-services/{moniker}/monitor-query-readme.md + children: + - azure.monitor.query + - name: Management + items: + - name: Resource Management - Monitor + href: ~/docs-ref-services/{moniker}/mgmt-monitor-readme.md + children: + - azure.mgmt.monitor + - name: Mysqlflexibleservers + href: ~/docs-ref-services/{moniker}/mysqlflexibleservers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mysqlflexibleservers + href: ~/docs-ref-services/{moniker}/mgmt-mysqlflexibleservers-readme.md + children: + - azure.mgmt.mysqlflexibleservers + - name: Neonpostgres + href: ~/docs-ref-services/{moniker}/neonpostgres.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Neonpostgres + href: ~/docs-ref-services/{moniker}/mgmt-neonpostgres-readme.md + children: + - azure.mgmt.neonpostgres + - name: NetApp Files + href: ~/docs-ref-services/{moniker}/netapp-files.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - NetApp Files + href: ~/docs-ref-services/{moniker}/mgmt-netapp-readme.md + children: + - azure.mgmt.netapp + - name: Network + href: ~/docs-ref-services/{moniker}/network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network + href: ~/docs-ref-services/{moniker}/mgmt-network-readme.md + children: + - azure.mgmt.network + - name: Network Analytics + href: ~/docs-ref-services/{moniker}/network-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Analytics (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-networkanalytics-readme.md + children: + - azure.mgmt.networkanalytics + - name: Network Function + href: ~/docs-ref-services/{moniker}/network-function.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Function + href: ~/docs-ref-services/{moniker}/mgmt-networkfunction-readme.md + children: + - azure.mgmt.networkfunction + - name: New Relic Observability + href: ~/docs-ref-services/{moniker}/new-relic-observability.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - New Relic Observability + href: ~/docs-ref-services/{moniker}/mgmt-newrelicobservability-readme.md + children: + - azure.mgmt.newrelicobservability + - name: News Search + href: ~/docs-ref-services/{moniker}/news-search.md + landingPageType: Service + items: + - name: News Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-newssearch-readme.md + children: + - azure.cognitiveservices.search.newssearch + - name: Nginx + href: ~/docs-ref-services/{moniker}/nginx.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Nginx + href: ~/docs-ref-services/{moniker}/mgmt-nginx-readme.md + children: + - azure.mgmt.nginx + - name: Notification Hubs + href: ~/docs-ref-services/{moniker}/notification-hubs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Notification Hubs + href: ~/docs-ref-services/{moniker}/mgmt-notificationhubs-readme.md + children: + - azure.mgmt.notificationhubs + - name: Oep + href: ~/docs-ref-services/{moniker}/oep.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Oep + href: ~/docs-ref-services/{moniker}/mgmt-oep-readme.md + children: + - azure.mgmt.oep + - name: Operations Management + href: ~/docs-ref-services/{moniker}/operations-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Operations Management + href: ~/docs-ref-services/{moniker}/mgmt-operationsmanagement-readme.md + children: + - azure.mgmt.operationsmanagement + - name: Operator Nexus - Network Cloud + href: ~/docs-ref-services/{moniker}/operator-nexus---network-cloud.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Networkcloud + href: ~/docs-ref-services/{moniker}/mgmt-networkcloud-readme.md + children: + - azure.mgmt.networkcloud + - name: Oracle Database + href: ~/docs-ref-services/{moniker}/oracle-database.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Oracle Database + href: ~/docs-ref-services/{moniker}/mgmt-oracledatabase-readme.md + children: + - azure.mgmt.oracledatabase + - name: Orbital + href: ~/docs-ref-services/{moniker}/orbital.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Orbital + href: ~/docs-ref-services/{moniker}/mgmt-orbital-readme.md + children: + - azure.mgmt.orbital + - name: Palo Alto Networks + href: ~/docs-ref-services/{moniker}/palo-alto-networks.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Palo Alto Networks - Next Generation Firewall + href: ~/docs-ref-services/{moniker}/mgmt-paloaltonetworksngfw-readme.md + children: + - azure.mgmt.paloaltonetworksngfw + - name: Peering + href: ~/docs-ref-services/{moniker}/peering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Peering + href: ~/docs-ref-services/{moniker}/mgmt-peering-readme.md + children: + - azure.mgmt.peering + - name: Pineconevectordb + href: ~/docs-ref-services/{moniker}/pineconevectordb.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Pineconevectordb + href: ~/docs-ref-services/{moniker}/mgmt-pineconevectordb-readme.md + children: + - azure.mgmt.pineconevectordb + - name: Playwright Testing + href: ~/docs-ref-services/{moniker}/playwright-testing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Playwright Testing + href: ~/docs-ref-services/{moniker}/mgmt-playwrighttesting-readme.md + children: + - azure.mgmt.playwrighttesting + - name: Policy Insights + href: ~/docs-ref-services/{moniker}/policy-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Policy Insights + href: ~/docs-ref-services/{moniker}/mgmt-policyinsights-readme.md + children: + - azure.mgmt.policyinsights + - name: Portal + href: ~/docs-ref-services/{moniker}/portal.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Portal + href: ~/docs-ref-services/{moniker}/mgmt-portal-readme.md + children: + - azure.mgmt.portal + - name: PostgreSQL + href: ~/docs-ref-services/{moniker}/postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - PostgreSQL + href: ~/docs-ref-services/{moniker}/mgmt-rdbms-readme.md + children: + - azure.mgmt.rdbms + - name: Postgresqlflexibleservers + href: ~/docs-ref-services/{moniker}/postgresqlflexibleservers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Postgresqlflexibleservers + href: ~/docs-ref-services/{moniker}/mgmt-postgresqlflexibleservers-readme.md + children: + - azure.mgmt.postgresqlflexibleservers + - name: Power BI Dedicated + href: ~/docs-ref-services/{moniker}/power-bi-dedicated.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Power BI Dedicated + href: ~/docs-ref-services/{moniker}/mgmt-powerbidedicated-readme.md + children: + - azure.mgmt.powerbidedicated + - name: Private DNS + href: ~/docs-ref-services/{moniker}/private-dns.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Private DNS + href: ~/docs-ref-services/{moniker}/mgmt-privatedns-readme.md + children: + - azure.mgmt.privatedns + - name: Purview + href: ~/docs-ref-services/{moniker}/purview.md + landingPageType: Service + items: + - name: Purview Account + href: ~/docs-ref-services/{moniker}/purview-account-readme.md + children: + - azure.purview.account + - name: Purview Administration + href: ~/docs-ref-services/{moniker}/purview-administration-readme.md + children: + - azure.purview.administration + - name: Purview Catalog (deprecated) + href: ~/docs-ref-services/{moniker}/purview-catalog-readme.md + children: + - azure.purview.catalog + - name: Purview Data Map + href: ~/docs-ref-services/{moniker}/purview-datamap-readme.md + children: + - azure.purview.datamap + - name: Purview Scanning + href: ~/docs-ref-services/{moniker}/purview-scanning-readme.md + children: + - azure.purview.scanning + - name: Purview Sharing + href: ~/docs-ref-services/{moniker}/purview-sharing-readme.md + children: + - azure.purview.sharing + - name: Purview Workflow + href: ~/docs-ref-services/{moniker}/purview-workflow-readme.md + children: + - azure.purview.workflow + - name: Management + items: + - name: Resource Management - Purview + href: ~/docs-ref-services/{moniker}/mgmt-purview-readme.md + children: + - azure.mgmt.purview + - name: Quantum + href: ~/docs-ref-services/{moniker}/quantum.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Quantum + href: ~/docs-ref-services/{moniker}/mgmt-quantum-readme.md + children: + - azure.mgmt.quantum + - name: Qumulo + href: ~/docs-ref-services/{moniker}/qumulo.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Qumulo + href: ~/docs-ref-services/{moniker}/mgmt-qumulo-readme.md + children: + - azure.mgmt.qumulo + - name: Quota + href: ~/docs-ref-services/{moniker}/quota.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Quota + href: ~/docs-ref-services/{moniker}/mgmt-quota-readme.md + children: + - azure.mgmt.quota + - name: Recovery Services + href: ~/docs-ref-services/{moniker}/recovery-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Recovery Services + href: ~/docs-ref-services/{moniker}/mgmt-recoveryservices-readme.md + children: + - azure.mgmt.recoveryservices + - name: Resource Management - Recovery Services Backup + href: ~/docs-ref-services/{moniker}/mgmt-recoveryservicesbackup-readme.md + children: + - azure.mgmt.recoveryservicesbackup + - name: Resource Management - Recovery Services Data Replication + href: ~/docs-ref-services/{moniker}/mgmt-recoveryservicesdatareplication-readme.md + children: + - azure.mgmt.recoveryservicesdatareplication + - name: Resource Management - Recovery Services Site Recovery + href: ~/docs-ref-services/{moniker}/mgmt-recoveryservicessiterecovery-readme.md + children: + - azure.mgmt.recoveryservicessiterecovery + - name: Red Hat OpenShift (ARO) + href: ~/docs-ref-services/{moniker}/red-hat-openshift-(aro).md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Red Hat OpenShift + href: ~/docs-ref-services/{moniker}/mgmt-redhatopenshift-readme.md + children: + - azure.mgmt.redhatopenshift + - name: Redis + href: ~/docs-ref-services/{moniker}/redis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Redis + href: ~/docs-ref-services/{moniker}/mgmt-redis-readme.md + children: + - azure.mgmt.redis + - name: Resource Management - Redis Enterprise + href: ~/docs-ref-services/{moniker}/mgmt-redisenterprise-readme.md + children: + - azure.mgmt.redisenterprise + - name: Relay + href: ~/docs-ref-services/{moniker}/relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Relay + href: ~/docs-ref-services/{moniker}/mgmt-relay-readme.md + children: + - azure.mgmt.relay + - name: Resource Connector + href: ~/docs-ref-services/{moniker}/resource-connector.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Connector + href: ~/docs-ref-services/{moniker}/mgmt-resourceconnector-readme.md + children: + - azure.mgmt.resourceconnector + - name: Resource Graph + href: ~/docs-ref-services/{moniker}/resource-graph.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Graph + href: ~/docs-ref-services/{moniker}/mgmt-resourcegraph-readme.md + children: + - azure.mgmt.resourcegraph + - name: Resource Health + href: ~/docs-ref-services/{moniker}/resource-health.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Health + href: ~/docs-ref-services/{moniker}/mgmt-resourcehealth-readme.md + children: + - azure.mgmt.resourcehealth + - name: Resource Mover + href: ~/docs-ref-services/{moniker}/resource-mover.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Mover + href: ~/docs-ref-services/{moniker}/mgmt-resourcemover-readme.md + children: + - azure.mgmt.resourcemover + - name: Resources + href: ~/docs-ref-services/{moniker}/resources.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resources + href: ~/docs-ref-services/{moniker}/mgmt-resource-readme.md + children: + - azure.mgmt.resource + - name: Scheduler + href: ~/docs-ref-services/{moniker}/scheduler.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scheduler (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-scheduler-readme.md + children: + - azure.mgmt.scheduler + - name: Schema Registry + href: ~/docs-ref-services/{moniker}/schema-registry.md + landingPageType: Service + items: + - name: Schema Registry + href: ~/docs-ref-services/{moniker}/schemaregistry-readme.md + children: + - azure.schemaregistry + - name: Schema Registry - Avro + href: ~/docs-ref-services/{moniker}/schemaregistry-avroencoder-readme.md + children: + - azure.schemaregistry.encoder.avroencoder + - name: Schema Registry - Avro (deprecated) + href: ~/docs-ref-services/{moniker}/schemaregistry-avroserializer-readme.md + children: + - azure.schemaregistry.serializer + - name: Scvmm + href: ~/docs-ref-services/{moniker}/scvmm.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scvmm + href: ~/docs-ref-services/{moniker}/mgmt-scvmm-readme.md + children: + - azure.mgmt.scvmm + - name: Search + href: ~/docs-ref-services/{moniker}/search.md + landingPageType: Service + items: + - name: Azure AI Search + href: ~/docs-ref-services/{moniker}/search-documents-readme.md + children: + - azure.search.documents + - name: Management + items: + - name: Resource Management - Azure AI Search + href: ~/docs-ref-services/{moniker}/mgmt-search-readme.md + children: + - azure.mgmt.search + - name: Security + href: ~/docs-ref-services/{moniker}/security.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security + href: ~/docs-ref-services/{moniker}/mgmt-security-readme.md + children: + - azure.mgmt.security + - name: Security DevOps + href: ~/docs-ref-services/{moniker}/security-devops.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security DevOps + href: ~/docs-ref-services/{moniker}/mgmt-securitydevops-readme.md + children: + - azure.mgmt.securitydevops + - name: Security Insights + href: ~/docs-ref-services/{moniker}/security-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security Insights + href: ~/docs-ref-services/{moniker}/mgmt-securityinsight-readme.md + children: + - azure.mgmt.securityinsight + - name: Self Help + href: ~/docs-ref-services/{moniker}/self-help.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Self Help + href: ~/docs-ref-services/{moniker}/mgmt-selfhelp-readme.md + children: + - azure.mgmt.selfhelp + - name: Serial Console + href: ~/docs-ref-services/{moniker}/serial-console.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Serial Console + href: ~/docs-ref-services/{moniker}/mgmt-serialconsole-readme.md + children: + - azure.mgmt.serialconsole + - name: Service Bus + href: ~/docs-ref-services/{moniker}/service-bus.md + landingPageType: Service + items: + - name: Service Bus + href: ~/docs-ref-services/{moniker}/servicebus-readme.md + children: + - azure.servicebus + - name: Management + items: + - name: Resource Management - Service Bus + href: ~/docs-ref-services/{moniker}/mgmt-servicebus-readme.md + children: + - azure.mgmt.servicebus + - name: Service Fabric + href: ~/docs-ref-services/{moniker}/service-fabric.md + landingPageType: Service + items: + - name: Service Fabric + href: ~/docs-ref-services/{moniker}/servicefabric-readme.md + children: + - azure.servicefabric + - name: Management + items: + - name: Resource Management - Service Fabric + href: ~/docs-ref-services/{moniker}/mgmt-servicefabric-readme.md + children: + - azure.mgmt.servicefabric + - name: Resource Management - Service Fabric Managed Clusters + href: ~/docs-ref-services/{moniker}/mgmt-servicefabricmanagedclusters-readme.md + children: + - azure.mgmt.servicefabricmanagedclusters + - name: Service Linker + href: ~/docs-ref-services/{moniker}/service-linker.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Linker + href: ~/docs-ref-services/{moniker}/mgmt-servicelinker-readme.md + children: + - azure.mgmt.servicelinker + - name: Service Networking + href: ~/docs-ref-services/{moniker}/service-networking.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Networking + href: ~/docs-ref-services/{moniker}/mgmt-servicenetworking-readme.md + children: + - azure.mgmt.servicenetworking + - name: SignalR + href: ~/docs-ref-services/{moniker}/signalr.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SignalR + href: ~/docs-ref-services/{moniker}/mgmt-signalr-readme.md + children: + - azure.mgmt.signalr + - name: Sphere + href: ~/docs-ref-services/{moniker}/sphere.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Sphere + href: ~/docs-ref-services/{moniker}/mgmt-sphere-readme.md + children: + - azure.mgmt.sphere + - name: Spring App Discovery + href: ~/docs-ref-services/{moniker}/spring-app-discovery.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Spring App Discovery + href: ~/docs-ref-services/{moniker}/mgmt-springappdiscovery-readme.md + children: + - azure.mgmt.springappdiscovery + - name: SQL + href: ~/docs-ref-services/{moniker}/sql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SQL + href: ~/docs-ref-services/{moniker}/mgmt-sql-readme.md + children: + - azure.mgmt.sql + - name: SQL Virtual Machine + href: ~/docs-ref-services/{moniker}/sql-virtual-machine.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SQL Virtual Machine + href: ~/docs-ref-services/{moniker}/mgmt-sqlvirtualmachine-readme.md + children: + - azure.mgmt.sqlvirtualmachine + - name: Stack Edge + href: ~/docs-ref-services/{moniker}/stack-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Gateway (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-edgegateway-readme.md + children: + - azure.mgmt.edgegateway + - name: Standby Pool + href: ~/docs-ref-services/{moniker}/standby-pool.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Standby Pool + href: ~/docs-ref-services/{moniker}/mgmt-standbypool-readme.md + children: + - azure.mgmt.standbypool + - name: Storage + href: ~/docs-ref-services/{moniker}/storage.md + landingPageType: Service + items: + - name: Storage - Blobs + href: ~/docs-ref-services/{moniker}/storage-blob-readme.md + children: + - azure.storage.blob + - name: Storage - Blobs Changefeed + href: ~/docs-ref-services/{moniker}/storage-blob-changefeed-readme.md + children: + - azure.storage.blob.changefeed + - name: Storage - Files Data Lake + href: ~/docs-ref-services/{moniker}/storage-file-datalake-readme.md + children: + - azure.storage.filedatalake + - name: Storage - Files Share + href: ~/docs-ref-services/{moniker}/storage-file-share-readme.md + children: + - azure.storage.fileshare + - name: Storage - Queues + href: ~/docs-ref-services/{moniker}/storage-queue-readme.md + children: + - azure.storage.queue + - name: Management + items: + - name: Resource Management - Data Lake Analytics + href: ~/docs-ref-services/{moniker}/mgmt-datalake-analytics-readme.md + children: + - azure.mgmt.datalake.analytics + - name: Resource Management - Data Lake Store + href: ~/docs-ref-services/{moniker}/mgmt-datalake-store-readme.md + children: + - azure.mgmt.datalake.store + - name: Resource Management - Storage + href: ~/docs-ref-services/{moniker}/mgmt-storage-readme.md + children: + - azure.mgmt.storage + - name: Resource Management - Storage Actions + href: ~/docs-ref-services/{moniker}/mgmt-storageactions-readme.md + children: + - azure.mgmt.storageactions + - name: Resource Management - Storage Cache + href: ~/docs-ref-services/{moniker}/mgmt-storagecache-readme.md + children: + - azure.mgmt.storagecache + - name: Resource Management - Storage Import/Export (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-storageimportexport-readme.md + children: + - azure.mgmt.storageimportexport + - name: Resource Management - Storage Mover + href: ~/docs-ref-services/{moniker}/mgmt-storagemover-readme.md + children: + - azure.mgmt.storagemover + - name: Resource Management - Storage Pool + href: ~/docs-ref-services/{moniker}/mgmt-storagepool-readme.md + children: + - azure.mgmt.storagepool + - name: Resource Management - Storage Sync + href: ~/docs-ref-services/{moniker}/mgmt-storagesync-readme.md + children: + - azure.mgmt.storagesync + - name: Storage - Common + href: ~/docs-ref-services/{moniker}/storage---common.md + landingPageType: Service + items: [] + - name: Stream Analytics + href: ~/docs-ref-services/{moniker}/stream-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Stream Analytics + href: ~/docs-ref-services/{moniker}/mgmt-streamanalytics-readme.md + children: + - azure.mgmt.streamanalytics + - name: Subscriptions + href: ~/docs-ref-services/{moniker}/subscriptions.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Subscriptions + href: ~/docs-ref-services/{moniker}/mgmt-subscription-readme.md + children: + - azure.mgmt.subscription + - name: Support + href: ~/docs-ref-services/{moniker}/support.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Support + href: ~/docs-ref-services/{moniker}/mgmt-support-readme.md + children: + - azure.mgmt.support + - name: Synapse + href: ~/docs-ref-services/{moniker}/synapse.md + landingPageType: Service + items: + - name: Synapse (deprecated) + href: ~/docs-ref-services/{moniker}/synapse-readme.md + children: + - azure.synapse + - name: Synapse - AccessControl + href: ~/docs-ref-services/{moniker}/synapse-accesscontrol-readme.md + children: + - azure.synapse.accesscontrol + - name: Managed Private Endpoints + href: ~/docs-ref-services/{moniker}/synapse-managedprivateendpoints-readme.md + children: + - azure.synapse.managedprivateendpoints + - name: Synapse - Monitoring + href: ~/docs-ref-services/{moniker}/synapse-monitoring-readme.md + children: + - azure.synapse.monitoring + - name: Spark + href: ~/docs-ref-services/{moniker}/synapse-spark-readme.md + children: + - azure.synapse.spark + - name: Management + items: + - name: Resource Management - Synapse + href: ~/docs-ref-services/{moniker}/mgmt-synapse-readme.md + children: + - azure.mgmt.synapse + - name: Synapse Analytics + href: ~/docs-ref-services/{moniker}/synapse-analytics.md + landingPageType: Service + items: + - name: Synapse - Artifacts + href: ~/docs-ref-services/{moniker}/synapse-artifacts-readme.md + children: + - azure.synapse.artifacts + - name: Tables + href: ~/docs-ref-services/{moniker}/tables.md + landingPageType: Service + items: + - name: Tables + href: ~/docs-ref-services/{moniker}/data-tables-readme.md + children: + - azure.data.tables + - name: Terraform + href: ~/docs-ref-services/{moniker}/terraform.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Terraform + href: ~/docs-ref-services/{moniker}/mgmt-terraform-readme.md + children: + - azure.mgmt.terraform + - name: Test Base + href: ~/docs-ref-services/{moniker}/test-base.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Test Base (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-testbase-readme.md + children: + - azure.mgmt.testbase + - name: Timezone + href: ~/docs-ref-services/{moniker}/timezone.md + landingPageType: Service + items: + - name: Timezone + href: ~/docs-ref-services/{moniker}/maps-timezone-readme.md + children: + - azure.maps.timezone + - name: Traffic Manager + href: ~/docs-ref-services/{moniker}/traffic-manager.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Traffic Manager + href: ~/docs-ref-services/{moniker}/mgmt-trafficmanager-readme.md + children: + - azure.mgmt.trafficmanager + - name: Trustedsigning + href: ~/docs-ref-services/{moniker}/trustedsigning.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Trustedsigning + href: ~/docs-ref-services/{moniker}/mgmt-trustedsigning-readme.md + children: + - azure.mgmt.trustedsigning + - name: Video Analyzer + href: ~/docs-ref-services/{moniker}/video-analyzer.md + landingPageType: Service + items: + - name: Video Analyzer Edge (deprecated) + href: ~/docs-ref-services/{moniker}/media-videoanalyzer-edge-readme.md + children: + - azure.media.videoanalyzeredge + - name: Video Search + href: ~/docs-ref-services/{moniker}/video-search.md + landingPageType: Service + items: + - name: Video Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-videosearch-readme.md + children: + - azure.cognitiveservices.search.videosearch + - name: Visual Search + href: ~/docs-ref-services/{moniker}/visual-search.md + landingPageType: Service + items: + - name: Visual Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-visualsearch-readme.md + children: + - azure.cognitiveservices.search.visualsearch + - name: VMware Solution by CloudSimple + href: ~/docs-ref-services/{moniker}/vmware-solution-by-cloudsimple.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - VMware Solution by CloudSimple + href: ~/docs-ref-services/{moniker}/mgmt-vmwarecloudsimple-readme.md + children: + - azure.mgmt.vmwarecloudsimple + - name: Voice Services + href: ~/docs-ref-services/{moniker}/voice-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Voice Services + href: ~/docs-ref-services/{moniker}/mgmt-voiceservices-readme.md + children: + - azure.mgmt.voiceservices + - name: Web PubSub + href: ~/docs-ref-services/{moniker}/web-pubsub.md + landingPageType: Service + items: + - name: Web PubSub Client + href: ~/docs-ref-services/{moniker}/messaging-webpubsubclient-readme.md + children: + - azure.messaging.webpubsubclient + - name: Web PubSub + href: ~/docs-ref-services/{moniker}/messaging-webpubsubservice-readme.md + children: + - azure.messaging.webpubsubservice + - name: Management + items: + - name: Resource Management - Web PubSub + href: ~/docs-ref-services/{moniker}/mgmt-webpubsub-readme.md + children: + - azure.mgmt.webpubsub + - name: Web Search + href: ~/docs-ref-services/{moniker}/web-search.md + landingPageType: Service + items: + - name: Web Search (deprecated) + href: ~/docs-ref-services/{moniker}/cognitiveservices-search-websearch-readme.md + children: + - azure.cognitiveservices.search.websearch + - name: Workload Monitor + href: ~/docs-ref-services/{moniker}/workload-monitor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workload Monitor (deprecated) + href: ~/docs-ref-services/{moniker}/mgmt-workloadmonitor-readme.md + children: + - azure.mgmt.workloadmonitor + - name: Workloads + href: ~/docs-ref-services/{moniker}/workloads.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workloads + href: ~/docs-ref-services/{moniker}/mgmt-workloads-readme.md + children: + - azure.mgmt.workloads + - name: Resource Management - Workloads SAP Virtual Instance + href: ~/docs-ref-services/{moniker}/mgmt-workloadssapvirtualinstance-readme.md + children: + - azure.mgmt.workloadssapvirtualinstance + - name: Other + landingPageType: Service + items: + - name: Common (deprecated) + href: ~/docs-ref-services/{moniker}/common-readme.md + children: + - azure.common + - name: Core + landingPageType: Service + items: + - name: Client + landingPageType: Service + items: + - name: Core + href: ~/docs-ref-services/{moniker}/core-readme.md + children: + - azure.core + - name: Core HTTP + href: ~/docs-ref-services/{moniker}/corehttp-readme.md + children: + - corehttp + - name: Experimental + href: ~/docs-ref-services/{moniker}/core-experimental-readme.md + children: + - azure.core.experimental + - name: Tracing Opentelemetry + href: ~/docs-ref-services/{moniker}/core-tracing-opentelemetry-readme.md + children: + - azure.core.tracing.ext.opentelemetry_span + - name: Management + landingPageType: Service + items: + - name: Core + href: ~/docs-ref-services/{moniker}/mgmt-core-readme.md + children: + - azure.mgmt.core + - name: Service Management + landingPageType: Service + items: + - name: Legacy (deprecated) + href: ~/docs-ref-services/{moniker}/servicemanagement-legacy-readme.md + children: + - azure.servicemanagement + - name: Uamqp + href: ~/docs-ref-services/{moniker}/uamqp-readme.md + children: + - uamqp + - name: Uncategorized Packages + landingPageType: Service + children: + - '**' + diff --git a/docs-ref-mapping/reference.yml b/docs-ref-mapping/reference.yml new file mode 100644 index 00000000..b27a100d --- /dev/null +++ b/docs-ref-mapping/reference.yml @@ -0,0 +1,1944 @@ +- name: Reference + landingPageType: Root + expanded: false + items: + - name: Advisor + href: ~/docs-ref-services/latest/advisor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Advisor + href: ~/docs-ref-services/latest/mgmt-advisor-readme.md + children: + - azure.mgmt.advisor + - name: Alerts Management + href: ~/docs-ref-services/latest/alerts-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Alerts Management + href: ~/docs-ref-services/latest/mgmt-alertsmanagement-readme.md + children: + - azure.mgmt.alertsmanagement + - name: API Center + href: ~/docs-ref-services/latest/api-center.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - API Center + href: ~/docs-ref-services/latest/mgmt-apicenter-readme.md + children: + - azure.mgmt.apicenter + - name: App Compliance Automation + href: ~/docs-ref-services/latest/app-compliance-automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Compliance Automation + href: ~/docs-ref-services/latest/mgmt-appcomplianceautomation-readme.md + children: + - azure.mgmt.appcomplianceautomation + - name: App Configuration + href: ~/docs-ref-services/latest/app-configuration.md + landingPageType: Service + items: + - name: App Configuration + href: ~/docs-ref-services/latest/appconfiguration-readme.md + children: + - azure.appconfiguration + - name: App Configuration Provider + href: ~/docs-ref-services/latest/appconfiguration-provider-readme.md + children: + - azure.appconfiguration.provider + - name: Management + items: + - name: Resource Management - App Configuration + href: ~/docs-ref-services/latest/mgmt-appconfiguration-readme.md + children: + - azure.mgmt.appconfiguration + - name: App Platform + href: ~/docs-ref-services/latest/app-platform.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Platform + href: ~/docs-ref-services/latest/mgmt-appplatform-readme.md + children: + - azure.mgmt.appplatform + - name: App Service + href: ~/docs-ref-services/latest/app-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - App Service + href: ~/docs-ref-services/latest/mgmt-web-readme.md + children: + - azure.mgmt.web + - name: Application Insights + href: ~/docs-ref-services/latest/application-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Application Insights + href: ~/docs-ref-services/latest/mgmt-applicationinsights-readme.md + children: + - azure.mgmt.applicationinsights + - name: Arc Data + href: ~/docs-ref-services/latest/arc-data.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Arc Data + href: ~/docs-ref-services/latest/mgmt-azurearcdata-readme.md + children: + - azure.mgmt.azurearcdata + - name: Attestation + href: ~/docs-ref-services/latest/attestation.md + landingPageType: Service + items: + - name: Attestation + href: ~/docs-ref-services/latest/security-attestation-readme.md + children: + - azure.security.attestation + - name: Management + items: + - name: Resource Management - Attestation + href: ~/docs-ref-services/latest/mgmt-attestation-readme.md + children: + - azure.mgmt.attestation + - name: Authorization + href: ~/docs-ref-services/latest/authorization.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Authorization + href: ~/docs-ref-services/latest/mgmt-authorization-readme.md + children: + - azure.mgmt.authorization + - name: Automanage + href: ~/docs-ref-services/latest/automanage.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automanage + href: ~/docs-ref-services/latest/mgmt-automanage-readme.md + children: + - azure.mgmt.automanage + - name: Automation + href: ~/docs-ref-services/latest/automation.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Automation + href: ~/docs-ref-services/latest/mgmt-automation-readme.md + children: + - azure.mgmt.automation + - name: Azure Stack + href: ~/docs-ref-services/latest/azure-stack.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack + href: ~/docs-ref-services/latest/mgmt-azurestack-readme.md + children: + - azure.mgmt.azurestack + - name: Azure Stack HCI + href: ~/docs-ref-services/latest/azure-stack-hci.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure Stack HCI + href: ~/docs-ref-services/latest/mgmt-azurestackhci-readme.md + children: + - azure.mgmt.azurestackhci + - name: Azure VMware Solution + href: ~/docs-ref-services/latest/azure-vmware-solution.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure VMware Solution + href: ~/docs-ref-services/latest/mgmt-avs-readme.md + children: + - azure.mgmt.avs + - name: BareMetal Infrastructure + href: ~/docs-ref-services/latest/baremetal-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - BareMetal Infrastructure + href: ~/docs-ref-services/latest/mgmt-baremetalinfrastructure-readme.md + children: + - azure.mgmt.baremetalinfrastructure + - name: Batch + href: ~/docs-ref-services/latest/batch.md + landingPageType: Service + items: + - name: Batch + href: ~/docs-ref-services/latest/batch-readme.md + children: + - azure.batch + - name: Management + items: + - name: Resource Management - Batch + href: ~/docs-ref-services/latest/mgmt-batch-readme.md + children: + - azure.mgmt.batch + - name: Billing + href: ~/docs-ref-services/latest/billing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Billing + href: ~/docs-ref-services/latest/mgmt-billing-readme.md + children: + - azure.mgmt.billing + - name: Bot Service + href: ~/docs-ref-services/latest/bot-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Bot Service + href: ~/docs-ref-services/latest/mgmt-botservice-readme.md + children: + - azure.mgmt.botservice + - name: Change Analysis + href: ~/docs-ref-services/latest/change-analysis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Change Analysis + href: ~/docs-ref-services/latest/mgmt-changeanalysis-readme.md + children: + - azure.mgmt.changeanalysis + - name: Chaos + href: ~/docs-ref-services/latest/chaos.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Chaos + href: ~/docs-ref-services/latest/mgmt-chaos-readme.md + children: + - azure.mgmt.chaos + - name: Cognitive Services + href: ~/docs-ref-services/latest/cognitive-services.md + landingPageType: Service + items: + - name: Content Safety + href: ~/docs-ref-services/latest/ai-contentsafety-readme.md + children: + - azure.ai.contentsafety + - name: Document Intelligence + href: ~/docs-ref-services/latest/ai-documentintelligence-readme.md + children: + - azure.ai.documentintelligence + - name: AI Evaluation + href: ~/docs-ref-services/latest/ai-evaluation-readme.md + children: + - azure.ai.evaluation + - name: Form Recognizer + href: ~/docs-ref-services/latest/ai-formrecognizer-readme.md + children: + - azure.ai.formrecognizer + - name: Conversational Language Understanding + href: ~/docs-ref-services/latest/ai-language-conversations-readme.md + children: + - azure.ai.language.conversations + - name: Question Answering + href: ~/docs-ref-services/latest/ai-language-questionanswering-readme.md + children: + - azure.ai.language.questionanswering + - name: Text Analytics + href: ~/docs-ref-services/latest/ai-textanalytics-readme.md + children: + - azure.ai.textanalytics + - name: Document Translation + href: ~/docs-ref-services/latest/ai-translation-document-readme.md + children: + - azure.ai.translation.document + - name: Text Translation + href: ~/docs-ref-services/latest/ai-translation-text-readme.md + children: + - azure.ai.translation.text + - name: Image Analysis + href: ~/docs-ref-services/latest/ai-vision-imageanalysis-readme.md + children: + - azure.ai.vision.imageanalysis + - name: Speech + children: + - azure.cognitiveservices.speech + landingPageType: Service + - name: Health Insights Radiology Insights + href: ~/docs-ref-services/latest/healthinsights-radiologyinsights-readme.md + children: + - azure.healthinsights.radiologyinsights + - name: Management + items: + - name: Resource Management - Cognitive Services + href: ~/docs-ref-services/latest/mgmt-cognitiveservices-readme.md + children: + - azure.mgmt.cognitiveservices + - name: Commerce + href: ~/docs-ref-services/latest/commerce.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Commerce + href: ~/docs-ref-services/latest/mgmt-commerce-readme.md + children: + - azure.mgmt.commerce + - name: Communication + href: ~/docs-ref-services/latest/communication.md + landingPageType: Service + items: + - name: Communication Call Automation + href: ~/docs-ref-services/latest/communication-callautomation-readme.md + children: + - azure.communication.callautomation + - name: Communication Chat + href: ~/docs-ref-services/latest/communication-chat-readme.md + children: + - azure.communication.chat + - name: Communication Email + href: ~/docs-ref-services/latest/communication-email-readme.md + children: + - azure.communication.email + - name: Communication Identity + href: ~/docs-ref-services/latest/communication-identity-readme.md + children: + - azure.communication.identity + - name: Communication JobRouter + href: ~/docs-ref-services/latest/communication-jobrouter-readme.md + children: + - azure.communication.jobrouter + - name: Communication Messages + href: ~/docs-ref-services/latest/communication-messages-readme.md + children: + - azure.communication.messages + - name: Communication Phone Numbers + href: ~/docs-ref-services/latest/communication-phonenumbers-readme.md + children: + - azure.communication.phonenumbers + - name: Communication Rooms + href: ~/docs-ref-services/latest/communication-rooms-readme.md + children: + - azure.communication.rooms + - name: Communication Sms + href: ~/docs-ref-services/latest/communication-sms-readme.md + children: + - azure.communication.sms + - name: Management + items: + - name: Resource Management - Communication + href: ~/docs-ref-services/latest/mgmt-communication-readme.md + children: + - azure.mgmt.communication + - name: Compute + href: ~/docs-ref-services/latest/compute.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Compute + href: ~/docs-ref-services/latest/mgmt-compute-readme.md + children: + - azure.mgmt.compute + - name: Compute Fleet + href: ~/docs-ref-services/latest/compute-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Compute Fleet + href: ~/docs-ref-services/latest/mgmt-computefleet-readme.md + children: + - azure.mgmt.computefleet + - name: Computeschedule + href: ~/docs-ref-services/latest/computeschedule.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Computeschedule + href: ~/docs-ref-services/latest/mgmt-computeschedule-readme.md + children: + - azure.mgmt.computeschedule + - name: Confidential Ledger + href: ~/docs-ref-services/latest/confidential-ledger.md + landingPageType: Service + items: + - name: Confidential Ledger + href: ~/docs-ref-services/latest/confidentialledger-readme.md + children: + - azure.confidentialledger + - name: Management + items: + - name: Resource Management - Confidential Ledger + href: ~/docs-ref-services/latest/mgmt-confidentialledger-readme.md + children: + - azure.mgmt.confidentialledger + - name: Confluent + href: ~/docs-ref-services/latest/confluent.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Confluent + href: ~/docs-ref-services/latest/mgmt-confluent-readme.md + children: + - azure.mgmt.confluent + - name: Connected VMware + href: ~/docs-ref-services/latest/connected-vmware.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Connected VMware + href: ~/docs-ref-services/latest/mgmt-connectedvmware-readme.md + children: + - azure.mgmt.connectedvmware + - name: Consumption + href: ~/docs-ref-services/latest/consumption.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Consumption + href: ~/docs-ref-services/latest/mgmt-consumption-readme.md + children: + - azure.mgmt.consumption + - name: Container Apps + href: ~/docs-ref-services/latest/container-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Apps + href: ~/docs-ref-services/latest/mgmt-appcontainers-readme.md + children: + - azure.mgmt.appcontainers + - name: Container Instances + href: ~/docs-ref-services/latest/container-instances.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Instances + href: ~/docs-ref-services/latest/mgmt-containerinstance-readme.md + children: + - azure.mgmt.containerinstance + - name: Container Registry + href: ~/docs-ref-services/latest/container-registry.md + landingPageType: Service + items: + - name: Container Registry + href: ~/docs-ref-services/latest/containerregistry-readme.md + children: + - azure.containerregistry + - name: Management + items: + - name: Resource Management - Container Registry + href: ~/docs-ref-services/latest/mgmt-containerregistry-readme.md + children: + - azure.mgmt.containerregistry + - name: Container Service + href: ~/docs-ref-services/latest/container-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Service + href: ~/docs-ref-services/latest/mgmt-containerservice-readme.md + children: + - azure.mgmt.containerservice + - name: Container Service Fleet + href: ~/docs-ref-services/latest/container-service-fleet.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Container Service Fleet + href: ~/docs-ref-services/latest/mgmt-containerservicefleet-readme.md + children: + - azure.mgmt.containerservicefleet + - name: Content Delivery Network + href: ~/docs-ref-services/latest/content-delivery-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Content Delivery Network + href: ~/docs-ref-services/latest/mgmt-cdn-readme.md + children: + - azure.mgmt.cdn + - name: Cosmos DB + href: ~/docs-ref-services/latest/cosmos-db.md + landingPageType: Service + items: + - name: Cosmos DB + href: ~/docs-ref-services/latest/cosmos-readme.md + children: + - azure.cosmos + - name: Management + items: + - name: Resource Management - Cosmos DB + href: ~/docs-ref-services/latest/mgmt-cosmosdb-readme.md + children: + - azure.mgmt.cosmosdb + - name: Cosmos DB for PostgreSQL + href: ~/docs-ref-services/latest/cosmos-db-for-postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Cosmos DB for PostgreSQL + href: ~/docs-ref-services/latest/mgmt-cosmosdbforpostgresql-readme.md + children: + - azure.mgmt.cosmosdbforpostgresql + - name: Cost Management + href: ~/docs-ref-services/latest/cost-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Cost Management + href: ~/docs-ref-services/latest/mgmt-costmanagement-readme.md + children: + - azure.mgmt.costmanagement + - name: Custom Providers + href: ~/docs-ref-services/latest/custom-providers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Custom Providers + children: + - azure.mgmt.customproviders + landingPageType: Service + - name: Data Box + href: ~/docs-ref-services/latest/data-box.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Box + href: ~/docs-ref-services/latest/mgmt-databox-readme.md + children: + - azure.mgmt.databox + - name: Data Box Edge + href: ~/docs-ref-services/latest/data-box-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Box Edge + href: ~/docs-ref-services/latest/mgmt-databoxedge-readme.md + children: + - azure.mgmt.databoxedge + - name: Data Explorer + href: ~/docs-ref-services/latest/data-explorer.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Kusto + href: ~/docs-ref-services/latest/mgmt-kusto-readme.md + children: + - azure.mgmt.kusto + - name: Data Factory + href: ~/docs-ref-services/latest/data-factory.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Factory + href: ~/docs-ref-services/latest/mgmt-datafactory-readme.md + children: + - azure.mgmt.datafactory + - name: Data Protection + href: ~/docs-ref-services/latest/data-protection.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Protection + href: ~/docs-ref-services/latest/mgmt-dataprotection-readme.md + children: + - azure.mgmt.dataprotection + - name: Data Share + href: ~/docs-ref-services/latest/data-share.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Share + href: ~/docs-ref-services/latest/mgmt-datashare-readme.md + children: + - azure.mgmt.datashare + - name: Database Migration Service + href: ~/docs-ref-services/latest/database-migration-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Data Migration + href: ~/docs-ref-services/latest/mgmt-datamigration-readme.md + children: + - azure.mgmt.datamigration + - name: Databricks + href: ~/docs-ref-services/latest/databricks.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Databricks + href: ~/docs-ref-services/latest/mgmt-databricks-readme.md + children: + - azure.mgmt.databricks + - name: Datadog + href: ~/docs-ref-services/latest/datadog.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Datadog + href: ~/docs-ref-services/latest/mgmt-datadog-readme.md + children: + - azure.mgmt.datadog + - name: Deployment Manager + href: ~/docs-ref-services/latest/deployment-manager.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Deployment Manager + href: ~/docs-ref-services/latest/mgmt-deploymentmanager-readme.md + children: + - azure.mgmt.deploymentmanager + - name: Desktop Virtualization + href: ~/docs-ref-services/latest/desktop-virtualization.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Desktop Virtualization + href: ~/docs-ref-services/latest/mgmt-desktopvirtualization-readme.md + children: + - azure.mgmt.desktopvirtualization + - name: Dev Center + href: ~/docs-ref-services/latest/dev-center.md + landingPageType: Service + items: + - name: Dev Center + href: ~/docs-ref-services/latest/developer-devcenter-readme.md + children: + - azure.developer.devcenter + - name: Management + items: + - name: Resource Management - Dev Center + href: ~/docs-ref-services/latest/mgmt-devcenter-readme.md + children: + - azure.mgmt.devcenter + - name: Device Registry + href: ~/docs-ref-services/latest/device-registry.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Device Registry + href: ~/docs-ref-services/latest/mgmt-deviceregistry-readme.md + children: + - azure.mgmt.deviceregistry + - name: DevOps Infrastructure + href: ~/docs-ref-services/latest/devops-infrastructure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevOps Infrastructure + href: ~/docs-ref-services/latest/mgmt-devopsinfrastructure-readme.md + children: + - azure.mgmt.devopsinfrastructure + - name: DevTest Labs + href: ~/docs-ref-services/latest/devtest-labs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DevTest Labs + href: ~/docs-ref-services/latest/mgmt-devtestlabs-readme.md + children: + - azure.mgmt.devtestlabs + - name: DNS + href: ~/docs-ref-services/latest/dns.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DNS + href: ~/docs-ref-services/latest/mgmt-dns-readme.md + children: + - azure.mgmt.dns + - name: DNS Resolver + href: ~/docs-ref-services/latest/dns-resolver.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - DNS Resolver + href: ~/docs-ref-services/latest/mgmt-dnsresolver-readme.md + children: + - azure.mgmt.dnsresolver + - name: Dynatrace + href: ~/docs-ref-services/latest/dynatrace.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Dynatrace + href: ~/docs-ref-services/latest/mgmt-dynatrace-readme.md + children: + - azure.mgmt.dynatrace + - name: Edge Order + href: ~/docs-ref-services/latest/edge-order.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Order + href: ~/docs-ref-services/latest/mgmt-edgeorder-readme.md + children: + - azure.mgmt.edgeorder + - name: Edge Zones + href: ~/docs-ref-services/latest/edge-zones.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Zones + href: ~/docs-ref-services/latest/mgmt-edgezones-readme.md + children: + - azure.mgmt.edgezones + - name: Elastic + href: ~/docs-ref-services/latest/elastic.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic + href: ~/docs-ref-services/latest/mgmt-elastic-readme.md + children: + - azure.mgmt.elastic + - name: Elastic SAN + href: ~/docs-ref-services/latest/elastic-san.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Elastic SAN + href: ~/docs-ref-services/latest/mgmt-elasticsan-readme.md + children: + - azure.mgmt.elasticsan + - name: Entity Search + href: ~/docs-ref-services/latest/entity-search.md + landingPageType: Service + items: + - name: Entity Search (deprecated) + children: + - azure.cognitiveservices.search.entitysearch + landingPageType: Service + - name: Event Grid + href: ~/docs-ref-services/latest/event-grid.md + landingPageType: Service + items: + - name: Event Grid + href: ~/docs-ref-services/latest/eventgrid-readme.md + children: + - azure.eventgrid + - name: Management + items: + - name: Resource Management - Event Grid + href: ~/docs-ref-services/latest/mgmt-eventgrid-readme.md + children: + - azure.mgmt.eventgrid + - name: Event Hubs + href: ~/docs-ref-services/latest/event-hubs.md + landingPageType: Service + items: + - name: Event Hubs + href: ~/docs-ref-services/latest/eventhub-readme.md + children: + - azure.eventhub + - name: Azure Blob Storage Checkpoint Store + href: ~/docs-ref-services/latest/eventhub-checkpointstoreblob-readme.md + children: + - azure.eventhub.extensions.checkpointstoreblob + - name: Azure Blob Storage Checkpoint Store AIO + href: ~/docs-ref-services/latest/eventhub-checkpointstoreblob-aio-readme.md + children: + - azure.eventhub.extensions.checkpointstoreblobaio + - name: Management + items: + - name: Resource Management - Event Hubs + href: ~/docs-ref-services/latest/mgmt-eventhub-readme.md + children: + - azure.mgmt.eventhub + - name: Extended Location + href: ~/docs-ref-services/latest/extended-location.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Extended Location + href: ~/docs-ref-services/latest/mgmt-extendedlocation-readme.md + children: + - azure.mgmt.extendedlocation + - name: Fabric + href: ~/docs-ref-services/latest/fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fabric + href: ~/docs-ref-services/latest/mgmt-fabric-readme.md + children: + - azure.mgmt.fabric + - name: Fluid Relay + href: ~/docs-ref-services/latest/fluid-relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Fluid Relay + href: ~/docs-ref-services/latest/mgmt-fluidrelay-readme.md + children: + - azure.mgmt.fluidrelay + - name: Front Door + href: ~/docs-ref-services/latest/front-door.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Front Door + href: ~/docs-ref-services/latest/mgmt-frontdoor-readme.md + children: + - azure.mgmt.frontdoor + - name: Functions + href: ~/docs-ref-services/latest/functions.md + landingPageType: Service + items: + - name: Functions + children: + - azure.functions + landingPageType: Service + - name: Durable Functions + children: + - azure.durable_functions + landingPageType: Service + - name: Grafana + href: ~/docs-ref-services/latest/grafana.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Grafana + href: ~/docs-ref-services/latest/mgmt-dashboard-readme.md + children: + - azure.mgmt.dashboard + - name: Graph Services + href: ~/docs-ref-services/latest/graph-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Graph Services + href: ~/docs-ref-services/latest/mgmt-graphservices-readme.md + children: + - azure.mgmt.graphservices + - name: HANA on Azure + href: ~/docs-ref-services/latest/hana-on-azure.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HANA on Azure + href: ~/docs-ref-services/latest/mgmt-hanaonazure-readme.md + children: + - azure.mgmt.hanaonazure + - name: HDInsight + href: ~/docs-ref-services/latest/hdinsight.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - HDInsight + href: ~/docs-ref-services/latest/mgmt-hdinsight-readme.md + children: + - azure.mgmt.hdinsight + - name: Health Data AI Services + href: ~/docs-ref-services/latest/health-data-ai-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Health Data AI Services + href: ~/docs-ref-services/latest/mgmt-healthdataaiservices-readme.md + children: + - azure.mgmt.healthdataaiservices + - name: Healthcare APIs + href: ~/docs-ref-services/latest/healthcare-apis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Healthcare APIs + href: ~/docs-ref-services/latest/mgmt-healthcareapis-readme.md + children: + - azure.mgmt.healthcareapis + - name: Hybrid Compute + href: ~/docs-ref-services/latest/hybrid-compute.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Compute + href: ~/docs-ref-services/latest/mgmt-hybridcompute-readme.md + children: + - azure.mgmt.hybridcompute + - name: Hybrid Connectivity + href: ~/docs-ref-services/latest/hybrid-connectivity.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Connectivity + href: ~/docs-ref-services/latest/mgmt-hybridconnectivity-readme.md + children: + - azure.mgmt.hybridconnectivity + - name: Hybrid Container Service + href: ~/docs-ref-services/latest/hybrid-container-service.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Container Service + href: ~/docs-ref-services/latest/mgmt-hybridcontainerservice-readme.md + children: + - azure.mgmt.hybridcontainerservice + - name: Hybrid Kubernetes + href: ~/docs-ref-services/latest/hybrid-kubernetes.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Kubernetes + href: ~/docs-ref-services/latest/mgmt-hybridkubernetes-readme.md + children: + - azure.mgmt.hybridkubernetes + - name: Hybrid Network + href: ~/docs-ref-services/latest/hybrid-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Hybrid Network + href: ~/docs-ref-services/latest/mgmt-hybridnetwork-readme.md + children: + - azure.mgmt.hybridnetwork + - name: Identity + href: ~/docs-ref-services/latest/identity.md + landingPageType: Service + items: + - name: Identity + href: ~/docs-ref-services/latest/identity-readme.md + children: + - azure.identity + - name: Identity Broker + href: ~/docs-ref-services/latest/identity-broker-readme.md + children: + - azure.identity.broker + - name: Image Builder + href: ~/docs-ref-services/latest/image-builder.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Image Builder + href: ~/docs-ref-services/latest/mgmt-imagebuilder-readme.md + children: + - azure.mgmt.imagebuilder + - name: Image Search + href: ~/docs-ref-services/latest/image-search.md + landingPageType: Service + items: + - name: Image Search (deprecated) + children: + - azure.cognitiveservices.search.imagesearch + landingPageType: Service + - name: Informatica Data Management + href: ~/docs-ref-services/latest/informatica-data-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Informatica Data Management + href: ~/docs-ref-services/latest/mgmt-informaticadatamanagement-readme.md + children: + - azure.mgmt.informaticadatamanagement + - name: IoT + href: ~/docs-ref-services/latest/iot.md + landingPageType: Service + items: + - name: Digital Twins + href: ~/docs-ref-services/latest/digitaltwins-core-readme.md + children: + - azure.digitaltwins.core + - name: IoT Device + children: + - azure.iot.device + landingPageType: Service + - name: Device Update + href: ~/docs-ref-services/latest/iot-deviceupdate-readme.md + children: + - azure.iot.deviceupdate + - name: IoT Hub + children: + - azure.iot.hub + landingPageType: Service + - name: Management + items: + - name: Resource Management - Device Update + href: ~/docs-ref-services/latest/mgmt-deviceupdate-readme.md + children: + - azure.mgmt.deviceupdate + - name: Resource Management - Digital Twins + href: ~/docs-ref-services/latest/mgmt-digitaltwins-readme.md + children: + - azure.mgmt.digitaltwins + - name: Resource Management - IoT Central + href: ~/docs-ref-services/latest/mgmt-iotcentral-readme.md + children: + - azure.mgmt.iotcentral + - name: Resource Management - IoT Firmware Defense + href: ~/docs-ref-services/latest/mgmt-iotfirmwaredefense-readme.md + children: + - azure.mgmt.iotfirmwaredefense + - name: Resource Management - IoT Hub + href: ~/docs-ref-services/latest/mgmt-iothub-readme.md + children: + - azure.mgmt.iothub + - name: Resource Management - Device Provisioning Services + href: ~/docs-ref-services/latest/mgmt-iothubprovisioningservices-readme.md + children: + - azure.mgmt.iothubprovisioningservices + - name: Resource Management - Time Series Insights + href: ~/docs-ref-services/latest/mgmt-timeseriesinsights-readme.md + children: + - azure.mgmt.timeseriesinsights + - name: Iotoperations + href: ~/docs-ref-services/latest/iotoperations.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Iotoperations + href: ~/docs-ref-services/latest/mgmt-iotoperations-readme.md + children: + - azure.mgmt.iotoperations + - name: Key Vault + href: ~/docs-ref-services/latest/key-vault.md + landingPageType: Service + items: + - name: Key Vault - Administration + href: ~/docs-ref-services/latest/keyvault-administration-readme.md + children: + - azure.keyvault.administration + - name: Key Vault - Certificates + href: ~/docs-ref-services/latest/keyvault-certificates-readme.md + children: + - azure.keyvault.certificates + - name: Key Vault - Keys + href: ~/docs-ref-services/latest/keyvault-keys-readme.md + children: + - azure.keyvault.keys + - name: Key Vault - Secrets + href: ~/docs-ref-services/latest/keyvault-secrets-readme.md + children: + - azure.keyvault.secrets + - name: Management + items: + - name: Resource Management - Key Vault + href: ~/docs-ref-services/latest/mgmt-keyvault-readme.md + children: + - azure.mgmt.keyvault + - name: Kubernetes Configuration + href: ~/docs-ref-services/latest/kubernetes-configuration.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Kubernetes Configuration + href: ~/docs-ref-services/latest/mgmt-kubernetesconfiguration-readme.md + children: + - azure.mgmt.kubernetesconfiguration + - name: Lab Services + href: ~/docs-ref-services/latest/lab-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Lab Services + href: ~/docs-ref-services/latest/mgmt-labservices-readme.md + children: + - azure.mgmt.labservices + - name: Load Testing + href: ~/docs-ref-services/latest/load-testing.md + landingPageType: Service + items: + - name: Load Testing + href: ~/docs-ref-services/latest/developer-loadtesting-readme.md + children: + - azure.developer.loadtesting + - name: Management + items: + - name: Resource Management - Load Testing + href: ~/docs-ref-services/latest/mgmt-loadtesting-readme.md + children: + - azure.mgmt.loadtesting + - name: Log Analytics + href: ~/docs-ref-services/latest/log-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Log Analytics + href: ~/docs-ref-services/latest/mgmt-loganalytics-readme.md + children: + - azure.mgmt.loganalytics + - name: Logic Apps + href: ~/docs-ref-services/latest/logic-apps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logic Apps + href: ~/docs-ref-services/latest/mgmt-logic-readme.md + children: + - azure.mgmt.logic + - name: Machine Learning + href: ~/docs-ref-services/latest/machine-learning.md + landingPageType: Service + items: + - name: Machine Learning + href: ~/docs-ref-services/latest/ai-ml-readme.md + children: + - azure.ai.ml + - name: Management + items: + - name: Resource Management - Machine Learning Services + href: ~/docs-ref-services/latest/mgmt-machinelearningservices-readme.md + children: + - azure.mgmt.machinelearningservices + - name: Maintenance + href: ~/docs-ref-services/latest/maintenance.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Maintenance + href: ~/docs-ref-services/latest/mgmt-maintenance-readme.md + children: + - azure.mgmt.maintenance + - name: Managed Network Fabric + href: ~/docs-ref-services/latest/managed-network-fabric.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Network Fabric + href: ~/docs-ref-services/latest/mgmt-managednetworkfabric-readme.md + children: + - azure.mgmt.managednetworkfabric + - name: Managed Service Identity + href: ~/docs-ref-services/latest/managed-service-identity.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Service Identity + href: ~/docs-ref-services/latest/mgmt-msi-readme.md + children: + - azure.mgmt.msi + - name: Managed Services + href: ~/docs-ref-services/latest/managed-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Managed Services + href: ~/docs-ref-services/latest/mgmt-managedservices-readme.md + children: + - azure.mgmt.managedservices + - name: Management Groups + href: ~/docs-ref-services/latest/management-groups.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Groups + href: ~/docs-ref-services/latest/mgmt-managementgroups-readme.md + children: + - azure.mgmt.managementgroups + - name: Management Partner + href: ~/docs-ref-services/latest/management-partner.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Management Partner + href: ~/docs-ref-services/latest/mgmt-managementpartner-readme.md + children: + - azure.mgmt.managementpartner + - name: Maps + href: ~/docs-ref-services/latest/maps.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Maps + href: ~/docs-ref-services/latest/mgmt-maps-readme.md + children: + - azure.mgmt.maps + - name: Marketplace Ordering + href: ~/docs-ref-services/latest/marketplace-ordering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Marketplace Ordering + href: ~/docs-ref-services/latest/mgmt-marketplaceordering-readme.md + children: + - azure.mgmt.marketplaceordering + - name: Media Services + href: ~/docs-ref-services/latest/media-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Media Services + href: ~/docs-ref-services/latest/mgmt-media-readme.md + children: + - azure.mgmt.media + - name: Mixed Reality + href: ~/docs-ref-services/latest/mixed-reality.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mixed Reality + href: ~/docs-ref-services/latest/mgmt-mixedreality-readme.md + children: + - azure.mgmt.mixedreality + - name: Mobile Network + href: ~/docs-ref-services/latest/mobile-network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mobile Network + href: ~/docs-ref-services/latest/mgmt-mobilenetwork-readme.md + children: + - azure.mgmt.mobilenetwork + - name: Mongo Cluster + href: ~/docs-ref-services/latest/mongo-cluster.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Mongo Cluster + href: ~/docs-ref-services/latest/mgmt-mongocluster-readme.md + children: + - azure.mgmt.mongocluster + - name: Monitor + href: ~/docs-ref-services/latest/monitor.md + landingPageType: Service + items: + - name: Monitor Ingestion + href: ~/docs-ref-services/latest/monitor-ingestion-readme.md + children: + - azure.monitor.ingestion + - name: Azure Monitor OpenTelemetry + href: ~/docs-ref-services/latest/monitor-opentelemetry-readme.md + children: + - azure.monitor.opentelemetry + - name: Monitor Query + href: ~/docs-ref-services/latest/monitor-query-readme.md + children: + - azure.monitor.query + - name: Management + items: + - name: Resource Management - Monitor + href: ~/docs-ref-services/latest/mgmt-monitor-readme.md + children: + - azure.mgmt.monitor + - name: NetApp Files + href: ~/docs-ref-services/latest/netapp-files.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - NetApp Files + href: ~/docs-ref-services/latest/mgmt-netapp-readme.md + children: + - azure.mgmt.netapp + - name: Network + href: ~/docs-ref-services/latest/network.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network + href: ~/docs-ref-services/latest/mgmt-network-readme.md + children: + - azure.mgmt.network + - name: New Relic Observability + href: ~/docs-ref-services/latest/new-relic-observability.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - New Relic Observability + href: ~/docs-ref-services/latest/mgmt-newrelicobservability-readme.md + children: + - azure.mgmt.newrelicobservability + - name: Nginx + href: ~/docs-ref-services/latest/nginx.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Nginx + href: ~/docs-ref-services/latest/mgmt-nginx-readme.md + children: + - azure.mgmt.nginx + - name: Notification Hubs + href: ~/docs-ref-services/latest/notification-hubs.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Notification Hubs + href: ~/docs-ref-services/latest/mgmt-notificationhubs-readme.md + children: + - azure.mgmt.notificationhubs + - name: Operations Management + href: ~/docs-ref-services/latest/operations-management.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Operations Management + href: ~/docs-ref-services/latest/mgmt-operationsmanagement-readme.md + children: + - azure.mgmt.operationsmanagement + - name: Operator Nexus - Network Cloud + href: ~/docs-ref-services/latest/operator-nexus---network-cloud.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Networkcloud + href: ~/docs-ref-services/latest/mgmt-networkcloud-readme.md + children: + - azure.mgmt.networkcloud + - name: Oracle Database + href: ~/docs-ref-services/latest/oracle-database.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Oracle Database + href: ~/docs-ref-services/latest/mgmt-oracledatabase-readme.md + children: + - azure.mgmt.oracledatabase + - name: Orbital + href: ~/docs-ref-services/latest/orbital.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Orbital + href: ~/docs-ref-services/latest/mgmt-orbital-readme.md + children: + - azure.mgmt.orbital + - name: Palo Alto Networks + href: ~/docs-ref-services/latest/palo-alto-networks.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Palo Alto Networks - Next Generation Firewall + href: ~/docs-ref-services/latest/mgmt-paloaltonetworksngfw-readme.md + children: + - azure.mgmt.paloaltonetworksngfw + - name: Peering + href: ~/docs-ref-services/latest/peering.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Peering + href: ~/docs-ref-services/latest/mgmt-peering-readme.md + children: + - azure.mgmt.peering + - name: Playwright Testing + href: ~/docs-ref-services/latest/playwright-testing.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Playwright Testing + href: ~/docs-ref-services/latest/mgmt-playwrighttesting-readme.md + children: + - azure.mgmt.playwrighttesting + - name: Policy Insights + href: ~/docs-ref-services/latest/policy-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Policy Insights + href: ~/docs-ref-services/latest/mgmt-policyinsights-readme.md + children: + - azure.mgmt.policyinsights + - name: Portal + href: ~/docs-ref-services/latest/portal.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Portal + href: ~/docs-ref-services/latest/mgmt-portal-readme.md + children: + - azure.mgmt.portal + - name: PostgreSQL + href: ~/docs-ref-services/latest/postgresql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - PostgreSQL + href: ~/docs-ref-services/latest/mgmt-rdbms-readme.md + children: + - azure.mgmt.rdbms + - name: Postgresqlflexibleservers + href: ~/docs-ref-services/latest/postgresqlflexibleservers.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Postgresqlflexibleservers + href: ~/docs-ref-services/latest/mgmt-postgresqlflexibleservers-readme.md + children: + - azure.mgmt.postgresqlflexibleservers + - name: Power BI Dedicated + href: ~/docs-ref-services/latest/power-bi-dedicated.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Power BI Dedicated + href: ~/docs-ref-services/latest/mgmt-powerbidedicated-readme.md + children: + - azure.mgmt.powerbidedicated + - name: Private DNS + href: ~/docs-ref-services/latest/private-dns.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Private DNS + href: ~/docs-ref-services/latest/mgmt-privatedns-readme.md + children: + - azure.mgmt.privatedns + - name: Purview + href: ~/docs-ref-services/latest/purview.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Purview + href: ~/docs-ref-services/latest/mgmt-purview-readme.md + children: + - azure.mgmt.purview + - name: Qumulo + href: ~/docs-ref-services/latest/qumulo.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Qumulo + href: ~/docs-ref-services/latest/mgmt-qumulo-readme.md + children: + - azure.mgmt.qumulo + - name: Quota + href: ~/docs-ref-services/latest/quota.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Quota + href: ~/docs-ref-services/latest/mgmt-quota-readme.md + children: + - azure.mgmt.quota + - name: Recovery Services + href: ~/docs-ref-services/latest/recovery-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Recovery Services + href: ~/docs-ref-services/latest/mgmt-recoveryservices-readme.md + children: + - azure.mgmt.recoveryservices + - name: Resource Management - Recovery Services Backup + href: ~/docs-ref-services/latest/mgmt-recoveryservicesbackup-readme.md + children: + - azure.mgmt.recoveryservicesbackup + - name: Resource Management - Recovery Services Site Recovery + href: ~/docs-ref-services/latest/mgmt-recoveryservicessiterecovery-readme.md + children: + - azure.mgmt.recoveryservicessiterecovery + - name: Red Hat OpenShift (ARO) + href: ~/docs-ref-services/latest/red-hat-openshift-(aro).md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Red Hat OpenShift + href: ~/docs-ref-services/latest/mgmt-redhatopenshift-readme.md + children: + - azure.mgmt.redhatopenshift + - name: Redis + href: ~/docs-ref-services/latest/redis.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Redis + href: ~/docs-ref-services/latest/mgmt-redis-readme.md + children: + - azure.mgmt.redis + - name: Resource Management - Redis Enterprise + href: ~/docs-ref-services/latest/mgmt-redisenterprise-readme.md + children: + - azure.mgmt.redisenterprise + - name: Relay + href: ~/docs-ref-services/latest/relay.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Relay + href: ~/docs-ref-services/latest/mgmt-relay-readme.md + children: + - azure.mgmt.relay + - name: Resource Connector + href: ~/docs-ref-services/latest/resource-connector.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Connector + href: ~/docs-ref-services/latest/mgmt-resourceconnector-readme.md + children: + - azure.mgmt.resourceconnector + - name: Resource Graph + href: ~/docs-ref-services/latest/resource-graph.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Graph + href: ~/docs-ref-services/latest/mgmt-resourcegraph-readme.md + children: + - azure.mgmt.resourcegraph + - name: Resource Mover + href: ~/docs-ref-services/latest/resource-mover.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Mover + href: ~/docs-ref-services/latest/mgmt-resourcemover-readme.md + children: + - azure.mgmt.resourcemover + - name: Resources + href: ~/docs-ref-services/latest/resources.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resources + href: ~/docs-ref-services/latest/mgmt-resource-readme.md + children: + - azure.mgmt.resource + - name: Schema Registry + href: ~/docs-ref-services/latest/schema-registry.md + landingPageType: Service + items: + - name: Schema Registry + href: ~/docs-ref-services/latest/schemaregistry-readme.md + children: + - azure.schemaregistry + - name: Schema Registry - Avro + href: ~/docs-ref-services/latest/schemaregistry-avroencoder-readme.md + children: + - azure.schemaregistry.encoder.avroencoder + - name: Scvmm + href: ~/docs-ref-services/latest/scvmm.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scvmm + href: ~/docs-ref-services/latest/mgmt-scvmm-readme.md + children: + - azure.mgmt.scvmm + - name: Search + href: ~/docs-ref-services/latest/search.md + landingPageType: Service + items: + - name: Azure AI Search + href: ~/docs-ref-services/latest/search-documents-readme.md + children: + - azure.search.documents + - name: Management + items: + - name: Resource Management - Azure AI Search + href: ~/docs-ref-services/latest/mgmt-search-readme.md + children: + - azure.mgmt.search + - name: Security + href: ~/docs-ref-services/latest/security.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security + href: ~/docs-ref-services/latest/mgmt-security-readme.md + children: + - azure.mgmt.security + - name: Security Insights + href: ~/docs-ref-services/latest/security-insights.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Security Insights + href: ~/docs-ref-services/latest/mgmt-securityinsight-readme.md + children: + - azure.mgmt.securityinsight + - name: Self Help + href: ~/docs-ref-services/latest/self-help.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Self Help + href: ~/docs-ref-services/latest/mgmt-selfhelp-readme.md + children: + - azure.mgmt.selfhelp + - name: Serial Console + href: ~/docs-ref-services/latest/serial-console.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Serial Console + href: ~/docs-ref-services/latest/mgmt-serialconsole-readme.md + children: + - azure.mgmt.serialconsole + - name: Service Bus + href: ~/docs-ref-services/latest/service-bus.md + landingPageType: Service + items: + - name: Service Bus + href: ~/docs-ref-services/latest/servicebus-readme.md + children: + - azure.servicebus + - name: Management + items: + - name: Resource Management - Service Bus + href: ~/docs-ref-services/latest/mgmt-servicebus-readme.md + children: + - azure.mgmt.servicebus + - name: Service Fabric + href: ~/docs-ref-services/latest/service-fabric.md + landingPageType: Service + items: + - name: Service Fabric + href: ~/docs-ref-services/latest/servicefabric-readme.md + children: + - azure.servicefabric + - name: Management + items: + - name: Resource Management - Service Fabric + href: ~/docs-ref-services/latest/mgmt-servicefabric-readme.md + children: + - azure.mgmt.servicefabric + - name: Resource Management - Service Fabric Managed Clusters + href: ~/docs-ref-services/latest/mgmt-servicefabricmanagedclusters-readme.md + children: + - azure.mgmt.servicefabricmanagedclusters + - name: Service Linker + href: ~/docs-ref-services/latest/service-linker.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Linker + href: ~/docs-ref-services/latest/mgmt-servicelinker-readme.md + children: + - azure.mgmt.servicelinker + - name: Service Networking + href: ~/docs-ref-services/latest/service-networking.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Service Networking + href: ~/docs-ref-services/latest/mgmt-servicenetworking-readme.md + children: + - azure.mgmt.servicenetworking + - name: Sphere + href: ~/docs-ref-services/latest/sphere.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Sphere + href: ~/docs-ref-services/latest/mgmt-sphere-readme.md + children: + - azure.mgmt.sphere + - name: SQL + href: ~/docs-ref-services/latest/sql.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - SQL + href: ~/docs-ref-services/latest/mgmt-sql-readme.md + children: + - azure.mgmt.sql + - name: Standby Pool + href: ~/docs-ref-services/latest/standby-pool.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Standby Pool + href: ~/docs-ref-services/latest/mgmt-standbypool-readme.md + children: + - azure.mgmt.standbypool + - name: Storage + href: ~/docs-ref-services/latest/storage.md + landingPageType: Service + items: + - name: Storage - Blobs + href: ~/docs-ref-services/latest/storage-blob-readme.md + children: + - azure.storage.blob + - name: Storage - Files Data Lake + href: ~/docs-ref-services/latest/storage-file-datalake-readme.md + children: + - azure.storage.filedatalake + - name: Storage - Files Share + href: ~/docs-ref-services/latest/storage-file-share-readme.md + children: + - azure.storage.fileshare + - name: Storage - Queues + href: ~/docs-ref-services/latest/storage-queue-readme.md + children: + - azure.storage.queue + - name: Management + items: + - name: Resource Management - Storage + href: ~/docs-ref-services/latest/mgmt-storage-readme.md + children: + - azure.mgmt.storage + - name: Resource Management - Storage Cache + href: ~/docs-ref-services/latest/mgmt-storagecache-readme.md + children: + - azure.mgmt.storagecache + - name: Resource Management - Storage Mover + href: ~/docs-ref-services/latest/mgmt-storagemover-readme.md + children: + - azure.mgmt.storagemover + - name: Resource Management - Storage Pool + href: ~/docs-ref-services/latest/mgmt-storagepool-readme.md + children: + - azure.mgmt.storagepool + - name: Resource Management - Storage Sync + href: ~/docs-ref-services/latest/mgmt-storagesync-readme.md + children: + - azure.mgmt.storagesync + - name: Stream Analytics + href: ~/docs-ref-services/latest/stream-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Stream Analytics + href: ~/docs-ref-services/latest/mgmt-streamanalytics-readme.md + children: + - azure.mgmt.streamanalytics + - name: Subscriptions + href: ~/docs-ref-services/latest/subscriptions.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Subscriptions + href: ~/docs-ref-services/latest/mgmt-subscription-readme.md + children: + - azure.mgmt.subscription + - name: Support + href: ~/docs-ref-services/latest/support.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Support + href: ~/docs-ref-services/latest/mgmt-support-readme.md + children: + - azure.mgmt.support + - name: Synapse + href: ~/docs-ref-services/latest/synapse.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Synapse + href: ~/docs-ref-services/latest/mgmt-synapse-readme.md + children: + - azure.mgmt.synapse + - name: Tables + href: ~/docs-ref-services/latest/tables.md + landingPageType: Service + items: + - name: Tables + href: ~/docs-ref-services/latest/data-tables-readme.md + children: + - azure.data.tables + - name: Traffic Manager + href: ~/docs-ref-services/latest/traffic-manager.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Traffic Manager + href: ~/docs-ref-services/latest/mgmt-trafficmanager-readme.md + children: + - azure.mgmt.trafficmanager + - name: Video Search + href: ~/docs-ref-services/latest/video-search.md + landingPageType: Service + items: + - name: Video Search (deprecated) + children: + - azure.cognitiveservices.search.videosearch + landingPageType: Service + - name: Voice Services + href: ~/docs-ref-services/latest/voice-services.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Voice Services + href: ~/docs-ref-services/latest/mgmt-voiceservices-readme.md + children: + - azure.mgmt.voiceservices + - name: Web PubSub + href: ~/docs-ref-services/latest/web-pubsub.md + landingPageType: Service + items: + - name: Web PubSub Client + href: ~/docs-ref-services/latest/messaging-webpubsubclient-readme.md + children: + - azure.messaging.webpubsubclient + - name: Web PubSub + href: ~/docs-ref-services/latest/messaging-webpubsubservice-readme.md + children: + - azure.messaging.webpubsubservice + - name: Management + items: + - name: Resource Management - Web PubSub + href: ~/docs-ref-services/latest/mgmt-webpubsub-readme.md + children: + - azure.mgmt.webpubsub + - name: Web Search + href: ~/docs-ref-services/latest/web-search.md + landingPageType: Service + items: + - name: Web Search (deprecated) + children: + - azure.cognitiveservices.search.websearch + landingPageType: Service + - name: Workloads + href: ~/docs-ref-services/latest/workloads.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workloads + href: ~/docs-ref-services/latest/mgmt-workloads-readme.md + children: + - azure.mgmt.workloads + - name: Other + landingPageType: Service + items: + - name: Core + landingPageType: Service + items: + - name: Client + landingPageType: Service + items: + - name: Core + href: ~/docs-ref-services/latest/core-readme.md + children: + - azure.core + - name: Management + landingPageType: Service + items: + - name: Core + href: ~/docs-ref-services/latest/mgmt-core-readme.md + children: + - azure.mgmt.core + - name: Uamqp + children: + - uamqp + landingPageType: Service + - name: Uncategorized Packages + landingPageType: Service + children: + - '**' diff --git a/docs-ref-services/communication-administration-readme-pre.md b/docs-ref-services/communication-administration-readme-pre.md new file mode 100644 index 00000000..883543d1 --- /dev/null +++ b/docs-ref-services/communication-administration-readme-pre.md @@ -0,0 +1,203 @@ +--- +title: Azure Communication Administration Package client library for Python +keywords: Azure, python, SDK, API, azure-communication-administration, +ms.date: 04/16/2021 +ms.topic: reference +ms.devlang: python +ms.service: +--- +[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-python.client?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=46?branchName=master) + +# Azure Communication Administration Package client library for Python - version 1.0.0b4 + + +This package has been deprecated. Please use [azure-communication-identity](https://pypi.org/project/azure-communication-identity/) and [azure-communication-phonenumbers](https://pypi.org/project/azure-communication-phonenumbers/) instead. + +The requested features were implemented in the new libraries. See change log for more details. + +# Getting started +### Prerequisites +* Python 2.7, or 3.5 or later is required to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) + +### Install the package +Install the Azure Communication Administration client library for Python with [pip](https://pypi.org/project/pip/): + +```bash +pip install azure-communication-administration +``` + +# Key concepts +## CommunicationIdentityClient +`CommunicationIdentityClient` provides operations for: + +- Create/delete identities to be used in Azure Communication Services. Those identities can be used to make use of Azure Communication offerings and can be scoped to have limited abilities through token scopes. + +- Create/revoke scoped user access tokens to access services such as chat, calling, sms. Tokens are issued for a valid Azure Communication identity and can be revoked at any time. + +## CommunicationPhoneNumberClient +### Initializing Phone Number Client +```python +# You can find your endpoint and access token from your resource in the Azure Portal +import os +from azure.communication.administration import PhoneNumberAdministrationClient + +connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING') +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) +``` +### Phone plans overview + +Phone plans come in two types; Geographic and Toll-Free. Geographic phone plans are phone plans associated with a location, whose phone numbers' area codes are associated with the area code of a geographic location. Toll-Free phone plans are phone plans not associated location. For example, in the US, toll-free numbers can come with area codes such as 800 or 888. + +All geographic phone plans within the same country are grouped into a phone plan group with a Geographic phone number type. All Toll-Free phone plans within the same country are grouped into a phone plan group. + +### Searching and Acquiring numbers + +Phone numbers search can be search through the search creation API by providing a phone plan id, an area code and quantity of phone numbers. The provided quantity of phone numbers will be reserved for ten minutes. This search of phone numbers can either be cancelled or purchased. If the search is cancelled, then the phone numbers will become available to others. If the search is purchased, then the phone numbers are acquired for the Azure resources. + +### Configuring / Assigning numbers + +Phone numbers can be assigned to a callback URL via the configure number API. As part of the configuration, you will need an acquired phone number, callback URL and application id. + +# Examples +The following section provides several code snippets covering some of the most common Azure Communication Services tasks, including: + +[Create/delete Azure Communication Service identities][identitysamples] + +[Create/revoke scoped user access tokens][identitysamples] + +## Communication Phone number +### Get Countries + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +supported_countries = phone_number_administration_client.list_all_supported_countries() +for supported_country in supported_countries: + print(supported_country) +``` + +### Get Phone Plan Groups + +Phone plan groups come in two types, Geographic and Toll-Free. + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +phone_plan_groups_response = phone_number_administration_client.list_phone_plan_groups( + country_code='' +) +for phone_plan_group in phone_plan_groups_response: + print(phone_plan_group) +``` + +### Get Phone Plans + +Unlike Toll-Free phone plans, area codes for Geographic Phone Plans are empty. Area codes are found in the Area Codes API. + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +phone_plans_response = phone_number_administration_client.list_phone_plans( + country_code='', + phone_plan_group_id='' +) +for phone_plan in phone_plans_response: + print(phone_plan) +``` + +### Get Location Options + +For Geographic phone plans, you can query the available geographic locations. The locations options are structured like the geographic hierarchy of a country. For example, the US has states and within each state are cities. + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +location_options_response = phone_number_administration_client.get_phone_plan_location_options( + country_code='', + phone_plan_group_id='', + phone_plan_id='' +) +print(location_options_response) +``` + +### Get Area Codes + +Fetching area codes for geographic phone plans will require the the location options queries set. You must include the chain of geographic locations traversing down the location options object returned by the GetLocationOptions API. + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +all_area_codes = phone_number_administration_client.get_all_area_codes( + location_type="NotRequired", + country_code='', + phone_plan_id='' +) +print(all_area_codes) +``` + +### Create Search + +```python +from azure.communication.administration import CreateSearchOptions +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +searchOptions = CreateSearchOptions( + area_code='', + description="testsearch20200014", + display_name="testsearch20200014", + phone_plan_ids=[''], + quantity=1 +) +search_response = phone_number_administration_client.create_search( + body=searchOptions +) +print(search_response) +``` + +### Get search by id +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +phone_number_search_response = phone_number_administration_client.get_search_by_id( + search_id='' +) +print(phone_number_search_response) +``` + +### Purchase Search + +```python +phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string(connection_str) + +phone_number_administration_client.purchase_search( + search_id='' +) +``` + +# Troubleshooting +The Azure Communication Service Identity client will raise exceptions defined in [Azure Core][azure_core]. + +# Next steps +## More sample code + +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-administration_1.0.0b3/sdk/communication/azure-communication-administration/samples) directory for detailed examples of how to use this library to manage identities and tokens. + +## 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 + +# Contributing +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the +PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + +[identitysamples]: https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-administration_1.0.0b3/sdk/communication/azure-communication-administration/samples/identity_samples.py +[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-administration_1.0.0b4/sdk/core/azure-core/README.md + diff --git a/docs-ref-services/legacy/adls-gen1-client.md b/docs-ref-services/legacy/adls-gen1-client.md new file mode 100644 index 00000000..60867a03 --- /dev/null +++ b/docs-ref-services/legacy/adls-gen1-client.md @@ -0,0 +1,135 @@ +--- +title: Azure DataLake Store Gen1 library for Python +description: A python interface to the Azure Data-lake Storage system gen 1 +keywords: Azure, Python, SDK, API, DataLake, ADLS +ms.date: 08/26/2019 +ms.topic: reference +ms.devlang: python +ms.service: azure-data-lake-storage +manager: pkasturi +--- +# azure-datalake-store + +A pure-python interface to the Azure Data-lake Storage gen 1 system, providing +pythonic file-system and file objects, seamless transition between Windows and +POSIX remote paths, high-performance up- and down-loader. + +This software is under active development and not yet recommended for general +use. + +## Installation + +Using `pip`: + +``` +pip install azure-datalake-store +``` + +Manually (bleeding edge): + +* Download the repo from [https://github.com/Azure/azure-data-lake-store-python](https://github.com/Azure/azure-data-lake-store-python) + +* checkout the `dev` branch + +* install the requirements (`pip install -r dev_requirements.txt`) + +* install in develop mode (`python setup.py develop`) + +* optionally: build the documentation (including this page) by running `make html` in the docs directory. + +## Auth + +Although users can generate and supply their own tokens to the base file-system +class, and there is a password-based function in the `lib` module for +generating tokens, the most convenient way to supply credentials is via +environment parameters. This latter method is the one used by default in +library. The following variables are required: + +* azure_tenant_id + +* azure_username + +* azure_password + +* azure_store_name + +* azure_url_suffix (optional) + +## Pythonic Filesystem + +The `AzureDLFileSystem` object is the main API for library usage of this +package. It provides typical file-system operations on the remote azure +store + +``` +token = lib.auth(tenant_id, username, password) +adl = core.AzureDLFileSystem(store_name, token) +# alternatively, adl = core.AzureDLFileSystem() +# uses environment variables + +print(adl.ls()) # list files in the root directory +for item in adl.ls(detail=True): + print(item) # same, but with file details as dictionaries +print(adl.walk('')) # list all files at any directory depth +print('Usage:', adl.du('', deep=True, total=True)) # total bytes usage +adl.mkdir('newdir') # create directory +adl.touch('newdir/newfile') # create empty file +adl.put('remotefile', '/home/myuser/localfile') # upload a local file +``` + +In addition, the file-system generates file objects that are compatible with +the python file interface, ensuring compatibility with libraries that work on +python files. The recommended way to use this is with a context manager +(otherwise, be sure to call `close()` on the file object). + +``` +with adl.open('newfile', 'wb') as f: + f.write(b'index,a,b\n') + f.tell() # now at position 9 + f.flush() # forces data upstream + f.write(b'0,1,True') + +with adl.open('newfile', 'rb') as f: + print(f.readlines()) + +with adl.open('newfile', 'rb') as f: + df = pd.read_csv(f) # read into pandas. +``` + +To seamlessly handle remote path representations across all supported platforms, +the main API will take in numerous path types: string, Path/PurePath, and +AzureDLPath. On Windows in particular, you can pass in paths separated by either +forward slashes or backslashes. + +``` +import pathlib # only >= Python 3.4 +from pathlib2 import pathlib # only <= Python 3.3 + +from azure.datalake.store.core import AzureDLPath + +# possible remote paths to use on API +p1 = '\\foo\\bar' +p2 = '/foo/bar' +p3 = pathlib.PurePath('\\foo\\bar') +p4 = pathlib.PureWindowsPath('\\foo\\bar') +p5 = pathlib.PurePath('/foo/bar') +p6 = AzureDLPath('\\foo\\bar') +p7 = AzureDLPath('/foo/bar') + +# p1, p3, and p6 only work on Windows +for p in [p1, p2, p3, p4, p5, p6, p7]: + with adl.open(p, 'rb') as f: + print(f.readlines()) +``` + +## Performant up-/down-loading + +Classes `ADLUploader` and `ADLDownloader` will chunk large files and send +many files to/from azure using multiple threads. A whole directory tree can +be transferred, files matching a specific glob-pattern or any particular file. + +``` +# download the whole directory structure using 5 threads, 16MB chunks +ADLDownloader(adl, '', 'my_temp_dir', 5, 2**24) +``` + diff --git a/docs-ref-services/legacy/agrifood-index.md b/docs-ref-services/legacy/agrifood-index.md new file mode 100644 index 00000000..9ce612ff --- /dev/null +++ b/docs-ref-services/legacy/agrifood-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Resource Management - Agrifood](mgmt-agfood-readme.md)|[azure-mgmt-agfood](https://pypi.org/project/azure-mgmt-agfood)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/agfood/azure-mgmt-agfood)| diff --git a/docs-ref-services/legacy/agrifood.md b/docs-ref-services/legacy/agrifood.md new file mode 100644 index 00000000..52f1daff --- /dev/null +++ b/docs-ref-services/legacy/agrifood.md @@ -0,0 +1,11 @@ +--- +title: Azure Agrifood SDK for Python +description: Reference for Azure Agrifood SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: agrifood +--- +# Azure Agrifood SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](agrifood-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/ai-formrecognizer-readme.md b/docs-ref-services/legacy/ai-formrecognizer-readme.md new file mode 100644 index 00000000..b34f6258 --- /dev/null +++ b/docs-ref-services/legacy/ai-formrecognizer-readme.md @@ -0,0 +1,512 @@ +--- +title: Azure Form Recognizer client library for Python +keywords: Azure, python, SDK, API, azure-ai-formrecognizer, formrecognizer +ms.date: 08/20/2020 +ms.topic: reference +ms.devlang: python +ms.service: applied-ai-services +ms.subservice: forms-recognizer +--- +# Azure Form Recognizer client library for Python - version 3.0.0 + + +Azure Cognitive Services Form Recognizer is a cloud service that uses machine learning to recognize text and table data +from form documents. It includes the following main functionalities: + +* Custom models - Recognize field values and table data from forms. These models are trained with your own data, so they're tailored to your forms. +* Content API - Recognize text and table structures, along with their bounding box coordinates, from documents. Corresponds to the REST service's Layout API. +* Prebuilt receipt model - Recognize data from USA sales receipts using a prebuilt model. + +[Source code][python-fr-src] | [Package (PyPI)][python-fr-pypi] | [API reference documentation][python-fr-ref-docs]| [Product documentation][python-fr-product-docs] | [Samples][python-fr-samples] + +## Getting started + +### Prerequisites +* Python 2.7, or 3.5 or later is required to use this package. +* You must have an [Azure subscription][azure_subscription] and a +[Cognitive Services or Form Recognizer resource][FR_or_CS_resource] to use this package. + +### Install the package +Install the Azure Form Recognizer client library for Python - version 3.0.0 + with [pip][pip]: + +```bash +pip install azure-ai-formrecognizer +``` + +> Note: This version of the client library supports the v2.0 version of the Form Recognizer service + +#### Create a Form Recognizer resource +Form Recognizer supports both [multi-service and single-service access][multi_and_single_service]. +Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Form Recognizer access only, create a Form Recognizer resource. + +You can create the resource using + +**Option 1:** [Azure Portal][azure_portal_create_FR_resource] + +**Option 2:** [Azure CLI][azure_cli_create_FR_resource]. +Below is an example of how you can create a Form Recognizer resource using the CLI: + +```bash +# Create a new resource group to hold the form recognizer resource - +# if using an existing resource group, skip this step +az group create --name my-resource-group --location westus2 +``` + +```bash +# Create form recognizer +az cognitiveservices account create \ + --name form-recognizer-resource \ + --resource-group my-resource-group \ + --kind FormRecognizer \ + --sku F0 \ + --location westus2 \ + --yes +``` + +### Authenticate the client +In order to interact with the Form Recognizer service, you will need to create an instance of a client. +An **endpoint** and **credential** are necessary to instantiate the client object. + + +#### Looking up the endpoint +You can find the endpoint for your Form Recognizer resource using the +[Azure Portal][azure_portal_get_endpoint] +or [Azure CLI][azure_cli_endpoint_lookup]: + +```bash +# Get the endpoint for the form recognizer resource +az cognitiveservices account show --name "resource-name" --resource-group "resource-group-name" --query "endpoint" +``` + +#### Get the API key + +The API key can be found in the Azure Portal or by running the following Azure CLI command: + +```az cognitiveservices account keys list --name "resource-name" --resource-group "resource-group-name"``` + +#### Create the client with AzureKeyCredential + +To use an [API key][cognitive_authentication_api_key] as the `credential` parameter, +pass the key as a string into an instance of [AzureKeyCredential][azure-key-credential]. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.formrecognizer import FormRecognizerClient + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") +form_recognizer_client = FormRecognizerClient(endpoint, credential) +``` + +#### Create the client with an Azure Active Directory credential + +`AzureKeyCredential` authentication is used in the examples in this getting started guide, but you can also +authenticate with Azure Active Directory using the [azure-identity][azure_identity] library. +Note that regional endpoints do not support AAD authentication. Create a [custom subdomain][custom_subdomain] +name for your resource in order to use this type of authentication. + +To use the [DefaultAzureCredential][default_azure_credential] type shown below, or other credential types provided +with the Azure SDK, please install the `azure-identity` package: + +```pip install azure-identity``` + +You will also need to [register a new AAD application and grant access][register_aad_app] to +Form Recognizer by assigning the `"Cognitive Services User"` role to your service principal. + +Once completed, set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`. + +```python +from azure.identity import DefaultAzureCredential +from azure.ai.formrecognizer import FormRecognizerClient +credential = DefaultAzureCredential() + +form_recognizer_client = FormRecognizerClient( + endpoint="https://.cognitiveservices.azure.com/", + credential=credential +) +``` + +## Key concepts + +### FormRecognizerClient +`FormRecognizerClient` provides operations for: + + - Recognizing form fields and content using custom models trained to recognize your custom forms. These values are returned in a collection of `RecognizedForm` objects. + - Recognizing common fields from US receipts, using a pre-trained receipt model. These fields and metadata are returned in a collection of `RecognizedForm` objects. + - Recognizing form content, including tables, lines and words, without the need to train a model. Form content is returned in a collection of `FormPage` objects. + +Sample code snippets are provided to illustrate using a FormRecognizerClient [here](#recognize-forms-using-a-custom-model "Recognize Forms Using a Custom Model"). + +### FormTrainingClient +`FormTrainingClient` provides operations for: + +- Training custom models without labels to recognize all fields and values found in your custom forms. A `CustomFormModel` is returned indicating the form types the model will recognize, and the fields it will extract for each form type. See the [service documentation][fr-train-without-labels] for a more detailed explanation. +- Training custom models with labels to recognize specific fields and values you specify by labeling your custom forms. A `CustomFormModel` is returned indicating the fields the model will extract, as well as the estimated accuracy for each field. See the [service documentation][fr-train-with-labels] for a more detailed explanation. +- Managing models created in your account. +- Copying a custom model from one Form Recognizer resource to another. + +Please note that models can also be trained using a graphical user interface such as the [Form Recognizer Labeling Tool][fr-labeling-tool]. + +Sample code snippets are provided to illustrate using a FormTrainingClient [here](#train-a-model "Train a model"). + +### Long-Running Operations +Long-running operations are operations which consist of an initial request sent to the service to start an operation, +followed by polling the service at intervals to determine whether the operation has completed or failed, and if it has +succeeded, to get the result. + +Methods that train models, recognize values from forms, or copy models are modeled as long-running operations. +The client exposes a `begin_` method that returns an `LROPoller` or `AsyncLROPoller`. Callers should wait +for the operation to complete by calling `result()` on the poller object returned from the `begin_` method. +Sample code snippets are provided to illustrate using long-running operations [below](#examples "Examples"). + + +## Examples + +The following section provides several code snippets covering some of the most common Form Recognizer tasks, including: + +* [Recognize Forms Using a Custom Model](#recognize-forms-using-a-custom-model "Recognize Forms Using a Custom Model") +* [Recognize Content](#recognize-content "Recognize Content") +* [Recognize Receipts](#recognize-receipts "Recognize receipts") +* [Train a Model](#train-a-model "Train a model") +* [Manage Your Models](#manage-your-models "Manage Your Models") + +### Recognize Forms Using a Custom Model +Recognize name/value pairs and table data from forms. These models are trained with your own data, so they're tailored to your forms. +For best results, you should only recognize forms of the same form type that the custom model was trained on. + +```python +from azure.ai.formrecognizer import FormRecognizerClient +from azure.core.credentials import AzureKeyCredential + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") + +form_recognizer_client = FormRecognizerClient(endpoint, credential) +model_id = "" + +with open("", "rb") as fd: + form = fd.read() + +poller = form_recognizer_client.begin_recognize_custom_forms(model_id=model_id, form=form) +result = poller.result() + +for recognized_form in result: + print("Form type: {}".format(recognized_form.form_type)) + for name, field in recognized_form.fields.items(): + print("Field '{}' has label '{}' with value '{}' and a confidence score of {}".format( + name, + field.label_data.text if field.label_data else name, + field.value, + field.confidence + )) +``` + +Alternatively, a form URL can also be used to recognize custom forms using the `begin_recognize_custom_forms_from_url` method. +The `_from_url` methods exist for all the recognize methods. + +``` +form_url = "" +poller = form_recognizer_client.begin_recognize_custom_forms_from_url(model_id=model_id, form_url=form_url) +result = poller.result() +``` + +### Recognize Content +Recognize text and table structures, along with their bounding box coordinates, from documents. + +```python +from azure.ai.formrecognizer import FormRecognizerClient +from azure.core.credentials import AzureKeyCredential + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") + +form_recognizer_client = FormRecognizerClient(endpoint, credential) + +with open("", "rb") as fd: + form = fd.read() + +poller = form_recognizer_client.begin_recognize_content(form) +page = poller.result() + +table = page[0].tables[0] # page 1, table 1 +print("Table found on page {}:".format(table.page_number)) +for cell in table.cells: + print("Cell text: {}".format(cell.text)) + print("Location: {}".format(cell.bounding_box)) + print("Confidence score: {}\n".format(cell.confidence)) +``` + +### Recognize Receipts +Recognize data from USA sales receipts using a prebuilt model. Receipt fields recognized by the service can be found [here][service_recognize_receipt]. + +```python +from azure.ai.formrecognizer import FormRecognizerClient +from azure.core.credentials import AzureKeyCredential + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") + +form_recognizer_client = FormRecognizerClient(endpoint, credential) + +with open("", "rb") as fd: + receipt = fd.read() + +poller = form_recognizer_client.begin_recognize_receipts(receipt) +result = poller.result() + +for receipt in result: + for name, field in receipt.fields.items(): + if name == "Items": + print("Receipt Items:") + for idx, items in enumerate(field.value): + print("...Item #{}".format(idx+1)) + for item_name, item in items.value.items(): + print("......{}: {} has confidence {}".format(item_name, item.value, item.confidence)) + else: + print("{}: {} has confidence {}".format(name, field.value, field.confidence)) +``` + +### Train a model +Train a custom model on your own form type. The resulting model can be used to recognize values from the types of forms it was trained on. +Provide a container SAS URL to your Azure Storage Blob container where you're storing the training documents. +If training files are within a subfolder in the container, use the [prefix][prefix_ref_docs] keyword argument to specify under which folder to train. + +More details on setting up a container and required file structure can be found in the [service documentation][training_data]. + +```python +from azure.ai.formrecognizer import FormTrainingClient +from azure.core.credentials import AzureKeyCredential + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") + +form_training_client = FormTrainingClient(endpoint, credential) + +container_sas_url = "" # training documents uploaded to blob storage +poller = form_training_client.begin_training( + container_sas_url, use_training_labels=False +) +model = poller.result() + +# Custom model information +print("Model ID: {}".format(model.model_id)) +print("Status: {}".format(model.status)) +print("Training started on: {}".format(model.training_started_on)) +print("Training completed on: {}".format(model.training_completed_on)) + +print("\nRecognized fields:") +for submodel in model.submodels: + print( + "The submodel with form type '{}' has recognized the following fields: {}".format( + submodel.form_type, + ", ".join( + [ + field.label if field.label else name + for name, field in submodel.fields.items() + ] + ), + ) + ) + +# Training result information +for doc in model.training_documents: + print("Document name: {}".format(doc.name)) + print("Document status: {}".format(doc.status)) + print("Document page count: {}".format(doc.page_count)) + print("Document errors: {}".format(doc.errors)) +``` + +### Manage Your Models +Manage the custom models attached to your account. + +```python +from azure.ai.formrecognizer import FormTrainingClient +from azure.core.credentials import AzureKeyCredential +from azure.core.exceptions import ResourceNotFoundError + +endpoint = "https://.api.cognitive.microsoft.com/" +credential = AzureKeyCredential("") + +form_training_client = FormTrainingClient(endpoint, credential) + +account_properties = form_training_client.get_account_properties() +print("Our account has {} custom models, and we can have at most {} custom models".format( + account_properties.custom_model_count, account_properties.custom_model_limit +)) + +# Here we get a paged list of all of our custom models +custom_models = form_training_client.list_custom_models() +print("We have models with the following ids: {}".format( + ", ".join([m.model_id for m in custom_models]) +)) + +# Replace with the custom model ID from the "Train a model" sample +model_id = "" + +custom_model = form_training_client.get_custom_model(model_id=model_id) +print("Model ID: {}".format(custom_model.model_id)) +print("Status: {}".format(custom_model.status)) +print("Training started on: {}".format(custom_model.training_started_on)) +print("Training completed on: {}".format(custom_model.training_completed_on)) + +# Finally, we will delete this model by ID +form_training_client.delete_model(model_id=custom_model.model_id) + +try: + form_training_client.get_custom_model(model_id=custom_model.model_id) +except ResourceNotFoundError: + print("Successfully deleted model with id {}".format(custom_model.model_id)) +``` + +## Troubleshooting + +### General +Form Recognizer client library will raise exceptions defined in [Azure Core][azure_core_exceptions]. + +### Logging +This library uses the standard +[logging][python_logging] library for logging. +Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO +level. + +Detailed DEBUG level logging, including request/response bodies and unredacted +headers, can be enabled on a client with the `logging_enable` keyword argument: +```python +import sys +import logging +from azure.ai.formrecognizer import FormRecognizerClient +from azure.core.credentials import AzureKeyCredential + +# Create a logger for the 'azure' SDK +logger = logging.getLogger('azure') +logger.setLevel(logging.DEBUG) + +# Configure a console output +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +endpoint = "https://.cognitiveservices.azure.com/" +credential = AzureKeyCredential("") + +# This client will log detailed information about its HTTP sessions, at DEBUG level +form_recognizer_client = FormRecognizerClient(endpoint, credential, logging_enable=True) +``` + +Similarly, `logging_enable` can enable detailed logging for a single operation, +even when it isn't enabled for the client: +```python +poller = form_recognizer_client.begin_recognize_receipts(receipt, logging_enable=True) +``` + +### Optional Configuration + +Optional keyword arguments can be passed in at the client and per-operation level. +The azure-core [reference documentation][azure_core_ref_docs] +describes available configurations for retries, logging, transport protocols, and more. + +## Next steps + +The following section provides several code snippets illustrating common patterns used in the Form Recognizer Python API. + +### More sample code + +These code samples show common scenario operations with the Azure Form Recognizer client library. + +* Client authentication: [sample_authentication.py][sample_authentication] +* Recognize receipts: [sample_recognize_receipts.py][sample_recognize_receipts] +* Recognize receipts from a URL: [sample_recognize_receipts_from_url.py][sample_recognize_receipts_from_url] +* Recognize content: [sample_recognize_content.py][sample_recognize_content] +* Recognize custom forms: [sample_recognize_custom_forms.py][sample_recognize_custom_forms] +* Train a model without labels: [sample_train_model_without_labels.py][sample_train_model_without_labels] +* Train a model with labels: [sample_train_model_with_labels.py][sample_train_model_with_labels] +* Manage custom models: [sample_manage_custom_models.py][sample_manage_custom_models] +* Copy a model between Form Recognizer resources: [sample_copy_model.py][sample_copy_model] + +### Async APIs +This library also includes a complete async API supported on Python 3.5+. To use it, you must +first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/). Async clients +are found under the `azure.ai.formrecognizer.aio` namespace. + +* Client authentication: [sample_authentication_async.py][sample_authentication_async] +* Recognize receipts: [sample_recognize_receipts_async.py][sample_recognize_receipts_async] +* Recognize receipts from a URL: [sample_recognize_receipts_from_url_async.py][sample_recognize_receipts_from_url_async] +* Recognize content: [sample_recognize_content_async.py][sample_recognize_content_async] +* Recognize custom forms: [sample_recognize_custom_forms_async.py][sample_recognize_custom_forms_async] +* Train a model without labels: [sample_train_model_without_labels_async.py][sample_train_model_without_labels_async] +* Train a model with labels: [sample_train_model_with_labels_async.py][sample_train_model_with_labels_async] +* Manage custom models: [sample_manage_custom_models_async.py][sample_manage_custom_models_async] +* Copy a model between Form Recognizer resources: [sample_copy_model_async.py][sample_copy_model_async] + + +### Additional documentation + +For more extensive documentation on Azure Cognitive Services Form Recognizer, see the [Form Recognizer documentation][python-fr-product-docs] on docs.microsoft.com. + +## Contributing +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. + + + +[python-fr-src]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer +[python-fr-pypi]: https://pypi.org/project/azure-ai-formrecognizer/ +[python-fr-product-docs]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview +[python-fr-ref-docs]: https://aka.ms/azsdk/python/formrecognizer/docs +[python-fr-samples]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples +[train-a-model-using-labeled-data]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/quickstarts/python-labeled-data#train-a-model-using-labeled-data + + +[training_data]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/build-training-data-set +[azure_subscription]: https://azure.microsoft.com/free/ +[FR_or_CS_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows +[pip]: https://pypi.org/project/pip/ +[azure_portal_create_FR_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer +[azure_cli_create_FR_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows +[azure-key-credential]: https://aka.ms/azsdk/python/core/azurekeycredential +[fr-labeling-tool]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/quickstarts/label-tool +[fr-train-without-labels]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview#train-without-labels +[fr-train-with-labels]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview#train-with-labels +[prefix_ref_docs]: https://aka.ms/azsdk/python/formrecognizer/docs#azure.ai.formrecognizer.FormTrainingClient.begin_training + +[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs +[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions +[python_logging]: https://docs.python.org/3/library/logging.html +[multi_and_single_service]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows +[azure_cli_endpoint_lookup]: https://docs.microsoft.com/cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show +[azure_portal_get_endpoint]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[cognitive_authentication_api_key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal +[custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain +[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity#defaultazurecredential +[service_recognize_receipt]: https://aka.ms/formrecognizer/receiptfields + +[cla]: https://cla.microsoft.com +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com + +[sample_authentication]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_authentication.py +[sample_authentication_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_authentication_async.py +[sample_manage_custom_models]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_manage_custom_models.py +[sample_manage_custom_models_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_manage_custom_models_async.py +[sample_recognize_content]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_recognize_content.py +[sample_recognize_content_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_recognize_content_async.py +[sample_recognize_custom_forms]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_recognize_custom_forms.py +[sample_recognize_custom_forms_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_recognize_custom_forms_async.py +[sample_recognize_receipts_from_url]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_recognize_receipts_from_url.py +[sample_recognize_receipts_from_url_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_recognize_receipts_from_url_async.py +[sample_recognize_receipts]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_recognize_receipts.py +[sample_recognize_receipts_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_recognize_receipts_async.py +[sample_train_model_with_labels]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_train_model_with_labels.py +[sample_train_model_with_labels_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_train_model_with_labels_async.py +[sample_train_model_without_labels]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_train_model_without_labels.py +[sample_train_model_without_labels_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_train_model_without_labels_async.py +[sample_copy_model]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_copy_model.py +[sample_copy_model_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_copy_model_async.py + diff --git a/docs-ref-services/legacy/ai-metricsadvisor-readme.md b/docs-ref-services/legacy/ai-metricsadvisor-readme.md new file mode 100644 index 00000000..f1b613bf --- /dev/null +++ b/docs-ref-services/legacy/ai-metricsadvisor-readme.md @@ -0,0 +1,548 @@ +--- +title: Azure Metrics Advisor client library for Python +keywords: Azure, python, SDK, API, azure-ai-metricsadvisor, metricsadvisor +ms.date: 06/07/2021 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: metrics-advisor +--- +# Azure Metrics Advisor client library for Python - version 1.0.0b4 + +Metrics Advisor is a scalable real-time time series monitoring, alerting, and root cause analysis platform. Use Metrics Advisor to: + +- Analyze multi-dimensional data from multiple data sources +- Identify and correlate anomalies +- Configure and fine-tune the anomaly detection model used on your data +- Diagnose anomalies and help with root cause analysis + +[Source code][src_code] | [Package (Pypi)][package] | [API reference documentation][reference_documentation] | [Product documentation][ma_docs] | [Samples][samples_readme] + +## Getting started + +### Install the package + +Install the Azure Metrics Advisor client library for Python with pip: + +```commandline +pip install azure-ai-metricsadvisor --pre +``` + +### Prerequisites + +* Python 2.7, or 3.6 or later is required to use this package. +* You need an [Azure subscription][azure_sub], and a [Metrics Advisor serivce][ma_service] to use this package. + +### Authenticate the client + +You will need two keys to authenticate the client: + +1) The subscription key to your Metrics Advisor resource. You can find this in the Keys and Endpoint section of your resource in the Azure portal. +2) The API key for your Metrics Advisor instance. You can find this in the web portal for Metrics Advisor, in API keys on the left navigation menu. + +We can use the keys to create a new `MetricsAdvisorClient` or `MetricsAdvisorAdministrationClient`. + +```py +import os +from azure.ai.metricsadvisor import ( + MetricsAdvisorKeyCredential, + MetricsAdvisorClient, + MetricsAdvisorAdministrationClient, +) + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") + +client = MetricsAdvisorClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key)) + +admin_client = MetricsAdvisorAdministrationClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key)) +``` + +## Key concepts + +### MetricsAdvisorClient + +`MetricsAdvisorClient` helps with: + +- listing incidents +- listing root causes of incidents +- retrieving original time series data and time series data enriched by the service. +- listing alerts +- adding feedback to tune your model + +### MetricsAdvisorAdministrationClient + +`MetricsAdvisorAdministrationClient` allows you to + +- manage data feeds +- manage anomaly detection configurations +- manage anomaly alerting configurations +- manage hooks + +### DataFeed + +A `DataFeed` is what Metrics Advisor ingests from your data source, such as Cosmos DB or a SQL server. A data feed contains rows of: + +- timestamps +- zero or more dimensions +- one or more measures + +### Metric + +A `DataFeedMetric` is a quantifiable measure that is used to monitor and assess the status of a specific business process. It can be a combination of multiple time series values divided into dimensions. For example a web health metric might contain dimensions for user count and the en-us market. + +### AnomalyDetectionConfiguration + +`AnomalyDetectionConfiguration` is required for every time series, and determines whether a point in the time series is an anomaly. + +### Anomaly & Incident + +After a detection configuration is applied to metrics, `AnomalyIncident`s are generated whenever any series within it has an `DataPointAnomaly`. + +### Alert + +You can configure which anomalies should trigger an `AnomalyAlert`. You can set multiple alerts with different settings. For example, you could create an alert for anomalies with lower business impact, and another for more important alerts. + +### Notification Hook + +Metrics Advisor lets you create and subscribe to real-time alerts. These alerts are sent over the internet, using a notification hook like `EmailNotificationHook` or `WebNotificationHook`. + +## Examples + +- [Add a data feed from a sample or data source](#add-a-data-feed-from-a-sample-or-data-source "Add a data feed from a sample or data source") +- [Check ingestion status](#check-ingestion-status "Check ingestion status") +- [Configure anomaly detection configuration](#configure-anomaly-detection-configuration "Configure anomaly detection configuration") +- [Configure alert configuration](#configure-alert-configuration "Configure alert configuration") +- [Query anomaly detection results](#query-anomaly-detection-results "Query anomaly detection results") +- [Query incidents](#query-incidents "Query incidents") +- [Query root causes](#query-root-causes "Query root causes") +- [Add hooks for receiving anomaly alerts](#add-hooks-for-receiving-anomaly-alerts "Add hooks for receiving anomaly alerts") + +### Add a data feed from a sample or data source + +Metrics Advisor supports connecting different types of data sources. Here is a sample to ingest data from SQL Server. + +```py +import os +import datetime +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient +from azure.ai.metricsadvisor.models import ( + SqlServerDataFeedSource, + DataFeedSchema, + DataFeedMetric, + DataFeedDimension, + DataFeedRollupSettings, + DataFeedMissingDataPointFillSettings + ) + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +sql_server_connection_string = os.getenv("SQL_SERVER_CONNECTION_STRING") +query = os.getenv("SQL_SERVER_QUERY") + +client = MetricsAdvisorAdministrationClient( + service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +data_feed = client.create_data_feed( + name="My data feed", + source=SqlServerDataFeedSource( + connection_string=sql_server_connection_string, + query=query, + ), + granularity="Daily", + schema=DataFeedSchema( + metrics=[ + DataFeedMetric(name="cost", display_name="Cost"), + DataFeedMetric(name="revenue", display_name="Revenue") + ], + dimensions=[ + DataFeedDimension(name="category", display_name="Category"), + DataFeedDimension(name="city", display_name="City") + ], + timestamp_column="Timestamp" + ), + ingestion_settings=datetime.datetime(2019, 10, 1), + data_feed_description="cost/revenue data feed", + rollup_settings=DataFeedRollupSettings( + rollup_type="AutoRollup", + rollup_method="Sum", + rollup_identification_value="__CUSTOM_SUM__" + ), + missing_data_point_fill_settings=DataFeedMissingDataPointFillSettings( + fill_type="SmartFilling" + ), + access_mode="Private" +) + +return data_feed +``` + +### Check ingestion status + +After we start the data ingestion, we can check the ingestion status. + +```py +import datetime +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +data_feed_id = os.getenv("DATA_FEED_ID") + +client = MetricsAdvisorAdministrationClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +ingestion_status = client.list_data_feed_ingestion_status( + data_feed_id, + datetime.datetime(2020, 9, 20), + datetime.datetime(2020, 9, 25) +) +for status in ingestion_status: + print("Timestamp: {}".format(status.timestamp)) + print("Status: {}".format(status.status)) + print("Message: {}\n".format(status.message)) +``` + +### Configure anomaly detection configuration + +While a default detection configuration is automatically applied to each metric, we can tune the detection modes used on our data by creating a customized anomaly detection configuration. + +```py +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient +from azure.ai.metricsadvisor.models import ( + ChangeThresholdCondition, + HardThresholdCondition, + SmartDetectionCondition, + SuppressCondition, + MetricDetectionCondition, +) + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +metric_id = os.getenv("METRIC_ID") + +client = MetricsAdvisorAdministrationClient( + service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +change_threshold_condition = ChangeThresholdCondition( + anomaly_detector_direction="Both", + change_percentage=20, + shift_point=10, + within_range=True, + suppress_condition=SuppressCondition( + min_number=5, + min_ratio=2 + ) +) +hard_threshold_condition = HardThresholdCondition( + anomaly_detector_direction="Up", + upper_bound=100, + suppress_condition=SuppressCondition( + min_number=2, + min_ratio=2 + ) +) +smart_detection_condition = SmartDetectionCondition( + anomaly_detector_direction="Up", + sensitivity=10, + suppress_condition=SuppressCondition( + min_number=2, + min_ratio=2 + ) +) + +detection_config = client.create_detection_configuration( + name="my_detection_config", + metric_id=metric_id, + description="anomaly detection config for metric", + whole_series_detection_condition=MetricDetectionCondition( + cross_conditions_operator="OR", + change_threshold_condition=change_threshold_condition, + hard_threshold_condition=hard_threshold_condition, + smart_detection_condition=smart_detection_condition + ) +) +return detection_config +``` + +### Configure alert configuration + +Then let's configure in which conditions an alert needs to be triggered. + +```py +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient +from azure.ai.metricsadvisor.models import ( + MetricAlertConfiguration, + MetricAnomalyAlertScope, + TopNGroupScope, + MetricAnomalyAlertConditions, + SeverityCondition, + MetricBoundaryCondition, + MetricAnomalyAlertSnoozeCondition, +) +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +anomaly_detection_configuration_id = os.getenv("DETECTION_CONFIGURATION_ID") +hook_id = os.getenv("HOOK_ID") + +client = MetricsAdvisorAdministrationClient( + service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +alert_config = client.create_alert_configuration( + name="my alert config", + description="alert config description", + cross_metrics_operator="AND", + metric_alert_configurations=[ + MetricAlertConfiguration( + detection_configuration_id=anomaly_detection_configuration_id, + alert_scope=MetricAnomalyAlertScope( + scope_type="WholeSeries" + ), + alert_conditions=MetricAnomalyAlertConditions( + severity_condition=SeverityCondition( + min_alert_severity="Low", + max_alert_severity="High" + ) + ) + ), + MetricAlertConfiguration( + detection_configuration_id=anomaly_detection_configuration_id, + alert_scope=MetricAnomalyAlertScope( + scope_type="TopN", + top_n_group_in_scope=TopNGroupScope( + top=10, + period=5, + min_top_count=5 + ) + ), + alert_conditions=MetricAnomalyAlertConditions( + metric_boundary_condition=MetricBoundaryCondition( + direction="Up", + upper=50 + ) + ), + alert_snooze_condition=MetricAnomalyAlertSnoozeCondition( + auto_snooze=2, + snooze_scope="Metric", + only_for_successive=True + ) + ), + ], + hook_ids=[hook_id] +) + +return alert_config +``` + +### Query anomaly detection results + +We can query the alerts and anomalies. + +```py +import datetime +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +alert_config_id = os.getenv("ALERT_CONFIG_ID") +alert_id = os.getenv("ALERT_ID") + +client = MetricsAdvisorClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +results = client.list_alerts( + alert_configuration_id=alert_config_id, + start_time=datetime.datetime(2020, 1, 1), + end_time=datetime.datetime(2020, 9, 9), + time_mode="AnomalyTime", +) +for result in results: + print("Alert id: {}".format(result.id)) + print("Create on: {}".format(result.created_on)) + +results = client.list_anomalies( + alert_configuration_id=alert_config_id, + alert_id=alert_id, +) +for result in results: + print("Create on: {}".format(result.created_on)) + print("Severity: {}".format(result.severity)) + print("Status: {}".format(result.status)) +``` + +### Query incidents + +We can query the incidents for a detection configuration. + +```py +import datetime +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +anomaly_detection_configuration_id = os.getenv("DETECTION_CONFIGURATION_ID") + +client = MetricsAdvisorClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +results = client.list_incidents( + detection_configuration_id=anomaly_detection_configuration_id, + start_time=datetime.datetime(2020, 1, 1), + end_time=datetime.datetime(2020, 9, 9), + ) +for result in results: + print("Metric id: {}".format(result.metric_id)) + print("Incident ID: {}".format(result.id)) + print("Severity: {}".format(result.severity)) + print("Status: {}".format(result.status)) +``` + +### Query root causes + +We can also query the root causes of an incident + +```py +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") +anomaly_detection_configuration_id = os.getenv("DETECTION_CONFIGURATION_ID") +incident_id = os.getenv("INCIDENT_ID") + +client = MetricsAdvisorClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +results = client.list_incident_root_causes( + detection_configuration_id=anomaly_detection_configuration_id, + incident_id=incident_id, + ) +for result in results: + print("Score: {}".format(result.score)) + print("Description: {}".format(result.description)) + +``` + + +### Add hooks for receiving anomaly alerts + +We can add some hooks so when an alert is triggered, we can get call back. + +```py +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient +from azure.ai.metricsadvisor.models import EmailNotificationHook + +service_endpoint = os.getenv("ENDPOINT") +subscription_key = os.getenv("SUBSCRIPTION_KEY") +api_key = os.getenv("API_KEY") + +client = MetricsAdvisorAdministrationClient(service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key)) + +hook = client.create_hook( + hook=EmailNotificationHook( + name="email hook", + description="my email hook", + emails_to_alert=["alertme@alertme.com"], + external_link="https://docs.microsoft.com/en-us/azure/cognitive-services/metrics-advisor/how-tos/alerts" + ) +) +``` + +### Async APIs + +This library includes a complete async API supported on Python 3.6+. To use it, you must +first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/). +See +[azure-core documentation][azure_core_docs] +for more information. + + +```py +from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential +from azure.ai.metricsadvisor.aio import MetricsAdvisorClient, MetricsAdvisorAdministrationClient + +client = MetricsAdvisorClient( + service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) + +admin_client = MetricsAdvisorAdministrationClient( + service_endpoint, + MetricsAdvisorKeyCredential(subscription_key, api_key) +) +``` + +## Troubleshooting + +### General + +The Azure Metrics Advisor clients will raise exceptions defined in [Azure Core][azure_core]. + +### Logging +This library uses the standard +[logging][python_logging] library for logging. + +Basic information about HTTP sessions (URLs, headers, etc.) is logged at `INFO` level. + +Detailed `DEBUG` level logging, including request/response bodies and **unredacted** +headers, can be enabled on the client or per-operation with the `logging_enable` keyword argument. + +See full SDK logging documentation with examples [here][sdk_logging_docs]. + +## Next steps + +### More sample code + + For more details see the [samples README][samples_readme]. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. For +details, visit [cla.microsoft.com][cla]. + +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. +For more information see the [Code of Conduct FAQ][coc_faq] +or contact [opencode@microsoft.com][coc_contact] with any +additional questions or comments. + + +[src_code]: https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-metricsadvisor_1.0.0b4/sdk/metricsadvisor/azure-ai-metricsadvisor +[reference_documentation]: https://aka.ms/azsdk/python/metricsadvisor/docs +[ma_docs]: https://docs.microsoft.com/azure/cognitive-services/metrics-advisor/overview +[azure_cli]: https://docs.microsoft.com/cli/azure +[azure_sub]: https://azure.microsoft.com/free/ +[package]: https://aka.ms/azsdk/python/metricsadvisor/pypi +[ma_service]: https://go.microsoft.com/fwlink/?linkid=2142156 +[python_logging]: https://docs.python.org/3.5/library/logging.html +[azure_core]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions +[azure_core_docs]: https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-metricsadvisor_1.0.0b4/sdk/core/azure-core/README.md#transport +[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging +[samples_readme]: https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-metricsadvisor_1.0.0b4/sdk/metricsadvisor/azure-ai-metricsadvisor/samples/README.md + +[cla]: https://cla.microsoft.com +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com + diff --git a/docs-ref-services/legacy/ai-textanalytics-readme.md b/docs-ref-services/legacy/ai-textanalytics-readme.md new file mode 100644 index 00000000..b019b52d --- /dev/null +++ b/docs-ref-services/legacy/ai-textanalytics-readme.md @@ -0,0 +1,513 @@ +--- +title: Azure Text Analytics client library for Python +keywords: Azure, python, SDK, API, textanalytics, azure-ai-textanalytics +ms.date: 06/09/2020 +ms.topic: reference +ms.devlang: Python +ms.service: cognitive-services +ms.subservice: text-analytics +--- +# Azure Text Analytics client library for Python - version 5.0.0 +Text Analytics is a cloud-based service that provides advanced natural language processing over raw text, and includes six main functions: + +* Sentiment Analysis +* Named Entity Recognition +* Linked Entity Recognition +* Language Detection +* Key Phrase Extraction + +[Source code][source_code] | [Package (PyPI)][TA_pypi] | [API reference documentation][TA_ref_docs]| [Product documentation][TA_product_documentation] | [Samples][TA_samples] + +## Getting started + +### Prerequisites +* Python 2.7, or 3.5 or later is required to use this package. +* You must have an [Azure subscription][azure_subscription] and a +[Cognitive Services or Text Analytics resource][TA_or_CS_resource] to use this package. + +#### Create a Cognitive Services or Text Analytics resource +Text Analytics supports both [multi-service and single-service access][multi_and_single_service]. +Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Text Analytics access only, create a Text Analytics resource. + +You can create the resource using + +**Option 1:** [Azure Portal][azure_portal_create_TA_resource] + +**Option 2:** [Azure CLI][azure_cli_create_TA_resource]. +Below is an example of how you can create a Text Analytics resource using the CLI: + +```bash +# Create a new resource group to hold the text analytics resource - +# if using an existing resource group, skip this step +az group create --name my-resource-group --location westus2 +``` + +```bash +# Create text analytics +az cognitiveservices account create \ + --name text-analytics-resource \ + --resource-group my-resource-group \ + --kind TextAnalytics \ + --sku F0 \ + --location westus2 \ + --yes +``` + +Interaction with this service begins with an instance of a [client](#textanalyticsclient "TextAnalyticsClient"). +To create a client object, you will need the cognitive services or text analytics `endpoint` to +your resource and a `credential` that allows you access: + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +text_analytics_client = TextAnalyticsClient(endpoint="https://.api.cognitive.microsoft.com/", credential=credential) +``` + +Note that if you create a [custom subdomain][cognitive_custom_subdomain] +name for your resource the endpoint may look different than in the above code snippet. +For example, `https://.cognitiveservices.azure.com/`. + +### Install the package +Install the Azure Text Analytics client library for Python with [pip][pip]: + +```bash +pip install azure-ai-textanalytics +``` + +> Note: This version of the client library supports the v3.0 version of the Text Analytics service + +### Authenticate the client +#### Get the endpoint +You can find the endpoint for your text analytics resource using the +[Azure Portal][azure_portal_get_endpoint] +or [Azure CLI][azure_cli_endpoint_lookup]: + +```bash +# Get the endpoint for the text analytics resource +az cognitiveservices account show --name "resource-name" --resource-group "resource-group-name" --query "endpoint" +``` + +#### Get the API Key +You can get the [API key][cognitive_authentication_api_key] from the Cognitive Services or Text Analytics resource in the [Azure Portal][azure_portal_get_endpoint]. +Alternatively, you can use [Azure CLI][azure_cli_endpoint_lookup] snippet below to get the API key of your resource. + +```az cognitiveservices account keys list --name "resource-name" --resource-group "resource-group-name"``` + +#### Create a TextAnalyticsClient with an API Key Credential +Once you have the value for the API key, you can pass it as a string into an instance of [AzureKeyCredential][azure-key-credential]. Use the key as the credential parameter +to authenticate the client: + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +text_analytics_client = TextAnalyticsClient(endpoint="https://.api.cognitive.microsoft.com/", credential=credential) +``` + +#### Create a TextAnalyticsClient with an Azure Active Directory Credential +To use an [Azure Active Directory (AAD) token credential][cognitive_authentication_aad], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. +Note that regional endpoints do not support AAD authentication. Create a [custom subdomain][custom_subdomain] +name for your resource in order to use this type of authentication. + +Authentication with AAD requires some initial setup: +* [Install azure-identity][install_azure_identity] +* [Register a new AAD application][register_aad_app] +* [Grant access][grant_role_access] to Text Analytics by assigning the `"Cognitive Services User"` role to your service principal. + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] +can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET + +Use the returned token credential to authenticate the client: +```python +from azure.ai.textanalytics import TextAnalyticsClient +from azure.identity import DefaultAzureCredential + +credential = DefaultAzureCredential() +text_analytics_client = TextAnalyticsClient(endpoint="https://.api.cognitive.microsoft.com/", credential=credential) +``` + +## Key concepts + +### TextAnalyticsClient +The Text Analytics client library provides a [TextAnalyticsClient][text_analytics_client] to do analysis on [batches of documents](#examples "Examples"). +It provides both synchronous and asynchronous operations to access a specific use of Text Analytics, such as language detection or key phrase extraction. + +### Input +A **document** is a single unit to be analyzed by the predictive models in the Text Analytics service. +The input for each operation is passed as a **list** of documents. + +Each document can be passed as a string in the list, e.g. +```python +documents = ["I hated the movie. It was so slow!", "The movie made it into my top ten favorites.", "What a great movie!"] +``` + +or, if you wish to pass in a per-item document `id` or `language`/`country_hint`, they can be passed as a list of +[DetectLanguageInput][detect_language_input] or +[TextDocumentInput][text_document_input] +or a dict-like representation of the object: + +```python +documents = [ + {"id": "1", "language": "en", "text": "I hated the movie. It was so slow!"}, + {"id": "2", "language": "en", "text": "The movie made it into my top ten favorites."}, + {"id": "3", "language": "en", "text": "What a great movie!"} +] +``` + +See [service limitations][service_limits] for the input, including document length limits, maximum batch size, and supported text encoding. + +### Return Value +The return value for a single document can be a result or error object. +A heterogeneous list containing a collection of result and error objects is returned from each operation. +These results/errors are index-matched with the order of the provided documents. + +A **result**, such as [AnalyzeSentimentResult][analyze_sentiment_result], +is the result of a Text Analytics operation and contains a prediction or predictions about a document input. + +The **error** object, [DocumentError][document_error], indicates that the service had trouble processing the document and contains +the reason it was unsuccessful. + +### Document Error Handling +You can filter for a result or error object in the list by using the `is_error` attribute. For a result object this is always `False` and for a +[DocumentError][document_error] this is `True`. + +For example, to filter out all DocumentErrors you might use list comprehension: +```python +response = text_analytics_client.analyze_sentiment(documents) +successful_responses = [doc for doc in response if not doc.is_error] +``` + + +## Examples +The following section provides several code snippets covering some of the most common Text Analytics tasks, including: + +* [Analyze Sentiment](#analyze-sentiment "Analyze sentiment") +* [Recognize Entities](#recognize-entities "Recognize entities") +* [Recognize Linked Entities](#recognize-linked-entities "Recognize linked entities") +* [Extract Key Phrases](#extract-key-phrases "Extract key phrases") +* [Detect Language](#detect-language "Detect language") + +### Analyze sentiment +[analyze_sentiment][analyze_sentiment] looks at its input text and determines whether its sentiment is positive, negative, neutral or mixed. It's response includes per-sentence sentiment analysis and confidence scores. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +endpoint="https://.api.cognitive.microsoft.com/" + +text_analytics_client = TextAnalyticsClient(endpoint, credential) + +documents = [ + "I did not like the restaurant. The food was too spicy.", + "The restaurant was decorated beautifully. The atmosphere was unlike any other restaurant I've been to.", + "The food was yummy. :)" +] + +response = text_analytics_client.analyze_sentiment(documents, language="en") +result = [doc for doc in response if not doc.is_error] + +for doc in result: + print("Overall sentiment: {}".format(doc.sentiment)) + print("Scores: positive={}; neutral={}; negative={} \n".format( + doc.confidence_scores.positive, + doc.confidence_scores.neutral, + doc.confidence_scores.negative, + )) +``` + +The returned response is a heterogeneous list of result and error objects: list[[AnalyzeSentimentResult][analyze_sentiment_result], [DocumentError][document_error]] + +Please refer to the service documentation for a conceptual discussion of [sentiment analysis][sentiment_analysis]. + +### Recognize entities +[recognize_entities][recognize_entities] recognizes and categories entities in its input text as people, places, organizations, date/time, quantities, percentages, currencies, and more. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +endpoint="https://.api.cognitive.microsoft.com/" + +text_analytics_client = TextAnalyticsClient(endpoint, credential) + +documents = [ + "Microsoft was founded by Bill Gates and Paul Allen.", + "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.", + "Jeff bought three dozen eggs because there was a 50% discount." +] + +response = text_analytics_client.recognize_entities(documents, language="en") +result = [doc for doc in response if not doc.is_error] + +for doc in result: + for entity in doc.entities: + print("Entity: \t", entity.text, "\tCategory: \t", entity.category, + "\tConfidence Score: \t", entity.confidence_score) +``` + +The returned response is a heterogeneous list of result and error objects: list[[RecognizeEntitiesResult][recognize_entities_result], [DocumentError][document_error]] + +Please refer to the service documentation for a conceptual discussion of [named entity recognition][named_entity_recognition] +and [supported types][named_entity_categories]. + +### Recognize linked entities +[recognize_linked_entities][recognize_linked_entities] recognizes and disambiguates the identity of each entity found in its input text (for example, +determining whether an occurrence of the word Mars refers to the planet, or to the +Roman god of war). Recognized entities are associated with URLs to a well-known knowledge base, like Wikipedia. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +endpoint="https://.api.cognitive.microsoft.com/" + +text_analytics_client = TextAnalyticsClient(endpoint, credential) + +documents = [ + "Microsoft was founded by Bill Gates and Paul Allen.", + "Easter Island, a Chilean territory, is a remote volcanic island in Polynesia." +] + +response = text_analytics_client.recognize_linked_entities(documents, language="en") +result = [doc for doc in response if not doc.is_error] + +for doc in result: + for entity in doc.entities: + print("Entity: {}".format(entity.name)) + print("URL: {}".format(entity.url)) + print("Data Source: {}".format(entity.data_source)) + for match in entity.matches: + print("Confidence Score: {}".format(match.confidence_score)) + print("Entity as appears in request: {}".format(match.text)) +``` + +The returned response is a heterogeneous list of result and error objects: list[[RecognizeLinkedEntitiesResult][recognize_linked_entities_result], [DocumentError][document_error]] + +Please refer to the service documentation for a conceptual discussion of [entity linking][linked_entity_recognition] +and [supported types][linked_entities_categories]. + +### Extract key phrases +[extract_key_phrases][extract_key_phrases] determines the main talking points in its input text. For example, for the input text "The food was delicious and there were wonderful staff", the API returns: "food" and "wonderful staff". + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +endpoint="https://.api.cognitive.microsoft.com/" + +text_analytics_client = TextAnalyticsClient(endpoint, credential) + +documents = [ + "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.", + "I need to take my cat to the veterinarian.", + "I will travel to South America in the summer." +] + +response = text_analytics_client.extract_key_phrases(documents, language="en") +result = [doc for doc in response if not doc.is_error] + +for doc in result: + print(doc.key_phrases) +``` + +The returned response is a heterogeneous list of result and error objects: list[[ExtractKeyPhrasesResult][extract_key_phrases_result], [DocumentError][document_error]] + +Please refer to the service documentation for a conceptual discussion of [key phrase extraction][key_phrase_extraction]. + +### Detect language +[detect_language][detect_language] determines the language of its input text, including the confidence score of the predicted language. + +```python +from azure.core.credentials import AzureKeyCredential +from azure.ai.textanalytics import TextAnalyticsClient + +credential = AzureKeyCredential("") +endpoint="https://.api.cognitive.microsoft.com/" + +text_analytics_client = TextAnalyticsClient(endpoint, credential) + +documents = [ + "This is written in English.", + "Il documento scritto in italiano.", + "Dies ist in deutsche Sprache verfasst." +] + +response = text_analytics_client.detect_language(documents) +result = [doc for doc in response if not doc.is_error] + +for doc in result: + print("Language detected: {}".format(doc.primary_language.name)) + print("ISO6391 name: {}".format(doc.primary_language.iso6391_name)) + print("Confidence score: {}\n".format(doc.primary_language.confidence_score)) +``` + +The returned response is a heterogeneous list of result and error objects: list[[DetectLanguageResult][detect_language_result], [DocumentError][document_error]] + +Please refer to the service documentation for a conceptual discussion of [language detection][language_detection] +and [language and regional support][language_and_regional_support]. + +## Optional Configuration + +Optional keyword arguments can be passed in at the client and per-operation level. +The azure-core [reference documentation][azure_core_ref_docs] +describes available configurations for retries, logging, transport protocols, and more. + +## Troubleshooting + +### General +The Text Analytics client will raise exceptions defined in [Azure Core][azure_core]. + +### Logging +This library uses the standard +[logging][python_logging] library for logging. +Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO +level. + +Detailed DEBUG level logging, including request/response bodies and unredacted +headers, can be enabled on a client with the `logging_enable` keyword argument: +```python +import sys +import logging +from azure.identity import DefaultAzureCredential +from azure.ai.textanalytics import TextAnalyticsClient + +# Create a logger for the 'azure' SDK +logger = logging.getLogger('azure') +logger.setLevel(logging.DEBUG) + +# Configure a console output +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +endpoint = "https://.cognitiveservices.azure.com/" +credential = DefaultAzureCredential() + +# This client will log detailed information about its HTTP sessions, at DEBUG level +text_analytics_client = TextAnalyticsClient(endpoint, credential, logging_enable=True) +result = text_analytics_client.analyze_sentiment(["I did not like the restaurant. The food was too spicy."]) +``` + +Similarly, `logging_enable` can enable detailed logging for a single operation, +even when it isn't enabled for the client: +```python +result = text_analytics_client.analyze_sentiment(documents, logging_enable=True) +``` + +## Next steps + +### More sample code + +These code samples show common scenario operations with the Azure Text Analytics client library. +The async versions of the samples (the python sample files appended with `_async`) show asynchronous operations +with Text Analytics and require Python 3.5 or later. + +Authenticate the client with a Cognitive Services/Text Analytics API key or a token credential from [azure-identity][azure_identity]: +* [sample_authentication.py][sample_authentication] ([async version][sample_authentication_async]) + +In a batch of documents: +* Analyze sentiment: [sample_analyze_sentiment.py][analyze_sentiment_sample] ([async version][analyze_sentiment_sample_async]) +* Recognize entities: [sample_recognize_entities.py][recognize_entities_sample] ([async version][recognize_entities_sample_async]) +* Recognize linked entities: [sample_recognize_linked_entities.py][recognize_linked_entities_sample] ([async version][recognize_linked_entities_sample_async]) +* Extract key phrases: [sample_extract_key_phrases.py][extract_key_phrases_sample] ([async version][extract_key_phrases_sample_async]) +* Detect language: [sample_detect_language.py][detect_language_sample] ([async version][detect_language_sample_async]) + +### Additional documentation +For more extensive documentation on Azure Cognitive Services Text Analytics, see the [Text Analytics documentation][TA_product_documentation] on docs.microsoft.com. + +## Contributing +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. + + + +[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics +[TA_pypi]: https://pypi.org/project/azure-ai-textanalytics/ +[TA_ref_docs]: https://aka.ms/azsdk-python-textanalytics-ref-docs +[TA_samples]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples +[TA_product_documentation]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview +[azure_subscription]: https://azure.microsoft.com/free/ +[TA_or_CS_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows +[pip]: https://pypi.org/project/pip/ + +[azure_portal_create_TA_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextAnalytics +[azure_cli_create_TA_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows +[multi_and_single_service]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows +[azure_cli_endpoint_lookup]: https://docs.microsoft.com/cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show +[azure_portal_get_endpoint]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[cognitive_authentication]: https://docs.microsoft.com/azure/cognitive-services/authentication +[cognitive_authentication_api_key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity#install-the-package +[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal +[grant_role_access]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal +[cognitive_custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-custom-subdomains +[custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain +[cognitive_authentication_aad]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity#credentials +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity#defaultazurecredential +[service_limits]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview#data-limits +[azure-key-credential]: https://aka.ms/azsdk-python-core-azurekeycredential + +[document_error]: https://aka.ms/azsdk-python-textanalytics-documenterror +[detect_language_result]: https://aka.ms/azsdk-python-textanalytics-detectlanguageresult +[recognize_entities_result]: https://aka.ms/azsdk-python-textanalytics-recognizeentitiesresult +[recognize_linked_entities_result]: https://aka.ms/azsdk-python-textanalytics-recognizelinkedentitiesresult +[analyze_sentiment_result]: https://aka.ms/azsdk-python-textanalytics-analyzesentimentresult +[extract_key_phrases_result]: https://aka.ms/azsdk-python-textanalytics-extractkeyphrasesresult +[text_document_input]: https://aka.ms/azsdk-python-textanalytics-textdocumentinput +[detect_language_input]: https://aka.ms/azsdk-python-textanalytics-detectlanguageinput +[text_analytics_client]: https://aka.ms/azsdk-python-textanalytics-textanalyticsclient + +[analyze_sentiment]: https://aka.ms/azsdk-python-textanalytics-analyzesentiment +[recognize_entities]: https://aka.ms/azsdk-python-textanalytics-recognizeentities +[recognize_linked_entities]: https://aka.ms/azsdk-python-textanalytics-recognizelinkedentities +[extract_key_phrases]: https://aka.ms/azsdk-python-textanalytics-extractkeyphrases +[detect_language]: https://aka.ms/azsdk-python-textanalytics-detectlanguage + +[language_detection]: https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-language-detection +[language_and_regional_support]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support +[sentiment_analysis]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis +[key_phrase_extraction]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-keyword-extraction +[linked_entities_categories]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/named-entity-types?tabs=general +[linked_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking +[named_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking +[named_entity_categories]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/named-entity-types?tabs=general + +[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies +[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/README.md +[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity +[python_logging]: https://docs.python.org/3.5/library/logging.html +[sample_authentication]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_authentication.py +[sample_authentication_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_authentication_async.py +[detect_language_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_detect_language.py +[detect_language_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_detect_language_async.py +[analyze_sentiment_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment.py +[analyze_sentiment_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_async.py +[extract_key_phrases_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_extract_key_phrases.py +[extract_key_phrases_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_extract_key_phrases_async.py +[recognize_entities_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_entities.py +[recognize_entities_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_entities_async.py +[recognize_linked_entities_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_linked_entities.py +[recognize_linked_entities_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_linked_entities_async.py + +[cla]: https://cla.microsoft.com +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com + diff --git a/docs-ref-services/legacy/app-service.md b/docs-ref-services/legacy/app-service.md new file mode 100644 index 00000000..3409a017 --- /dev/null +++ b/docs-ref-services/legacy/app-service.md @@ -0,0 +1,73 @@ +--- +title: Azure Web Apps libraries for Python +description: +keywords: Azure, Python, SDK, API, web apps, App Service +ms.date: 06/12/2017 +ms.topic: reference +ms.devlang: python +ms.service: app-service +manager: douge +--- +# Azure Web Apps libraries for Python + +## Overview + +Deploy and scale websites, web applications, services, and REST APIs with [Azure App Service](/azure/app-service). + +To get started with Azure App Service, see [Create a Python web app in Azure](/azure/app-service-web/app-service-web-get-started-python). + +## Management API + +Deploy, manage, and scale elements hosted in the Azure App Service with the management API. + +Install the library via pip. + +```bash +pip install azure-mgmt-web +``` + +### Example + +Deploy a webapp from a GitHub repository into Azure Web App. + +```python +siteConfiguration = SiteConfig( + python_version='3.4' +) + +# create a web app +web_client.web_apps.create_or_update( + RESOURCE_GROUP_NAME, + WEB_APP_NAME, + Site( + location='eastus', + server_farm_id=SERVICE_PLAN_ID, + site_config=siteConfiguration + ) +) + +# continuous deployment with GitHub +source_control_async_operation = web_client.web_apps.create_or_update_source_control( + RESOURCE_GROUP_NAME, + WEB_APP_NAME, + SiteSourceControl( + location='GitHub', + repo_url='https://github.com/lisawong19/python-docs-hello-world', + branch='master' + ) +) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/webapps/management) + +## Samples + +* [Manage Azure websites with python][1] +* [Create a Logic App workflow][2] + +View the [complete list](https://azure.microsoft.com/resources/samples/?platform=python&term=web-app) of web application samples. + +[1]: https://github.com/Azure-Samples/app-service-web-python-manage +[2]: /azure/python/python-sdk-azure-samples-logic-app-workflow + diff --git a/docs-ref-services/legacy/appconfiguration-readme.md b/docs-ref-services/legacy/appconfiguration-readme.md new file mode 100644 index 00000000..801fe99e --- /dev/null +++ b/docs-ref-services/legacy/appconfiguration-readme.md @@ -0,0 +1,319 @@ +--- +title: Azure App Configuration client library for Python +keywords: Azure, python, SDK, API, azure-appconfiguration, appconfiguration +ms.date: 10/05/2020 +ms.topic: reference +ms.devlang: python +ms.service: azure-app-configuration +--- +# Azure App Configuration client library for Python - version 1.1.1 + + +Azure App Configuration is a managed service that helps developers centralize their application configurations simply and securely. + +Modern programs, especially programs running in a cloud, generally have many components that are distributed in nature. Spreading configuration settings across these components can lead to hard-to-troubleshoot errors during an application deployment. Use App Configuration to securely store all the settings for your application in one place. + +Use the client library for App Configuration to create and manage application configuration settings. + +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration) | [Product documentation][appconfig_docs] + +## Getting started + +### Install the package + +Install the Azure App Configuration client library for Python with pip: + +```commandline +pip install azure-appconfiguration +``` + +### Prerequisites + +* Python 2.7, or 3.5 or later is required to use this package. +* You need an [Azure subscription][azure_sub], and a [Configuration Store][configuration_store] to use this package. + +To create a Configuration Store, you can use the Azure Portal or [Azure CLI][azure_cli]. + +After that, create the Configuration Store: + +```Powershell +az appconfig create --name --resource-group --location eastus +``` + +### Authenticate the client + +In order to interact with the App Configuration service, you'll need to create an instance of the +[AzureAppConfigurationClient][configuration_client_class] class. To make this possible, +you can either use the connection string of the Configuration Store or use an AAD token. + +#### Use connection string + +##### Get credentials + +Use the [Azure CLI][azure_cli] snippet below to get the connection string from the Configuration Store. + +```Powershell +az appconfig credential list --name +``` + +Alternatively, get the connection string from the Azure Portal. + +##### Create client + +Once you have the value of the connection string, you can create the AzureAppConfigurationClient: + +```python +from azure.appconfiguration import AzureAppConfigurationClient + +connection_str = "" +client = AzureAppConfigurationClient.from_connection_string(connection_str) +``` + +#### Use AAD token + +Here we demonstrate using [DefaultAzureCredential][default_cred_ref] +to authenticate as a service principal. However, [AzureAppConfigurationClient][configuration_client_class] +accepts any [azure-identity][azure_identity] credential. See the +[azure-identity][azure_identity] documentation for more information about other +credentials. + +##### Create a service principal (optional) +This [Azure CLI][azure_cli] snippet shows how to create a +new service principal. Before using it, replace "your-application-name" with +the appropriate name for your service principal. + +Create a service principal: +```Bash +az ad sp create-for-rbac --name http://my-application --skip-assignment +``` + +> Output: +> ```json +> { +> "appId": "generated app id", +> "displayName": "my-application", +> "name": "http://my-application", +> "password": "random password", +> "tenant": "tenant id" +> } +> ``` + +Use the output to set **AZURE_CLIENT_ID** ("appId" above), **AZURE_CLIENT_SECRET** +("password" above) and **AZURE_TENANT_ID** ("tenant" above) environment variables. +The following example shows a way to do this in Bash: +```Bash +export AZURE_CLIENT_ID="generated app id" +export AZURE_CLIENT_SECRET="random password" +export AZURE_TENANT_ID="tenant id" +``` + +Assign one of the applicable [App Configuration roles](https://github.com/Azure/AppConfiguration/blob/master/docs/REST/authorization/aad.md) to the service principal. + +##### Create a client +Once the **AZURE_CLIENT_ID**, **AZURE_CLIENT_SECRET** and +**AZURE_TENANT_ID** environment variables are set, +[DefaultAzureCredential][default_cred_ref] will be able to authenticate the +[AzureAppConfigurationClient][configuration_client_class]. + +Constructing the client also requires your configuration store's URL, which you can +get from the Azure CLI or the Azure Portal. In the Azure Portal, the URL can be found listed as the service "Endpoint" + +```python +from azure.identity import DefaultAzureCredential +from azure.appconfiguration import AzureAppConfigurationClient + +credential = DefaultAzureCredential() + +client = AzureAppConfigurationClient(base_url="your_endpoint_url", credential=credential) +``` + +## Key concepts + +### Configuration Setting + +A Configuration Setting is the fundamental resource within a Configuration Store. In its simplest form it is a key and a value. However, there are additional properties such as the modifiable content type and tags fields that allow the value to be interpreted or associated in different ways. + +The Label property of a Configuration Setting provides a way to separate Configuration Settings into different dimensions. These dimensions are user defined and can take any form. Some common examples of dimensions to use for a label include regions, semantic versions, or environments. Many applications have a required set of configuration keys that have varying values as the application exists across different dimensions. +For example, MaxRequests may be 100 in "NorthAmerica", and 200 in "WestEurope". By creating a Configuration Setting named MaxRequests with a label of "NorthAmerica" and another, only with a different value, in the "WestEurope" label, an application can seamlessly retrieve Configuration Settings as it runs in these two dimensions. + +Properties of a Configuration Setting: + +```python +key : str +label : str +content_type : str +value : str +last_modified : str +read_only : bool +tags : dict +etag : str +``` + +## Examples + +The following sections provide several code snippets covering some of the most common Configuration Service tasks, including: + +* [Create a Configuration Setting](#create-a-configuration-setting) +* [Get a Configuration Setting](#get-a-configuration-setting) +* [Delete a Configuration Setting](#delete-a-configuration-setting) +* [List Configuration Settings](#list-configuration-settings) +* [Async APIs](#async-apis) + +### Create a Configuration Setting + +Create a Configuration Setting to be stored in the Configuration Store. +There are two ways to store a Configuration Setting: + +- add_configuration_setting creates a setting only if the setting does not already exist in the store. + +```python +config_setting = ConfigurationSetting( + key="MyKey", + label="MyLabel", + value="my value", + content_type="my content type", + tags={"my tag": "my tag value"} +) +added_config_setting = client.add_configuration_setting(config_setting) +``` + +- set_configuration_setting creates a setting if it doesn't exist or overrides an existing setting. + +```python +config_setting = ConfigurationSetting( + key="MyKey", + label="MyLabel", + value="my set value", + content_type="my set content type", + tags={"my set tag": "my set tag value"} +) +returned_config_setting = client.set_configuration_setting(config_setting) +``` + +### Get a Configuration Setting + +Get a previously stored Configuration Setting. + +```python +fetched_config_setting = client.get_configuration_setting( + key="MyKey", label="MyLabel" +) +``` + +### Delete a Configuration Setting + +Delete an existing Configuration Setting. + +```python +deleted_config_setting = client.delete_configuration_setting( + key="MyKey", label="MyLabel" +) +``` + +### List Configuration Settings + +List all configuration settings filtered with label_filter and/or key_filter. + +```python + +filtered_listed = client.list_configuration_settings( + label_filter="My*", key_filter="My*" +) +for item in filtered_listed: + pass # do something + +``` + +### Async APIs + +Async client is supported for python 3.5+. +To use the async client library, import the AzureAppConfigurationClient from package azure.appconfiguration.aio instead of azure.appconfiguration + +```python +from azure.appconfiguration.aio import AzureAppConfigurationClient + +connection_str = "" +async_client = AzureAppConfigurationClient.from_connection_string(connection_str) +``` + +This async AzureAppConfigurationClient has the same method signatures as the sync ones except that they're async. +For instance, to retrieve a Configuration Setting asynchronously, async_client can be used: + +```python +fetched_config_setting = await async_client.get_configuration_setting( + key="MyKey", label="MyLabel" +) +``` + +To use list_configuration_settings, call it synchronously and iterate over the returned async iterator asynchronously + +```python + +filtered_listed = async_client.list_configuration_settings( + label_filter="My*", key_filter="My*" +) +async for item in filtered_listed: + pass # do something + +``` + +## Troubleshooting + +### Logging + +This SDK uses Python standard logging library. +You can configure logging print out debugging information to the stdout or anywhere you want. + +```python +import logging + +logging.basicConfig(level=logging.DEBUG) +```` + +Http request and response details are printed to stdout with this logging config. + +## Next steps + +### More sample code + +Several App Configuration client library samples are available to you in this GitHub repository. These include: +- [Hello world](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_async_sample.py) +- [Hello world with labels](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_advanced_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_advanced_async_sample.py) +- [Make a configuration setting readonly](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/read_only_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/hello_world_async_sample.py) +- [Read revision history](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/list_revision_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/list_revision_async_sample.py) +- [Get a setting if changed](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/conditional_operation_sample.py) / [Async version](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/conditional_operation_async_sample.py) + + For more details see the [samples README](https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/samples/README.md). + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[appconfig_docs]: https://docs.microsoft.com/azure/azure-app-configuration/ +[appconfig_rest]: https://github.com/Azure/AppConfiguration#rest-api-reference +[azure_cli]: https://docs.microsoft.com/cli/azure +[azure_sub]: https://azure.microsoft.com/free/ +[configuration_client_class]: https://github.com/Azure/azure-sdk-for-python/blob/azure-appconfiguration_1.1.1/sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py +[package]: https://pypi.org/project/azure-appconfiguration/ +[configuration_store]: https://azure.microsoft.com/services/app-configuration/ +[default_cred_ref]: https://aka.ms/azsdk-python-identity-default-cred-ref +[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/azure-appconfiguration_1.1.1/sdk/identity/azure-identity +[cla]: https://cla.microsoft.com +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com + diff --git a/docs-ref-services/legacy/application-insights-index.md b/docs-ref-services/legacy/application-insights-index.md new file mode 100644 index 00000000..48058515 --- /dev/null +++ b/docs-ref-services/legacy/application-insights-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Application Insights - Query](applicationinsights-readme.md)|[azure-applicationinsights](https://pypi.org/project/azure-applicationinsights)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/applicationinsights/azure-applicationinsights)| diff --git a/docs-ref-services/legacy/application-insights.md b/docs-ref-services/legacy/application-insights.md new file mode 100644 index 00000000..bb9454fc --- /dev/null +++ b/docs-ref-services/legacy/application-insights.md @@ -0,0 +1,11 @@ +--- +title: Azure Application Insights SDK for Python +description: Reference for Azure Application Insights SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: azure-monitor +--- +# Azure Application Insights SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](application-insights-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/applicationinsights-readme.md b/docs-ref-services/legacy/applicationinsights-readme.md new file mode 100644 index 00000000..406bbc7a --- /dev/null +++ b/docs-ref-services/legacy/applicationinsights-readme.md @@ -0,0 +1,14 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-applicationinsights, applicationinsights +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: application-insights +--- +## Microsoft Azure SDK for Python + +This package is no longer being maintained. Use the [azure-monitor-query](https://pypi.org/project/azure-monitor-query/) package instead. + +For migration instructions, see the [migration guide](https://aka.ms/azsdk/python/migrate/ai-to-monitor-query). + diff --git a/docs-ref-services/legacy/authorization.md b/docs-ref-services/legacy/authorization.md new file mode 100644 index 00000000..c09d7948 --- /dev/null +++ b/docs-ref-services/legacy/authorization.md @@ -0,0 +1,62 @@ +--- +title: Azure Authorization libraries for python +description: Reference for Azure Authorization libraries for python +keywords: Azure, python, SDK, API, Authorization +ms.date: 02/21/2018 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +manager: routlaw +--- +# Azure Authorization libraries for python + +## [Management API](/python/api/overview/azure/authorization/management) + +```bash +pip install azure-mgmt-authorization +``` + +## Create the management client + +The following code creates an instance of the management client. + +You will need to provide your ``subscription_id`` which can be retrieved from [your subscription list](https://manage.windowsazure.com/#Workspaces/AdminTasks/SubscriptionMapping). + +See [Resource Management Authentication](/python/azure/python-sdk-azure-authenticate) for details on handling Azure Active Directory authentication with the Python SDK, and creating a ``Credentials`` instance. + +```python +from azure.mgmt.authorization import AuthorizationManagementClient +from azure.common.credentials import UserPassCredentials + +# Replace this with your subscription id +subscription_id = '33333333-3333-3333-3333-333333333333' + +# See above for details on creating different types of AAD credentials +credentials = UserPassCredentials( + 'user@domain.com', # Your user + 'my_password' # Your password +) + +authorization_client = AuthorizationManagementClient( + credentials, + subscription_id +) +``` + +## Check permissions for a resource group + +The following code checks permissions in a given resource group. To create or manage resource groups, see [Resource Management](/python/api/overview/azure/azure.mgmt.resource). + +```python +from azure.mgmt.redis.models import Sku, RedisCreateOrUpdateParameters + +group_name = 'myresourcegroup' +permissions = self.authorization_client.permissions.list_for_resource_group( + group_name +) +# permissions is a iterable of Permissions instances +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/authorization/management) + diff --git a/docs-ref-services/legacy/azure-ad-b2c-index.md b/docs-ref-services/legacy/azure-ad-b2c-index.md new file mode 100644 index 00000000..644d07c7 --- /dev/null +++ b/docs-ref-services/legacy/azure-ad-b2c-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Resource Management - Azure AD B2C](mgmt-azureadb2c-readme.md)|[azure-mgmt-azureadb2c](https://pypi.org/project/azure-mgmt-azureadb2c)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/azureadb2c/azure-mgmt-azureadb2c)| diff --git a/docs-ref-services/legacy/azure-ad-b2c.md b/docs-ref-services/legacy/azure-ad-b2c.md new file mode 100644 index 00000000..a5f4da7a --- /dev/null +++ b/docs-ref-services/legacy/azure-ad-b2c.md @@ -0,0 +1,11 @@ +--- +title: Azure Azure AD B2C SDK for Python +description: Reference for Azure Azure AD B2C SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: azureadb2c +--- +# Azure Azure AD B2C SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](azure-ad-b2c-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/azure.mgmt.resource.md b/docs-ref-services/legacy/azure.mgmt.resource.md new file mode 100644 index 00000000..73384451 --- /dev/null +++ b/docs-ref-services/legacy/azure.mgmt.resource.md @@ -0,0 +1,49 @@ +--- +title: Azure Resources libraries for Python +description: +keywords: Azure, Python, SDK, API, Resources +ms.date: 06/19/2017 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +manager: douge +--- +# Azure Resources libraries for Python + +## Overview +Manage Azure resources in resource groups. + +| Package | Description | +|---|---| +|[azure.mgmt.resource.features][1]|Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users.| +|[azure.mgmt.resource.links][2]|Azure resources can be linked together to form logical relationships. You can establish links between resources belonging to different resource groups.| +|[azure.mgmt.resource.locks][3]|Azure resources can be locked to prevent other users in your organization from deleting or modifying resources.| +|[azure.mgmt.resource.managedapplications][4]|ARM managed applications (appliances).| +|[azure.mgmt.resource.policy][5]|To manage and control access to your resources, you can define customized policies and assign them at a scope.| +|[azure.mgmt.resource.resources][6]| Provides operations for working with resources and resource groups.| +|[azure.mgmt.resource.subscriptions][7]|All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants.| + +[1]: /python/api/azure.mgmt.resource.features +[2]: /python/api/azure.mgmt.resource.links +[3]: /python/api/azure.mgmt.resource.locks +[4]: /python/api/azure.mgmt.resource.managedapplications +[5]: /python/api/azure.mgmt.resource.policy +[6]: /python/api/azure.mgmt.resource.resources +[7]: /python/api/azure.mgmt.resource.subscriptions + +## Install the libraries +```bash +pip install azure-mgmt-resource +``` + +## Example +The following is an example of how to create a resource group. + +```python +from azure.mgmt.resource import ResourceManagementClient +client = ResourceManagementClient(credentials, subscription_id) +client.resource_groups.create(RESOURCE_GROUP_NAME, {'location':'eastus'}) +``` + +Explore more [sample Python code](https://azure.microsoft.com/resources/samples/?platform=python) you can use in your apps. + diff --git a/docs-ref-services/legacy/batch-ai-index.md b/docs-ref-services/legacy/batch-ai-index.md new file mode 100644 index 00000000..5ac05a6c --- /dev/null +++ b/docs-ref-services/legacy/batch-ai-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Resource Management - Batch AI](mgmt-batchai-readme.md)|[azure-mgmt-batchai](https://pypi.org/project/azure-mgmt-batchai)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/batchai/azure-mgmt-batchai)| diff --git a/docs-ref-services/legacy/batch-ai.md b/docs-ref-services/legacy/batch-ai.md new file mode 100644 index 00000000..deacf54a --- /dev/null +++ b/docs-ref-services/legacy/batch-ai.md @@ -0,0 +1,11 @@ +--- +title: Azure Batch AI SDK for Python +description: Reference for Azure Batch AI SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: batchai +--- +# Azure Batch AI SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](batch-ai-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/batch.md b/docs-ref-services/legacy/batch.md new file mode 100644 index 00000000..97c13321 --- /dev/null +++ b/docs-ref-services/legacy/batch.md @@ -0,0 +1,101 @@ +--- +title: Azure Batch libraries for Python +description: Reference documentation for the Python Batch libraries +keywords: Azure, Python, SDK, API, Batch, processing, scheduling, long-running +ms.date: 07/31/2017 +ms.topic: reference +ms.devlang: python +ms.service: batch +manager: douge +--- +# Azure Batch libraries for python + +## Overview + +Run large-scale parallel and high-performance computing applications efficiently in the cloud with [Azure Batch](/azure/batch/batch-technical-overview). + +To get started with Azure Batch, see [Create a Batch account with the Azure portal](/azure/batch/batch-account-create-portal). + +## Install the libraries + +## Client library +The Azure Batch client libraries let you configure compute nodes and pools, define tasks and configure them to run in jobs, and set up a job manager to control and monitor job execution. [Learn more](/azure/batch/batch-api-basics) about using these objects to run large-scale parallel compute solutions. + +```bash +pip install azure-batch +``` +### Example + +Set up a pool of Linux compute nodes in a batch account: + +```python +# create the batch client for an account using its URI and keys +creds = batchauth.SharedKeyCredentials(account, key) +config = batch.BatchServiceClientConfiguration(creds, base_url = batch_url) +client = batch.BatchServiceClient(config) + +# Create the VirtualMachineConfiguration, specifying +# the VM image reference and the Batch node agent to +# be installed on the node. +vmc = batchmodels.VirtualMachineConfiguration( + image_reference = ir, + node_agent_sku_id = "batch.node.ubuntu 14.04") + +# Assign the virtual machine configuration to the pool +new_pool.virtual_machine_configuration = vmc + +# Create pool in the Batch service +client.pool.add(new_pool) +``` + +> [!div class="nextstepaction"] +> [Explore the Client APIs](/python/api/overview/azure/batch/client) + +## Management API +Use the Azure Batch management libraries to create and delete batch accounts, read and regenerate batch account keys, and manage batch account storage. + +```bash +pip install azure-mgmt-batch +``` + +### Example +Create an Azure Batch account and configure a new application and Azure storage account for it. + +```python +from azure.mgmt.batch import BatchManagementClient +from azure.mgmt.resource import ResourceManagementClient +from azure.mgmt.storage import StorageManagementClient + +LOCATION ='eastus' +GROUP_NAME ='batchresourcegroup' +STORAGE_ACCOUNT_NAME ='batchstorageaccount' + +# Create Resource group +print('Create Resource Group') +resource_client.resource_groups.create_or_update(GROUP_NAME, {'location': LOCATION}) + +# Create a storage account +storage_async_operation = storage_client.storage_accounts.create( + GROUP_NAME, + STORAGE_ACCOUNT_NAME, + StorageAccountCreateParameters( + sku=Sku(SkuName.standard_ragrs), + kind=Kind.storage, + location=LOCATION + ) +) +storage_account = storage_async_operation.result() + +# Create a Batch Account, specifying the storage account we want to link +storage_resource = storage_account.id +batch_account = azure.mgmt.batch.models.BatchAccountCreateParameters( + location=LOCATION, + auto_storage=azure.mgmt.batch.models.AutoStorageBaseProperties(storage_resource) +) +creating = batch_client.account.create('MyBatchAccount', LOCATION, batch_account) +creating.wait() +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/batch/management) + diff --git a/docs-ref-services/legacy/batchai.md b/docs-ref-services/legacy/batchai.md new file mode 100644 index 00000000..9476707f --- /dev/null +++ b/docs-ref-services/legacy/batchai.md @@ -0,0 +1,15 @@ +--- +title: Azure Batch AI libraries for Python +description: Reference documentation for the Python client libraries for Azure Batch AI +keywords: Azure, Python, SDK, API, SQL, database, PostGres,Cosmos DB, NoSQL +ms.date: 03/26/2019 +ms.topic: reference +ms.devlang: python +ms.service: batch-ai +manager: cjgronlun +--- +# Azure Batch AI libraries for Python + +>[!Note] +>**Azure Batch AI has been retired.** The capabilities of Azure Batch AI are now available as a managed compute target in Azure Machine Learning. For more information, see [What happened to Batch AI?](https://aka.ms/batchai-retirement) + diff --git a/docs-ref-services/legacy/cache-for-redis.md b/docs-ref-services/legacy/cache-for-redis.md new file mode 100644 index 00000000..0feeba12 --- /dev/null +++ b/docs-ref-services/legacy/cache-for-redis.md @@ -0,0 +1,57 @@ +--- +title: Azure Redis libraries for Python +description: Reference documentation for the Python client libraries for Redis +keywords: Azure, Python, Redis, API, SDK, database, NoSQL +ms.date: 06/26/2017 +ms.topic: reference +ms.devlang: python +ms.service: redis +manager: douge +--- +# Azure Redis Cache libraries for Python + +## Overview + +Azure Redis Cache is based on the popular open source Redis project. It gives you access to a secure, dedicated Redis instance, managed by Microsoft and accessible from your Azure apps. + +Redis is an advanced key-value store, where keys can contain data structures such as strings, hashes, lists, sets, and sorted sets. Redis supports a set of atomic operations on these data types. + +Learn more about [Azure Redis Cache](https://docs.microsoft.com/azure/redis-cache/). + +## Management API + +Create and manage your Redis resources in your subscription with the Redis management API. + +```bash +pip install redis +pip install azure-mgmt-redis +``` + +### Example + +The following example creates a new Redis cache: + +```python +from azure.mgmt.redis import RedisManagementClient +from azure.mgmt.redis.models import Sku, RedisCreateOrUpdateParameters + +redis_client = RedisManagementClient( + credentials, + subscription_id +) +group_name = 'myresourcegroup' +cache_name = 'mycachename' +redis_cache = redis_client.redis.create_or_update( + group_name, + cache_name, + RedisCreateOrUpdateParameters( + sku = Sku(name = 'Basic', family = 'C', capacity = '1'), + location = "East US" + ) +) +# redis_cache is a RedisResourceWithAccessKey instance +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/redis/management) + diff --git a/docs-ref-services/legacy/cognitive-services-index.md b/docs-ref-services/legacy/cognitive-services-index.md new file mode 100644 index 00000000..e2bf9007 --- /dev/null +++ b/docs-ref-services/legacy/cognitive-services-index.md @@ -0,0 +1,11 @@ +| Reference | Package | Source | +|---|---|---| +|Azure AI Vision SDK|[azure-ai-vision](https://pypi.org/project/azure-ai-vision)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/)| +|[Anomaly Detector](cognitiveservices-anomalydetector-readme.md)|[azure-cognitiveservices-anomalydetector](https://pypi.org/project/azure-cognitiveservices-anomalydetector)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-anomalydetector)| +|[Question Answering](cognitiveservices-knowledge-qnamaker-readme.md)|[azure-cognitiveservices-knowledge-qnamaker](https://pypi.org/project/azure-cognitiveservices-knowledge-qnamaker)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker)| +|[Conversational Language Understanding](cognitiveservices-language-luis-readme.md)|[azure-cognitiveservices-language-luis](https://pypi.org/project/azure-cognitiveservices-language-luis)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-language-luis)| +|[Spell Check](cognitiveservices-language-spellcheck-readme.md)|[azure-cognitiveservices-language-spellcheck](https://pypi.org/project/azure-cognitiveservices-language-spellcheck)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-language-spellcheck)| +|[Text Analytics](cognitiveservices-language-textanalytics-readme.md)|[azure-cognitiveservices-language-textanalytics](https://pypi.org/project/azure-cognitiveservices-language-textanalytics)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics)| +|[Computer Vision](cognitiveservices-vision-computervision-readme.md)|[azure-cognitiveservices-vision-computervision](https://pypi.org/project/azure-cognitiveservices-vision-computervision)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-vision-computervision)| +|[Content Safety](cognitiveservices-vision-contentmoderator-readme.md)|[azure-cognitiveservices-vision-contentmoderator](https://pypi.org/project/azure-cognitiveservices-vision-contentmoderator)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-vision-contentmoderator)| +|[Custom Vision](cognitiveservices-vision-customvision-readme.md)|[azure-cognitiveservices-vision-customvision](https://pypi.org/project/azure-cognitiveservices-vision-customvision)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-vision-customvision)| diff --git a/docs-ref-services/legacy/cognitive-services.md b/docs-ref-services/legacy/cognitive-services.md new file mode 100644 index 00000000..007b9dfe --- /dev/null +++ b/docs-ref-services/legacy/cognitive-services.md @@ -0,0 +1,193 @@ +--- +title: Azure Cognitive Services SDK for Python +description: Reference for Azure Cognitive Services SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +keywords: Azure, python, SDK, API, Cognitive Services +manager: angerobe +--- +# Azure Cognitive Services modules for Python + +Add image and face recognition, language analysis, and search to your Python apps, websites, and tools using the Azure Cognitive Services modules for Python. + +## Vision modules + +### Computer Vision + +Returns information about visual content found in an image: + +- Use tagging, descriptions, and domain-specific models to identify content and label it with confidence. +- Apply adult/racy settings to enable automated restriction of adult content. +- Identify image types and color schemes in pictures. + +[Try Computer Vision](https://azure.microsoft.com/en-us/services/cognitive-services/computer-vision/) for free in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-vision-computervision +``` + +[Learn more](/azure/cognitive-services/computer-vision/home) about the Computer Vision API and get started with the [Computer Vision API Python quickstart](/azure/cognitive-services/computer-vision/quickstarts/python). + +### Content Moderator + +Machine-assisted moderation of text, video and images, augmented with human review tools. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-vision-contentmoderator +``` + +[Learn more](/azure/cognitive-services/content-moderator/overview) about the Content Moderator service. + +### Custom Vision Service + +Upload images to train and customize a computer vision model for your specific use case. Once the model is trained, you can use the API to tag images using the model and evaluate the results to improve your classifier. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-vision-customvision +``` + +[Learn more](/azure/cognitive-services/Custom-Vision-Service/home) about the Custom Vision service and get started with the [Custom Vision Python tutorial](/azure/cognitive-services/Custom-Vision-Service/python-tutorial) + +### Face API + +Detect, identify, analyze, organize, and tag faces in photos. + +[Try the Face API](https://azure.microsoft.com/en-us/services/cognitive-services/face/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install cognitive-face +``` + +[Learn more](/azure/cognitive-services/face/overview) about the Face API and get started with the [Face API Python quickstart](/azure/cognitive-services/Face/Tutorials/FaceAPIinPythonTutorial). + +## Search modules + +### Web search + +Retrieve web documents indexed by the Bing Web Search API and narrow down the results by result type, freshness and more. + +[Try the Web Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-websearch +``` + +[Learn more](/azure/cognitive-services/bing-web-search/overview) about the Bing Web Search API and get started with the [Web Search API Python quickstart](/azure/cognitive-services/bing-web-search/quickstarts/python). + +### Image search + +Search for images and get thumbnails, full image URLs, image metadata and more in your results. + +[Try the Image Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-imagesearch +``` + +[Learn more](/azure/cognitive-services/bing-image-search/overview) about the Bing Image Search API and get started with the [Image Search API Python quickstart](/azure/cognitive-services/bing-image-search/quickstarts/python). + + +### Entity search + +Search for the most relevant entity (place, person, or thing) for a given search term or location. + +[Try the Entity Search API](https://azure.microsoft.com/services/cognitive-services/bing-entity-search-api/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-entitysearch +``` + +[Learn more](/azure/cognitive-services/bing-entities-search/search-the-web) about the Bing Entity Search API and get started with the [Entity Search API Python quickstart](/azure/cognitive-services/bing-entities-search/quickstarts/python). + +### Custom search + +Build and a custom web search that meets your specific search domain. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-customsearch +``` + +[Learn more](/azure/cognitive-services/bing-custom-search/) about the Bing Custom Search service and get started with querying your custom search from Python with the [Custom Search API Python quickstart](/azure/cognitive-services/bing-custom-search/call-endpoint-python). + +### Video search + +Find videos across the web and get results with creator, encoding, length, and view count metadata. + +[Try the Video Search API](https://azure.microsoft.com/services/cognitive-services/bing-video-search-api/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-videosearch +``` + +[Learn more](/azure/cognitive-services/bing-video-search/search-the-web) about the Bing Video Search service and get started with the [Video Search API Python quickstart](/azure/cognitive-services/bing-video-search/python). + + +### News search + +Search the web for news articles and work with article, related news, images, and provider info metadata. + +[Try the News Search API](https://azure.microsoft.com/services/cognitive-services/bing-news-search-api/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-search-newssearch +``` + +[Learn more](/azure/cognitive-services/bing-news-search/search-the-web) about the Bing News Search service and get started with the [News Search API Python quickstart](/azure/cognitive-services/bing-news-search/python). + + +## Language modules + +### Text Analytics + +The Text Analytics API is a cloud-based service that provides natural language processing over raw text. The API includes three main functions: + +- Sentiment analysis +- Key phrase extraction +- Language detection + +[Try the Text Analytics API](https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-language-textanalytics +``` + +[Learn more](/azure/cognitive-services/text-analytics/overview) about the Text Analytics API and get started with the [Text Analytics API Python quickstart](/azure/cognitive-services/text-analytics/quickstarts/python). + + +### Spell Check + +Perform contextual grammar and spell checking with the Bing Spell Check API. + +[Try the Spell Check API](https://azure.microsoft.com/en-us/services/cognitive-services/spell-check/) in your browser. + +Get the Python module with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```python +pip install azure-cognitiveservices-language-spellcheck +``` + +[Learn more](/azure/cognitive-services/bing-spell-check/proof-text) about the Spell Check API and get started with the [Spell Check API Python quickstart](/azure/cognitive-services/bing-spell-check/quickstarts/python). \ No newline at end of file diff --git a/docs-ref-services/legacy/cognitiveservices-anomalydetector-readme.md b/docs-ref-services/legacy/cognitiveservices-anomalydetector-readme.md new file mode 100644 index 00000000..00f686e5 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-anomalydetector-readme.md @@ -0,0 +1,12 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-anomalydetector, cognitiveservices +ms.date: 05/01/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package is no longer being maintained. Use the [azure-ai-anomalydetector](https://pypi.org/project/azure-ai-anomalydetector/) package instead for latest features and support. + diff --git a/docs-ref-services/legacy/cognitiveservices-knowledge-qnamaker-readme.md b/docs-ref-services/legacy/cognitiveservices-knowledge-qnamaker-readme.md new file mode 100644 index 00000000..69ed88f1 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-knowledge-qnamaker-readme.md @@ -0,0 +1,13 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-knowledge-qnamaker, cognitiveservices +ms.date: 08/14/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package is no longer being maintained. Use the [azure-ai-language-questionanswering](https://pypi.org/project/azure-ai-language-questionanswering/) package instead. + +For migration instructions, see the [migration guide](https://aka.ms/azsdk/python/migrate/azure-ai-language-questionanswering). diff --git a/docs-ref-services/legacy/cognitiveservices-language-luis-readme.md b/docs-ref-services/legacy/cognitiveservices-language-luis-readme.md new file mode 100644 index 00000000..ac294227 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-language-luis-readme.md @@ -0,0 +1,12 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-language-luis, cognitiveservices +ms.date: 08/15/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package is no longer being maintained. Use the [azure-ai-language-conversations](https://pypi.org/project/azure-ai-language-conversations/) package instead. + diff --git a/docs-ref-services/legacy/cognitiveservices-language-spellcheck-readme.md b/docs-ref-services/legacy/cognitiveservices-language-spellcheck-readme.md new file mode 100644 index 00000000..6127b791 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-language-spellcheck-readme.md @@ -0,0 +1,33 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-language-spellcheck, cognitiveservices +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: bing-spell-check +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Cognitive Services Spellcheck Client Library. +This package has been tested with Python 2.7, 3.6+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + + +# Usage + + + + +For code examples, see [Cognitive Services Spellcheck](https://docs.microsoft.com/python/api/overview/azure/cognitive-services) on docs.microsoft.com. + + +# 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. + + + + diff --git a/docs-ref-services/legacy/cognitiveservices-language-textanalytics-readme.md b/docs-ref-services/legacy/cognitiveservices-language-textanalytics-readme.md new file mode 100644 index 00000000..2179a931 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-language-textanalytics-readme.md @@ -0,0 +1,12 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-language-textanalytics, cognitiveservices +ms.date: 05/01/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package is no longer being maintained. Please install the [azure-ai-textanalytics](https://pypi.org/project/azure-ai-textanalytics/) package for the latest features and support. + diff --git a/docs-ref-services/legacy/cognitiveservices-search-newssearch-readme.md b/docs-ref-services/legacy/cognitiveservices-search-newssearch-readme.md new file mode 100644 index 00000000..6b3d94cf --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-search-newssearch-readme.md @@ -0,0 +1,33 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-search-newssearch, cognitiveservices +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: bing-news-search +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Cognitive Services News Search Client Library. +This package has been tested with Python 2.7, 3.6+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + + +# Usage + + + + +For code examples, see [Cognitive Services News Search](https://docs.microsoft.com/python/api/overview/azure/cognitive-services) on docs.microsoft.com. + + +# 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. + + + + diff --git a/docs-ref-services/legacy/cognitiveservices-search-visualsearch-readme.md b/docs-ref-services/legacy/cognitiveservices-search-visualsearch-readme.md new file mode 100644 index 00000000..43dd29d1 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-search-visualsearch-readme.md @@ -0,0 +1,33 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-search-visualsearch, cognitiveservices +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: bing-visual-search +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Cognitive Services Visual Search Client Library. +This package has been tested with Python 2.7, 3.6+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + + +# Usage + + + + +For code examples, see [Cognitive Services Visual Search](https://docs.microsoft.com/python/api/overview/azure/cognitive-services) on docs.microsoft.com. + + +# 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. + + + + diff --git a/docs-ref-services/legacy/cognitiveservices-vision-computervision-readme.md b/docs-ref-services/legacy/cognitiveservices-vision-computervision-readme.md new file mode 100644 index 00000000..1ddb6d3d --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-vision-computervision-readme.md @@ -0,0 +1,12 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-vision-computervision, cognitiveservices +ms.date: 11/01/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package has been deprecated and will no longer be maintained after 11-01-2024. This package will only receive security fixes until 11-01-2024. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-ai-vision-imageanalysis](https://pypi.org/project/azure-ai-vision-imageanalysis/). + diff --git a/docs-ref-services/legacy/cognitiveservices-vision-contentmoderator-readme.md b/docs-ref-services/legacy/cognitiveservices-vision-contentmoderator-readme.md new file mode 100644 index 00000000..6952f10c --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-vision-contentmoderator-readme.md @@ -0,0 +1,33 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-vision-contentmoderator, cognitiveservices +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: content-moderator +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Cognitive Services Content Moderator Client Library. +This package has been tested with Python 2.7, 3.6+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + + +# Usage + + + + +For code examples, see [Cognitive Services Content Moderator](https://docs.microsoft.com/python/api/overview/azure/cognitive-services) on docs.microsoft.com. + + +# 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. + + + + diff --git a/docs-ref-services/legacy/cognitiveservices-vision-customvision-readme.md b/docs-ref-services/legacy/cognitiveservices-vision-customvision-readme.md new file mode 100644 index 00000000..59950ca1 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-vision-customvision-readme.md @@ -0,0 +1,33 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-vision-customvision, cognitiveservices +ms.date: 03/31/2022 +ms.topic: reference +ms.devlang: python +ms.service: cognitive-services +ms.subservice: custom-vision +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure Custom Vision Client Library. +This package has been tested with Python 2.7, 3.6+. +For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all). + + +# Usage + + + + +For code examples, see [Custom Vision](https://docs.microsoft.com/python/api/overview/azure/cognitive-services) on docs.microsoft.com. + + +# 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. + + + + diff --git a/docs-ref-services/legacy/cognitiveservices-vision-face-readme.md b/docs-ref-services/legacy/cognitiveservices-vision-face-readme.md new file mode 100644 index 00000000..2da4952c --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices-vision-face-readme.md @@ -0,0 +1,12 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-cognitiveservices-vision-face, cognitiveservices +ms.date: 11/01/2024 +ms.topic: reference +ms.devlang: python +ms.service: cognitiveservices +--- +# Microsoft Azure SDK for Python + +This package has been deprecated and will no longer be maintained after 11-01-2024. This package will only receive security fixes until 11-01-2024. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-ai-vision-face](https://pypi.org/project/azure-ai-vision-face/). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-custom-image-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-custom-image-search-readme.md new file mode 100644 index 00000000..db0450cc --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-custom-image-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Custom Image Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Custom Image Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-custom-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-custom-search-readme.md new file mode 100644 index 00000000..997eb455 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-custom-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Custom Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Custom Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-entity-search-api-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-entity-search-api-readme.md new file mode 100644 index 00000000..9d093f39 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-entity-search-api-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Entity Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Entity Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-image-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-image-search-readme.md new file mode 100644 index 00000000..a13f8f9c --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-image-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Image Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Image Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-news-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-news-search-readme.md new file mode 100644 index 00000000..c8322c7d --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-news-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing News Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing News Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-video-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-video-search-readme.md new file mode 100644 index 00000000..f9f312e8 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-video-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Video Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Video Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-visual-search-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-visual-search-readme.md new file mode 100644 index 00000000..e9c8e4d3 --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-visual-search-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Visual Search +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Visual Search + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/cognitiveservices/bing-web-search-api-readme.md b/docs-ref-services/legacy/cognitiveservices/bing-web-search-api-readme.md new file mode 100644 index 00000000..517d3cde --- /dev/null +++ b/docs-ref-services/legacy/cognitiveservices/bing-web-search-api-readme.md @@ -0,0 +1,14 @@ +--- +title: Bing Web Search API +ms.date: 10/26/2020 +ms.topic: reference +ms.devlang: python +ms.service: bing-search-services +--- +# Bing Web Search API + +> [!WARNING] +> Bing Search APIs are moving from Cognitive Services to Bing Search Services. Starting **October 30, 2020**, any new instances of Bing Search need to be provisioned following the process documented [here](https://aka.ms/cogsvcs/bingmove). +> Bing Search APIs provisioned using Cognitive Services will be supported for the next three years or until the end of your Enterprise Agreement, whichever happens first. +> For migration instructions, see [Bing Search Services](https://aka.ms/cogsvcs/bingmigration). + diff --git a/docs-ref-services/legacy/commerce.md b/docs-ref-services/legacy/commerce.md new file mode 100644 index 00000000..7d21867b --- /dev/null +++ b/docs-ref-services/legacy/commerce.md @@ -0,0 +1,69 @@ +--- +title: Azure Commerce libraries for python +description: Reference for Azure Commerce libraries for python +keywords: Azure, python, SDK, API, Commerce +ms.date: 02/21/2018 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +manager: routlaw +--- +# Azure Commerce libraries for python + +## [Management API](/python/api/overview/azure/commerce/management) + +```bash +pip install azure-mgmt-commerce +``` +## Create the commerce client + +The following code creates an instance of the management client. + +You will need to provide your ``subscription_id`` which can be retrieved from [your subscription list](https://manage.windowsazure.com/#Workspaces/AdminTasks/SubscriptionMapping). + +See [Resource Management Authentication](/python/azure/python-sdk-azure-authenticate) for details on handling Azure Active Directory authentication with the Python SDK, and creating a ``Credentials`` instance. + +```python +from azure.mgmt.commerce import UsageManagementClient +from azure.common.credentials import UserPassCredentials + +# Replace this with your subscription id +subscription_id = '33333333-3333-3333-3333-333333333333' + +# See above for details on creating different types of AAD credentials +credentials = UserPassCredentials( + 'user@domain.com', # Your user + 'my_password', # Your password +) + +commerce_client = UsageManagementClient( + credentials, + subscription_id +) +``` + +## Get rate card + +```python +# OfferDurableID: https://azure.microsoft.com/en-us/support/legal/offer-details/ +rate = commerce_client.rate_card.get( + "OfferDurableId eq 'MS-AZR-0062P' and Currency eq 'USD' and Locale eq 'en-US' and RegionInfo eq 'US'" +) +``` + +## Get Usage + +```python +from datetime import date, timedelta + +# Takes onky dates in full ISO8601 with 'T00:00:00Z' +# Return an iterator like object: https://docs.python.org/3/library/stdtypes.html#iterator-types +usage_iterator = commerce_client.usage_aggregates.list( + str(date.today() - timedelta(days=1))+'T00:00:00Z', + str(date.today())+'T00:00:00Z' +) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/commerce/management) + diff --git a/docs-ref-services/legacy/common-readme.md b/docs-ref-services/legacy/common-readme.md new file mode 100644 index 00000000..660053b3 --- /dev/null +++ b/docs-ref-services/legacy/common-readme.md @@ -0,0 +1,20 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-common, core +ms.date: 11/11/2020 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +--- +# Microsoft Azure SDK for Python + +This is the Microsoft Azure common code. + +This package provides shared code by the Azure packages. + +If you are looking to install the Azure client libraries, refer to the main Github repository: +https://github.com/Azure/azure-sdk-for-python + + + + diff --git a/docs-ref-services/legacy/communication-index.md b/docs-ref-services/legacy/communication-index.md new file mode 100644 index 00000000..9c9dc0f6 --- /dev/null +++ b/docs-ref-services/legacy/communication-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Communication Network Traversal](communication-networktraversal-readme.md)|[azure-communication-networktraversal](https://pypi.org/project/azure-communication-networktraversal)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-networktraversal)| diff --git a/docs-ref-services/legacy/communication-networktraversal-readme.md b/docs-ref-services/legacy/communication-networktraversal-readme.md new file mode 100644 index 00000000..d7a81519 --- /dev/null +++ b/docs-ref-services/legacy/communication-networktraversal-readme.md @@ -0,0 +1,140 @@ +--- +title: Azure Communication Network Traversal Package client library for Python +keywords: Azure, python, SDK, API, azure-communication-networktraversal, communication +ms.date: 04/16/2024 +ms.topic: reference +ms.devlang: python +ms.service: communication +--- +# Azure Communication Network Traversal Package client library for Python - version 1.1.0b2 + + +**Please note, this package has been deprecated and will no longer be maintained after 03/31/2024.** + +Azure Communication Network Traversal is managing TURN credentials for Azure Communication Services. + +It will provide TURN credentials to a user. + +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-networktraversal_1.1.0b2/sdk/communication) | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-networktraversal_1.1.0b2/sdk/communication) + +## _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 +Please note, this package has been deprecated and will no longer be maintained after 03/31/2024. + +# Key concepts + +## Examples + +### Initializing Relay Client + +The following section provides code snippets covering some of the most common Azure Communication Network Traversal tasks, including: + +- [Getting the relay configuration](#getting-the-relay-configuration) + +```python +# You can find your endpoint and access token from your resource in the Azure Portal +import os +from azure.communication.networktraversal import CommunicationRelayClient +from azure.identity import DefaultAzureCredential +from azure.communication.identity import CommunicationIdentityClient + +connection_str = "endpoint=ENDPOINT;accessKey=KEY" +endpoint = "https://.communication.azure.com" + +# To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have +# AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables. +# We also need Identity client to get a User Identifier +identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential()) +relay_client = CommunicationRelayClient(endpoint, DefaultAzureCredential()) +``` + +#You can also authenticate using your connection string + +```python +identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string) +relay_client = CommunicationRelayClient.from_connection_string(self.connection_string) +``` + +### Getting the relay configuration providing a user + +```python +# We need a user from Identity +user = identity_client.create_user() +relay_configuration = relay_client.get_relay_configuration(user=user) + +for iceServer in config.ice_servers: + assert iceServer.username is not None + print('Username: ' + iceServer.username) + + assert iceServer.credential is not None + print('Credential: ' + iceServer.credential) + + assert iceServer.urls is not None + for url in iceServer.urls: + print('Url:' + url) +``` + +### Getting the relay configuration without providing a user + +```python +relay_configuration = relay_client.get_relay_configuration() + +for iceServer in config.ice_servers: + assert iceServer.username is not None + print('Username: ' + iceServer.username) + + assert iceServer.credential is not None + print('Credential: ' + iceServer.credential) + + assert iceServer.urls is not None + for url in iceServer.urls: + print('Url:' + url) +``` + +### Getting the relay configuration without providing a RouteType + +```python +# We need a user from Identity +user = identity_client.create_user() +relay_configuration = relay_client.get_relay_configuration(user=user, route_type=RouteType.NEAREST) + +for iceServer in config.ice_servers: + assert iceServer.username is not None + print('Username: ' + iceServer.username) + + assert iceServer.credential is not None + print('Credential: ' + iceServer.credential) + + assert iceServer.urls is not None + for url in iceServer.urls: + print('Url:' + url) +``` + +# Troubleshooting + +The Azure Communication Relay client will raise exceptions defined in [Azure Core][azure_core]. + +# Next steps + +## More sample code + +## 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 + +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the +PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + +[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-networktraversal_1.1.0b2/sdk/core/azure-core/README.md diff --git a/docs-ref-services/legacy/communication.md b/docs-ref-services/legacy/communication.md new file mode 100644 index 00000000..13306aba --- /dev/null +++ b/docs-ref-services/legacy/communication.md @@ -0,0 +1,11 @@ +--- +title: Azure Communication SDK for Python +description: Reference for Azure Communication SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: communication +--- +# Azure Communication SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](communication-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/compute.md b/docs-ref-services/legacy/compute.md new file mode 100644 index 00000000..37d1422a --- /dev/null +++ b/docs-ref-services/legacy/compute.md @@ -0,0 +1,86 @@ +--- +title: Azure Virtual Machine libraries for Python +description: +keywords: Azure, Python, SDK, API, Compute , Virtual Machines +ms.date: 06/09/2017 +ms.topic: reference +ms.devlang: python +ms.service: big-compute +manager: douge +--- +# Azure virtual machine libraries + +## Overview + +On-demand, scalable computing resources running Linux or Windows. + +To get started with Azure Virtual Machines, see [Create a Linux virtual machine with the Azure portal](/azure/virtual-machines/linux/quick-create-portal). + +## Management API + +Create, configure, manage and scale Windows and Linux virtual machines in Azure from your code with the management API. + +Install the library via pip. + +```bash +pip install azure-mgmt-compute +``` + +### Example + +Create a new Linux virtual machine in an existing Azure resource group with Managed Service Identity(MSI) authentication. + +```python +VM_PARAMETERS={ + 'location': 'LOCATION', + 'os_profile': { + 'computer_name': 'VM_NAME', + 'admin_username': 'USERNAME', + 'admin_password': 'PASSWORD' + }, + 'hardware_profile': { + 'vm_size': 'Standard_DS1_v2' + }, + 'storage_profile': { + 'image_reference': { + 'publisher': 'Canonical', + 'offer': 'UbuntuServer', + 'sku': '16.04.0-LTS', + 'version': 'latest' + }, + }, + 'network_profile': { + 'network_interfaces': [{ + 'id': 'NIC_ID', + }] + }, + } + +def create_vm() + compute_client.virtual_machines.create_or_update( + 'RESOURCE_GROUP_NAME', 'VM_NAME', VM_PARAMETERS) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/virtualmachines/management) + +## Samples + +* [Manage virtual machines][1] +* [Authenticate with Managed Service Identity][2] +* [Create a virtual machine with Managed Service Identity Extension][3] +* [Manage a load balancer][4] +* [Create and configure managed disks][5] +* [List images][6] +* [Monitor virtual machines][7] + +View the [complete list](https://azure.microsoft.com/resources/samples/?platform=python&term=virtual-machines) of virtual machine samples. + +[1]: https://azure.microsoft.com/resources/samples/virtual-machines-python-manage/ +[2]: https://github.com/Azure-Samples/resource-manager-python-manage-resources-with-msi +[3]: https://github.com/Azure-Samples/compute-python-msi-vm +[4]: https://azure.microsoft.com/resources/samples/network-python-manage-loadbalancer +[5]: /azure/python/python-sdk-azure-samples-managed-disks +[6]: /azure/python/python-sdk-azure-samples-list-images +[7]: /azure/python/python-sdk-azure-samples-monitor-vms + diff --git a/docs-ref-services/legacy/consumption.md b/docs-ref-services/legacy/consumption.md new file mode 100644 index 00000000..36b2cff8 --- /dev/null +++ b/docs-ref-services/legacy/consumption.md @@ -0,0 +1,23 @@ +--- +title: Azure Consumption libraries for python +description: Reference for Azure Consumption libraries for python +keywords: Azure, python, SDK, API, Consumption +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +manager: douge +--- +# Azure Consumption libraries for python + +## Install the libraries + + +### Management + +```bash +pip install azure-mgmt-consumption +``` +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/consumption/management) + diff --git a/docs-ref-services/legacy/container-instance.md b/docs-ref-services/legacy/container-instance.md new file mode 100644 index 00000000..f7623116 --- /dev/null +++ b/docs-ref-services/legacy/container-instance.md @@ -0,0 +1,144 @@ +--- +title: Azure Container Instances libraries for Python +description: Reference for Azure Container Instances libraries for Python +keywords: Azure, python, SDK, API, ACI, container, instances +ms.date: 04/15/2019 +ms.topic: reference +ms.devlang: python +ms.service: container-instances +manager: jeconnoc +--- +# Azure Container Instances libraries for Python + +Use the Microsoft Azure Container Instances libraries for Python to create and manage Azure container instances. Learn more by reading the [Azure Container Instances overview](/azure/container-instances/container-instances-overview). + +## Management APIs + +Use the management library to create and manage Azure container instances in Azure. + +Install the management package via pip: + +```bash +pip install azure-mgmt-containerinstance +``` + +## Example source + +If you'd like to see the following code examples in context, you can find them in the following GitHub repository: + +[Azure-Samples/aci-docs-sample-python](https://github.com/Azure-Samples/aci-docs-sample-python) + +## Authentication + +One of the easiest ways to authenticate SDK clients (like the Azure Container Instances and Resource Manager clients in the following example) is with [file-based authentication](/python/azure/python-sdk-azure-authenticate#mgmt-auth-file). File-based authentication queries the `AZURE_AUTH_LOCATION` environment variable for the path to a credentials file. To use file-based authentication: + +1. Create a credentials file with the [Azure CLI](/cli/azure) or [Cloud Shell](https://shell.azure.com/): + + ```azurecli + az ad sp create-for-rbac --role Contributor --sdk-auth > my.azureauth + ``` + + If you use the [Cloud Shell](https://shell.azure.com/) to generate the credentials file, copy its contents into a local file that your Python application can access. + +2. Set the `AZURE_AUTH_LOCATION` environment variable to the full path of the generated credentials file. For example (in Bash): + + ```bash + export AZURE_AUTH_LOCATION=/home/yourusername/my.azureauth + ``` + +Once you've created the credentials file and populated the `AZURE_AUTH_LOCATION` environment variable, use the `get_client_from_auth_file` method of the [client_factory][client_factory] module to initialize the [ResourceManagementClient][ResourceManagementClient] and [ContainerInstanceManagementClient][ContainerInstanceManagementClient] objects. + + +[!code-python[authenticate](~/aci-docs-sample-python/src/aci_docs_sample.py#L45-L58 "Authenticate ACI and Resource Manager clients")] + +For more details about the available authentication methods in the Python management libraries for Azure, see [Authenticate with the Azure Management Libraries for Python](/python/azure/python-sdk-azure-authenticate). + +## Create container group - single container + +This example creates a container group with a single container + + +[!code-python[create_container_group](~/aci-docs-sample-python/src/aci_docs_sample.py#L94-L141 "Create single-container group")] + +## Create container group - multiple containers + +This example creates a container group with two containers: an application container and a sidecar container. + + +[!code-python[create_container_group_multi](~/aci-docs-sample-python/src/aci_docs_sample.py#L144-L197 "Create multi-container group")] + +## Create task-based container group + +This example creates a container group with a single task-based container. This example demonstrates several features: + +* [Command line override](/azure/container-instances/container-instances-start-command) - A custom command line, different from that which is specified in the container's Dockerfile `CMD` line, is specified. Command line override allows you to specify a custom command line to execute at container startup, overriding the default command line baked-in to the container. Regarding executing multiple commands at container startup, the following applies: + + If you want to run a **single command** with several command-line arguments, for example `echo FOO BAR`, you must supply them as a string list to the `command` property of the [Container][Container]. For example: + + `command = ['echo', 'FOO', 'BAR']` + + If, however, you want to run **multiple commands** with (potentially) multiple arguments, you must execute a shell and pass the chained commands as an argument. For example, this executes both an `echo` and a `tail` command: + + `command = ['/bin/sh', '-c', 'echo FOO BAR && tail -f /dev/null']` +* [Environment variables](/azure/container-instances/container-instances-environment-variables) - Two environment variables are specified for the container in the container group. Use environment variables to modify script or application behavior at runtime, or otherwise pass dynamic information to an application running in the container. +* [Restart policy](/azure/container-instances/container-instances-restart-policy) - The container is configured with a restart policy of "Never," useful for task-based containers that are executed as part of a batch job. +* Operation polling with [AzureOperationPoller][AzureOperationPoller] - After the create method is invoked, the operation is polled to determine when it has completed and the container group's logs can be obtained. + + +[!code-python[create_container_group_task](~/aci-docs-sample-python/src/aci_docs_sample.py#L200-L276 "Run a task-based container")] + +## List container groups + +This example lists the container groups in a resource group and then prints a few of their properties. + +When you list container groups,the [instance_view][instance_view] of each returned group is `None`. To get the details of the containers within a container group, you must then [get][containergroupoperations_get] the container group, which returns the group with its `instance_view` property populated. See the next section, [Get an existing container group](#get-an-existing-container-group), for an example of iterating over a container group's containers in its `instance_view`. + + +[!code-python[list_container_groups](~/aci-docs-sample-python/src/aci_docs_sample.py#L279-L293 "List container groups")] + +## Get an existing container group + +This example gets a specific container group from a resource group, and then prints a few of its properties (including its containers) and their values. + +The [get operation][containergroupoperations_get] returns a container group with its [instance_view][instance_view] populated, which allows you to iterate over each container in the group. Only the `get` operation populates the `instance_vew` property of the container group--listing the container groups in a subscription or resource group doesn't populate the instance view due to the potentially expensive nature of the operation (for example, when listing hundreds of container groups, each potentially containing multiple containers). As mentioned previously in the [List container groups](#list-container-groups) section, after a `list`, you must subsequently `get` a specific container group to obtain its container instance details. + + +[!code-python[get_container_group](~/aci-docs-sample-python/src/aci_docs_sample.py#L296-L325 "Get container group")] + +## Delete a container group + +This example deletes several container groups from a resource group, as well as the resource group. + + +[!code-python[delete_container_group](~/aci-docs-sample-python/src/aci_docs_sample.py#L83-L92 "Delete container groups and resource group")] + +## Next steps + +* The source code for the preceding examples can be found on GitHub: + + [Azure-Samples/aci-docs-sample-python][aci-docs-sample-python] + +* More Azure Container Instances code samples: + + [Azure Code Samples][samples-aci] + +* Explore more [sample Python code][samples-python] you can use in your apps. + +> [!div class="nextstepaction"] +> [Explore the management APIs](/python/api/overview/azure/containerinstance/management) + + +[aci-docs-sample-python]: https://github.com/Azure-Samples/aci-docs-sample-python +[samples-aci]: https://azure.microsoft.com/resources/samples/?sort=0&term=ACI +[samples-python]: https://azure.microsoft.com/resources/samples/?platform=python + + +[AzureOperationPoller]: /python/api/msrestazure.azure_operation.AzureOperationPoller +[client_factory]: /python/api/azure.common.client_factory +[Container]: /python/api/azure.mgmt.containerinstance.models.container +[ContainerGroupInstanceView]: /python/api/azure.mgmt.containerinstance.models.containergrouppropertiesinstanceview +[containergroupoperations_get]: /python/api/azure.mgmt.containerinstance.operations.containergroupsoperations#get-resource-group-name--container-group-name--custom-headers-none--raw-false----operation-config- +[ContainerInstanceManagementClient]: /python/api/azure.mgmt.containerinstance.containerinstancemanagementclient +[instance_view]: /python/api/azure.mgmt.containerinstance.models.containergroup#variables +[ResourceManagementClient]: /python/api/azure.mgmt.resource.resources.resourcemanagementclient + diff --git a/docs-ref-services/legacy/container-registry.md b/docs-ref-services/legacy/container-registry.md new file mode 100644 index 00000000..87a1fa6a --- /dev/null +++ b/docs-ref-services/legacy/container-registry.md @@ -0,0 +1,23 @@ +--- +title: Azure Container Registry libraries for python +description: Reference for Azure Container Registry libraries for python +keywords: Azure, python, SDK, API, Container Registry +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: container-registry +manager: douge +--- +# Azure Container Registry libraries for python + +## Install the libraries + + +### Management + +```bash +pip install azure-mgmt-containerregistry +``` +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/containerregistry/management) + diff --git a/docs-ref-services/legacy/content-delivery-network.md b/docs-ref-services/legacy/content-delivery-network.md new file mode 100644 index 00000000..e73e9d44 --- /dev/null +++ b/docs-ref-services/legacy/content-delivery-network.md @@ -0,0 +1,63 @@ +--- +title: Azure CDN libraries for python +description: Reference for Azure CDN libraries for python +keywords: Azure, python, SDK, API, CDN +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: azure-cdn +manager: douge +--- +# Azure CDN libraries for python + +## Overview + +[Azure Content Delivery Network (CDN)](https://docs.microsoft.com/azure/cdn/cdn-overview) allows you to provide web content caches to ensure high-bandwidth availability across the globe. + +To get started with Azure CDN, see [Getting started with Azure CDN](https://docs.microsoft.com/azure/cdn/cdn-create-new-endpoint). + +## Management APIs + +Create, query, and manage Azure CDNs with the management API. + +Install the management package via pip. + +```bash +pip install azure-mgmt-cdn +``` + +### Example + +Creating a CDN profile with a single defined endpoint: + +```python +from azure.mgmt.cdn import CdnManagementClient + +cdn_client = CdnManagementClient(credentials, 'your-subscription-id') +profile_poller = cdn_client.profiles.create('my-resource-group', + 'cdn-name', + { + "location": "some_region", + "sku": { + "name": "sku_tier" + } + }) +profile = profile_poller.result() + +endpoint_poller = cdn_client.endpoints.create('my-resource-group', + 'cdn-name', + 'unique-endpoint-name', + { + "location": "any_region", + "origins": [ + { + "name": "origin_name", + "host_name": "url" + }] + }) +endpoint = endpoint_poller.result() +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/cdn/management) + diff --git a/docs-ref-services/legacy/core-readme.md b/docs-ref-services/legacy/core-readme.md new file mode 100644 index 00000000..78595714 --- /dev/null +++ b/docs-ref-services/legacy/core-readme.md @@ -0,0 +1,157 @@ +--- +title: Azure Core shared client library for Python +keywords: Azure, python, SDK, API, azure-core, core +ms.date: 11/09/2020 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +--- +# Azure Core shared client library for Python - version 1.9.0 + + +Azure core provides shared exceptions and modules for Python SDK client libraries. +These libraries follow the [Azure SDK Design Guidelines for Python](https://azure.github.io/azure-sdk/python_introduction.html) . + +If you are a client library developer, please reference [client library developer reference](https://github.com/Azure/azure-sdk-for-python/blob/azure-core_1.9.0/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md) for more information. + +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/azure-core_1.9.0/sdk/core/azure-core/) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-core_1.9.0/sdk/core/azure-core/) + +## Getting started + +Typically, you will not need to install azure core; +it will be installed when you install one of the client libraries using it. +In case you want to install it explicitly (to implement your own client library, for example), +you can find it [here](https://pypi.org/project/azure-core/). + +## Key concepts + +### Azure Core Library Exceptions + +#### AzureError +AzureError is the base exception for all errors. +```python +class AzureError(Exception): + def __init__(self, message, *args, **kwargs): + self.inner_exception = kwargs.get('error') + self.exc_type, self.exc_value, self.exc_traceback = sys.exc_info() + self.exc_type = self.exc_type.__name__ if self.exc_type else type(self.inner_exception) + self.exc_msg = "{}, {}: {}".format(message, self.exc_type, self.exc_value) # type: ignore + self.message = str(message) + super(AzureError, self).__init__(self.message, *args) +``` + +*message* is any message (str) to be associated with the exception. + +*args* are any additional args to be included with exception. + +*kwargs* are keyword arguments to include with the exception. Use the keyword *error* to pass in an internal exception. + +**The following exceptions inherit from AzureError:** + +#### ServiceRequestError +An error occurred while attempt to make a request to the service. No request was sent. + +#### ServiceResponseError +The request was sent, but the client failed to understand the response. +The connection may have timed out. These errors can be retried for idempotent or safe operations. + +#### HttpResponseError +A request was made, and a non-success status code was received from the service. +```python +class HttpResponseError(AzureError): + def __init__(self, message=None, response=None, **kwargs): + self.reason = None + self.response = response + if response: + self.reason = response.reason + message = "Operation returned an invalid status code '{}'".format(self.reason) + try: + try: + if self.error.error.code or self.error.error.message: + message = "({}) {}".format( + self.error.error.code, + self.error.error.message) + except AttributeError: + if self.error.message: #pylint: disable=no-member + message = self.error.message #pylint: disable=no-member + except AttributeError: + pass + super(HttpResponseError, self).__init__(message=message, **kwargs) +``` +*message* is the HTTP response error message (optional) + +*response* is the HTTP response (optional). + +*kwargs* are keyword arguments to include with the exception. + +**The following exceptions inherit from HttpResponseError:** + +#### DecodeError +An error raised during response deserialization. + +#### ResourceExistsError +An error response with status code 4xx. This will not be raised directly by the Azure core pipeline. + +#### ResourceNotFoundError +An error response, typically triggered by a 412 response (for update) or 404 (for get/post). + +#### ClientAuthenticationError +An error response with status code 4xx. This will not be raised directly by the Azure core pipeline. + +#### ResourceModifiedError +An error response with status code 4xx, typically 412 Conflict. This will not be raised directly by the Azure core pipeline. + +#### ResourceNotModifiedError +An error response with status code 304. This will not be raised directly by the Azure core pipeline. + +#### TooManyRedirectsError +An error raised when the maximum number of redirect attempts is reached. The maximum amount of redirects can be configured in the RedirectPolicy. +```python +class TooManyRedirectsError(HttpResponseError): + def __init__(self, history, *args, **kwargs): + self.history = history + message = "Reached maximum redirect attempts." + super(TooManyRedirectsError, self).__init__(message, *args, **kwargs) +``` + +*history* is used to document the requests/responses that resulted in redirected requests. + +*args* are any additional args to be included with exception. + +*kwargs* are keyword arguments to include with the exception. + +### Shared modules + +#### MatchConditions + +MatchConditions is an enum to describe match conditions. +```python +class MatchConditions(Enum): + Unconditionally = 1 + IfNotModified = 2 + IfModified = 3 + IfPresent = 4 + IfMissing = 5 +``` + +## Contributing +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit [https://cla.microsoft.com](https://cla.microsoft.com). + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information, see the +[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any +additional questions or comments. + + +[package]: https://pypi.org/project/azure-core/ + diff --git a/docs-ref-services/legacy/cosmos-db-index.md b/docs-ref-services/legacy/cosmos-db-index.md new file mode 100644 index 00000000..b2a2b379 --- /dev/null +++ b/docs-ref-services/legacy/cosmos-db-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Cosmos DB](cosmos-readme.md)|[azure-cosmos](https://pypi.org/project/azure-cosmos)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cosmos/azure-cosmos)| diff --git a/docs-ref-services/legacy/cosmos-db.md b/docs-ref-services/legacy/cosmos-db.md new file mode 100644 index 00000000..e907de94 --- /dev/null +++ b/docs-ref-services/legacy/cosmos-db.md @@ -0,0 +1,59 @@ +--- +title: Azure Cosmos DB SDK for Python +description: Reference for Azure Cosmos DB SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: cosmosdb +keywords: Azure, Python, SDK, API, SQL, database, PostGres,Cosmos DB, NoSQL +manager: douge +--- +# Azure Cosmos DB libraries for Python + +## Overview + +Use Azure Cosmos DB in your Python applications to store and query JSON documents in a NoSQL data store. + +Learn more about [Azure Cosmos DB](https://docs.microsoft.com/azure/cosmos-db/introduction). + +## Client library - For Applications Development and Data Exploration + ```bash +pip install azure-cosmos + ``` + +## Management library - For Account Level Management Operations +```bash +pip install azure-mgmt-cosmosdb +``` + +### Key Examples + +* [Common Tasks](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/examples.py): + * Create Database + * Create Container + * CRUD operations on Items in Container + * Query a Container for Items + * Create a Database user + +* [Database Management](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/database_management.py): + * Basic CRUD operations on a Database resource + * Query for Database + * List all Database resources on an account + +* [Container Management](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cosmos/azure-cosmos/samples/container_management.py): + * Basic CRUD operations on a Container resource + * Query for Container + * Manage Container Provisioned Throughput + * List all Container resources in a Database + +## Develop Python Applications + +* [Develop a Python app to access and manage data stored in Azure Cosmos DB SQL API account](https://github.com/Azure-Samples/azure-cosmos-db-python-getting-started.git) + +* [Develop a Python app to access and manage data stored in Azure Cosmos DB MongoDB API account](https://github.com/Azure-Samples/CosmosDB-Flask-Mongo-Sample.git) + +* [Develop a Python app to access and manage data stored in Azure Cosmos DB Gremlin API account](https://github.com/Azure-Samples/azure-cosmos-db-graph-python-getting-started.git) + +* [Develop a Python app to access and manage data stored in Azure Cosmos DB Cassandra API account](https://github.com/Azure-Samples/azure-cosmos-db-cassandra-python-getting-started.git) + +* [Develop a Python app to access and manage data stored in Azure Cosmos DB Table API account](https://github.com/Azure-Samples/storage-python-getting-started.git) \ No newline at end of file diff --git a/docs-ref-services/legacy/cosmos-readme.md b/docs-ref-services/legacy/cosmos-readme.md new file mode 100644 index 00000000..302540b3 --- /dev/null +++ b/docs-ref-services/legacy/cosmos-readme.md @@ -0,0 +1,449 @@ +--- +title: Azure Cosmos DB SQL API client library for Python +keywords: Azure, python, SDK, API, azure-cosmos, cosmos +ms.date: 10/09/2020 +ms.topic: reference +ms.devlang: python +ms.service: cosmos-db +--- +# Azure Cosmos DB SQL API client library for Python - version 4.2.0 + + +Azure Cosmos DB is a globally distributed, multi-model database service that supports document, key-value, wide-column, and graph databases. + +Use the Azure Cosmos DB SQL API SDK for Python to manage databases and the JSON documents they contain in this NoSQL database service. + +* Create Cosmos DB **databases** and modify their settings +* Create and modify **containers** to store collections of JSON documents +* Create, read, update, and delete the **items** (JSON documents) in your containers +* Query the documents in your database using **SQL-like syntax** + +[SDK source code][source_code] | [Package (PyPI)][cosmos_pypi] | [API reference documentation][ref_cosmos_sdk] | [Product documentation][cosmos_docs] | [Samples][cosmos_samples] + +> This SDK is used for the [SQL API](https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started). For all other APIs, please check the [Azure Cosmos DB documentation](https://docs.microsoft.com/azure/cosmos-db/introduction) to evaluate the best SDK for your project. + +## Getting started + +### Prerequisites + +* Azure subscription - [Create a free account][azure_sub] +* Azure [Cosmos DB account][cosmos_account] - SQL API +* [Python 2.7 or 3.5.3+][python] + +If you need a Cosmos DB SQL API account, you can create one with this [Azure CLI][azure_cli] command: + +```Bash +az cosmosdb create --resource-group --name +``` + +### Install the package + +```bash +pip install azure-cosmos +``` + +#### Configure a virtual environment (optional) + +Although not required, you can keep your base system and Azure SDK environments isolated from one another if you use a virtual environment. Execute the following commands to configure and then enter a virtual environment with [venv][venv]: + +```Bash +python3 -m venv azure-cosmosdb-sdk-environment +source azure-cosmosdb-sdk-environment/bin/activate +``` + +### Authenticate the client + +Interaction with Cosmos DB starts with an instance of the [CosmosClient][ref_cosmosclient] class. You need an **account**, its **URI**, and one of its **account keys** to instantiate the client object. + +Use the Azure CLI snippet below to populate two environment variables with the database account URI and its primary master key (you can also find these values in the Azure portal). The snippet is formatted for the Bash shell. + +```Bash +RES_GROUP= +ACCT_NAME= + +export ACCOUNT_URI=$(az cosmosdb show --resource-group $RES_GROUP --name $ACCT_NAME --query documentEndpoint --output tsv) +export ACCOUNT_KEY=$(az cosmosdb list-keys --resource-group $RES_GROUP --name $ACCT_NAME --query primaryMasterKey --output tsv) +``` + +### Create the client + +Once you've populated the `ACCOUNT_URI` and `ACCOUNT_KEY` environment variables, you can create the [CosmosClient][ref_cosmosclient]. + +```Python +from azure.cosmos import CosmosClient + +import os +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +``` + +## Key concepts + +Once you've initialized a [CosmosClient][ref_cosmosclient], you can interact with the primary resource types in Cosmos DB: + +* [Database][ref_database]: A Cosmos DB account can contain multiple databases. When you create a database, you specify the API you'd like to use when interacting with its documents: SQL, MongoDB, Gremlin, Cassandra, or Azure Table. Use the [DatabaseProxy][ref_database] object to manage its containers. + +* [Container][ref_container]: A container is a collection of JSON documents. You create (insert), read, update, and delete items in a container by using methods on the [ContainerProxy][ref_container] object. + +* Item: An Item is the dictionary-like representation of a JSON document stored in a container. Each Item you add to a container must include an `id` key with a value that uniquely identifies the item within the container. + +For more information about these resources, see [Working with Azure Cosmos databases, containers and items][cosmos_resources]. + +## Limitations + +As of August 2020 the features below are not yet supported. + +* Bulk/Batch processing +* Group By queries +* Direct TCP Mode access +* Language Native async i/o + +## Limitations Workaround + +If you want to use Python SDK to perform bulk inserts to Cosmos DB, the best alternative is to use [stored procedures](https://docs.microsoft.com/azure/cosmos-db/how-to-write-stored-procedures-triggers-udfs) to write multiple items with the same partition key. + +## Examples + +The following sections provide several code snippets covering some of the most common Cosmos DB tasks, including: + +* [Create a database](#create-a-database "Create a database") +* [Create a container](#create-a-container "Create a container") +* [Create an analytical store enabled container](#create-an-analytical-store-enabled-container "Create a container") +* [Get an existing container](#get-an-existing-container "Get an existing container") +* [Insert data](#insert-data "Insert data") +* [Delete data](#delete-data "Delete data") +* [Query the database](#query-the-database "Query the database") +* [Get database properties](#get-database-properties "Get database properties") +* [Modify container properties](#modify-container-properties "Modify container properties") + +### Create a database + +After authenticating your [CosmosClient][ref_cosmosclient], you can work with any resource in the account. The code snippet below creates a SQL API database, which is the default when no API is specified when [create_database][ref_cosmosclient_create_database] is invoked. + +```Python +from azure.cosmos import CosmosClient, exceptions +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +try: + database = client.create_database(database_name) +except exceptions.CosmosResourceExistsError: + database = client.get_database_client(database_name) +``` + +### Create a container + +This example creates a container with default settings. If a container with the same name already exists in the database (generating a `409 Conflict` error), the existing container is obtained instead. + +```Python +from azure.cosmos import CosmosClient, PartitionKey, exceptions +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' + +try: + container = database.create_container(id=container_name, partition_key=PartitionKey(path="/productName")) +except exceptions.CosmosResourceExistsError: + container = database.get_container_client(container_name) +except exceptions.CosmosHttpResponseError: + raise +``` + +### Create an analytical store enabled container + +This example creates a container with [Analytical Store](https://docs.microsoft.com/azure/cosmos-db/analytical-store-introduction) enabled, for reporting, BI, AI, and Advanced Analytics with [Azure Synapse Link](https://docs.microsoft.com/azure/cosmos-db/synapse-link). + +The options for analytical_storage_ttl are: + ++ 0 or Null or not informed: Not enabled. ++ -1: The data will be stored infinitely. ++ Any other number: the actual ttl, in seconds. + + +```Python +container_name = 'products' +try: + container = database.create_container(id=container_name, partition_key=PartitionKey(path="/productName"),analytical_storage_ttl=-1) +except exceptions.CosmosResourceExistsError: + container = database.get_container_client(container_name) +except exceptions.CosmosHttpResponseError: + raise +``` + +The preceding snippet also handles the [CosmosHttpResponseError][ref_httpfailure] exception if the container creation failed. For more information on error handling and troubleshooting, see the [Troubleshooting](#troubleshooting "Troubleshooting") section. + +The preceding snippet also handles the [CosmosHttpResponseError][ref_httpfailure] exception if the container creation failed. For more information on error handling and troubleshooting, see the [Troubleshooting](#troubleshooting "Troubleshooting") section. + +### Get an existing container + +Retrieve an existing container from the database: + +```Python +from azure.cosmos import CosmosClient +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' +container = database.get_container_client(container_name) +``` + +### Insert data + +To insert items into a container, pass a dictionary containing your data to [ContainerProxy.upsert_item][ref_container_upsert_item]. Each item you add to a container must include an `id` key with a value that uniquely identifies the item within the container. + +This example inserts several items into the container, each with a unique `id`: + +```Python +from azure.cosmos import CosmosClient +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' +container = database.get_container_client(container_name) + +for i in range(1, 10): + container.upsert_item({ + 'id': 'item{0}'.format(i), + 'productName': 'Widget', + 'productModel': 'Model {0}'.format(i) + } + ) +``` + +### Delete data + +To delete items from a container, use [ContainerProxy.delete_item][ref_container_delete_item]. The SQL API in Cosmos DB does not support the SQL `DELETE` statement. + +```Python +from azure.cosmos import CosmosClient +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' +container = database.get_container_client(container_name) + +for item in container.query_items( + query='SELECT * FROM products p WHERE p.productModel = "Model 2"', + enable_cross_partition_query=True): + container.delete_item(item, partition_key='Widget') +``` + +> NOTE: If you are using partitioned collection, the value of the `partitionKey` in the example code above, should be set to the value of the partition key for this particular item, not the name of the partition key column in your collection. This holds true for both point reads and deletes. + +### Query the database + +A Cosmos DB SQL API database supports querying the items in a container with [ContainerProxy.query_items][ref_container_query_items] using SQL-like syntax. + +This example queries a container for items with a specific `id`: + +```Python +from azure.cosmos import CosmosClient +import os + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' +container = database.get_container_client(container_name) + +# Enumerate the returned items +import json +for item in container.query_items( + query='SELECT * FROM mycontainer r WHERE r.id="item3"', + enable_cross_partition_query=True): + print(json.dumps(item, indent=True)) +``` + +> NOTE: Although you can specify any value for the container name in the `FROM` clause, we recommend you use the container name for consistency. + +Perform parameterized queries by passing a dictionary containing the parameters and their values to [ContainerProxy.query_items][ref_container_query_items]: + +```Python +discontinued_items = container.query_items( + query='SELECT * FROM products p WHERE p.productModel = @model', + parameters=[ + dict(name='@model', value='Model 7') + ], + enable_cross_partition_query=True +) +for item in discontinued_items: + print(json.dumps(item, indent=True)) +``` + +For more information on querying Cosmos DB databases using the SQL API, see [Query Azure Cosmos DB data with SQL queries][cosmos_sql_queries]. + +### Get database properties + +Get and display the properties of a database: + +```Python +from azure.cosmos import CosmosClient +import os +import json + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +properties = database.read() +print(json.dumps(properties)) +``` + +### Modify container properties + +Certain properties of an existing container can be modified. This example sets the default time to live (TTL) for items in the container to 10 seconds: + +```Python +from azure.cosmos import CosmosClient, PartitionKey +import os +import json + +url = os.environ['ACCOUNT_URI'] +key = os.environ['ACCOUNT_KEY'] +client = CosmosClient(url, credential=key) +database_name = 'testDatabase' +database = client.get_database_client(database_name) +container_name = 'products' +container = database.get_container_client(container_name) + +database.replace_container( + container, + partition_key=PartitionKey(path="/productName"), + default_ttl=10, +) +# Display the new TTL setting for the container +container_props = container.read() +print(json.dumps(container_props['defaultTtl'])) +``` + +For more information on TTL, see [Time to Live for Azure Cosmos DB data][cosmos_ttl]. + + +## Troubleshooting + +### General + +When you interact with Cosmos DB using the Python SDK, exceptions returned by the service correspond to the same HTTP status codes returned for REST API requests: + +[HTTP Status Codes for Azure Cosmos DB][cosmos_http_status_codes] + +For example, if you try to create a container using an ID (name) that's already in use in your Cosmos DB database, a `409` error is returned, indicating the conflict. In the following snippet, the error is handled gracefully by catching the exception and displaying additional information about the error. + +```Python +try: + database.create_container(id=container_name, partition_key=PartitionKey(path="/productName")) +except exceptions.CosmosResourceExistsError: + print("""Error creating container +HTTP status code 409: The ID (name) provided for the container is already in use. +The container name must be unique within the database.""") + +``` +### Logging + +This library uses the standard +[logging](https://docs.python.org/3.5/library/logging.html) library for logging. +Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO +level. + +Detailed DEBUG level logging, including request/response bodies and unredacted +headers, can be enabled on a client with the `logging_enable` argument: +```python +import sys +import logging +from azure.cosmos import CosmosClient + +# Create a logger for the 'azure' SDK +logger = logging.getLogger('azure') +logger.setLevel(logging.DEBUG) + +# Configure a console output +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +# This client will log detailed information about its HTTP sessions, at DEBUG level +client = CosmosClient(url, credential=key, logging_enable=True) +``` + +Similarly, `logging_enable` can enable detailed logging for a single operation, +even when it isn't enabled for the client: +```py +database = client.create_database(database_name, logging_enable=True) +``` + +## Next steps + +For more extensive documentation on the Cosmos DB service, see the [Azure Cosmos DB documentation][cosmos_docs] on docs.microsoft.com. + + +[azure_cli]: https://docs.microsoft.com/cli/azure +[azure_portal]: https://portal.azure.com +[azure_sub]: https://azure.microsoft.com/free/ +[cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview +[cosmos_account_create]: https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account +[cosmos_account]: https://docs.microsoft.com/azure/cosmos-db/account-overview +[cosmos_container]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-containers +[cosmos_database]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-databases +[cosmos_docs]: https://docs.microsoft.com/azure/cosmos-db/ +[cosmos_samples]: https://github.com/Azure/azure-sdk-for-python/tree/azure-cosmos_4.2.0/sdk/cosmos/azure-cosmos/samples +[cosmos_pypi]: https://pypi.org/project/azure-cosmos/ +[cosmos_http_status_codes]: https://docs.microsoft.com/rest/api/cosmos-db/http-status-codes-for-cosmosdb +[cosmos_item]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-items +[cosmos_request_units]: https://docs.microsoft.com/azure/cosmos-db/request-units +[cosmos_resources]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items +[cosmos_sql_queries]: https://docs.microsoft.com/azure/cosmos-db/how-to-sql-query +[cosmos_ttl]: https://docs.microsoft.com/azure/cosmos-db/time-to-live +[python]: https://www.python.org/downloads/ +[ref_container_delete_item]: https://aka.ms/azsdk-python-cosmos-ref-delete-item +[ref_container_query_items]: https://aka.ms/azsdk-python-cosmos-ref-query-items +[ref_container_upsert_item]: https://aka.ms/azsdk-python-cosmos-ref-upsert-item +[ref_container]: https://aka.ms/azsdk-python-cosmos-ref-container +[ref_cosmos_sdk]: https://aka.ms/azsdk-python-cosmos-ref +[ref_cosmosclient_create_database]: https://aka.ms/azsdk-python-cosmos-ref-create-database +[ref_cosmosclient]: https://aka.ms/azsdk-python-cosmos-ref-cosmos-client +[ref_database]: https://aka.ms/azsdk-python-cosmos-ref-database +[ref_httpfailure]: https://aka.ms/azsdk-python-cosmos-ref-http-failure +[sample_database_mgmt]: https://github.com/Azure/azure-sdk-for-python/tree/azure-cosmos_4.2.0/sdk/cosmos/azure-cosmos/samples/database_management.py +[sample_document_mgmt]: https://github.com/Azure/azure-sdk-for-python/tree/azure-cosmos_4.2.0/sdk/cosmos/azure-cosmos/samples/document_management.py +[sample_examples_misc]: https://github.com/Azure/azure-sdk-for-python/tree/azure-cosmos_4.2.0/sdk/cosmos/azure-cosmos/samples/examples.py +[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/azure-cosmos_4.2.0/sdk/cosmos/azure-cosmos +[venv]: https://docs.python.org/3/library/venv.html +[virtualenv]: https://virtualenv.pypa.io + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + diff --git a/docs-ref-services/legacy/cost-management-+-billing.md b/docs-ref-services/legacy/cost-management-+-billing.md new file mode 100644 index 00000000..5ac1ef8f --- /dev/null +++ b/docs-ref-services/legacy/cost-management-+-billing.md @@ -0,0 +1,21 @@ +--- +title: Azure Billing libraries for python +description: Reference for Azure Billing libraries for python +ms.date: 02/21/2024 +ms.topic: reference +ms.devlang: python +ms.service: cost-management-billing +--- +# Azure Billing libraries for python + +## Install the libraries + + +### Management + +```bash +pip install azure-mgmt-billing +``` +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/azure-mgmt-billing/) + diff --git a/docs-ref-services/legacy/data-factory.md b/docs-ref-services/legacy/data-factory.md new file mode 100644 index 00000000..4cec207d --- /dev/null +++ b/docs-ref-services/legacy/data-factory.md @@ -0,0 +1,57 @@ +--- +title: Azure Data Factory libraries for Python +description: Reference for Azure Data Factory libraries for Python +ms.date: 05/10/2018 +ms.topic: reference +ms.devlang: python +ms.service: data-factory +manager: angerobe +--- +# Azure Data Factory libraries for Python + +Compose data storage, movement, and processing services into automated data pipelines with [Azure Data Factory](/azure/data-factory/) + +[Learn more](/azure/data-factory/introduction) about Data Factory and get started with the [Create a data factory and pipeline using Python quickstart](/azure/data-factory/quickstart-create-data-factory-python). + +## Management module + +Create and manage Data Factory instances in your subscription with the management module. + +### Installation + +Install the package with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```bash +pip install azure-mgmt-datafactory +``` + +### Example + +Create a Data Factory in your subscription on the East US region. + +```python +from azure.common.credentials import ServicePrincipalCredentials +from azure.mgmt.resource import ResourceManagementClient +from azure.mgmt.datafactory import DataFactoryManagementClient +from azure.mgmt.datafactory.models import * +import time + +#Create a data factory +subscription_id = '' +credentials = ServicePrincipalCredentials(client_id='', secret='', tenant='') +adf_client = DataFactoryManagementClient(credentials, subscription_id) + +rg_params = {'location':'eastus'} +df_params = {'location':'eastus'} + +df_resource = Factory(location='eastus') +df = adf_client.factories.create_or_update(rg_name, df_name, df_resource) +print_item(df) +while df.provisioning_state != 'Succeeded': + df = adf_client.factories.get(rg_name, df_name) + time.sleep(1) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/datafactory/management) + diff --git a/docs-ref-services/legacy/data-lake-analytics.md b/docs-ref-services/legacy/data-lake-analytics.md new file mode 100644 index 00000000..38744027 --- /dev/null +++ b/docs-ref-services/legacy/data-lake-analytics.md @@ -0,0 +1,115 @@ +--- +title: Azure Data Lake Analytics libraries for python +description: Reference for Azure Data Lake Analytics libraries for python +keywords: Azure, python, SDK, API, Data Lake Analytics +ms.date: 08/04/2017 +ms.topic: reference +ms.devlang: python +ms.service: data-lake-analytics +manager: douge +--- +# Azure Data Lake Analytics libraries for python + +## Overview +Run big data analysis jobs that scale to massive data sets with [Azure Data Lake Analytics](/azure/data-lake-analytics/data-lake-analytics-overview). + +## Install the libraries + +## Management API +Use the management API to manage Data Lake Analytics accounts, jobs, policies, and catalogs. + +```bash +pip install azure-mgmt-datalake-analytics +``` + +### Example +This is an example of how to create a Data Lake Analytics account and submit a job. + +```python +## Required for Azure Resource Manager +from azure.mgmt.resource.resources import ResourceManagementClient +from azure.mgmt.resource.resources.models import ResourceGroup + +## Required for Azure Data Lake Store account management +from azure.mgmt.datalake.store import DataLakeStoreAccountManagementClient +from azure.mgmt.datalake.store.models import DataLakeStoreAccount + +## Required for Azure Data Lake Store filesystem management +from azure.datalake.store import core, lib, multithread + +## Required for Azure Data Lake Analytics account management +from azure.mgmt.datalake.analytics.account import DataLakeAnalyticsAccountManagementClient +from azure.mgmt.datalake.analytics.account.models import DataLakeAnalyticsAccount, DataLakeStoreAccountInfo + +## Required for Azure Data Lake Analytics job management +from azure.mgmt.datalake.analytics.job import DataLakeAnalyticsJobManagementClient +from azure.mgmt.datalake.analytics.job.models import JobInformation, JobState, USqlJobProperties + +subid= '' +rg = '' +location = '' # i.e. 'eastus2' +adls = '' +adls = '' + +# Create the clients +resourceClient = ResourceManagementClient(credentials, subid) +adlaAcctClient = DataLakeAnalyticsAccountManagementClient(credentials, subid) +adlaJobClient = DataLakeAnalyticsJobManagementClient( credentials, 'azuredatalakeanalytics.net') + +# Create resource group +armGroupResult = resourceClient.resource_groups.create_or_update(rg, ResourceGroup(location=location)) + +# Create a store account +adlaAcctResult = adlaAcctClient.account.create( + rg, + adla, + DataLakeAnalyticsAccount( + location=location, + default_data_lake_store_account=adls, + data_lake_store_accounts=[DataLakeStoreAccountInfo(name=adls)] + ) +).wait() + +# Create an ADLA account +adlaAcctResult = adlaAcctClient.account.create( + rg, + adla, + DataLakeAnalyticsAccount( + location=location, + default_data_lake_store_account=adls, + data_lake_store_accounts=[DataLakeStoreAccountInfo(name=adls)] + ) +).wait() + +# Submit a job +script = """ +@a = + SELECT * FROM + (VALUES + ("Contoso", 1500.0), + ("Woodgrove", 2700.0) + ) AS + D( customer, amount ); +OUTPUT @a + TO "/data.csv" + USING Outputters.Csv(); +""" + +jobId = str(uuid.uuid4()) +jobResult = adlaJobClient.job.create( + adla, + jobId, + JobInformation( + name='Sample Job', + type='USql', + properties=USqlJobProperties(script=script) + ) +) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/datalakeanalytics/management) + +## Samples +[Manage Azure Data Lake Anyalytics](https://docs.microsoft.com/azure/data-lake-analytics/data-lake-analytics-manage-use-python-sdk) + diff --git a/docs-ref-services/legacy/data-lake-storage-(gen-1).md b/docs-ref-services/legacy/data-lake-storage-(gen-1).md new file mode 100644 index 00000000..092f3413 --- /dev/null +++ b/docs-ref-services/legacy/data-lake-storage-(gen-1).md @@ -0,0 +1,27 @@ +--- +title: Azure Data Lake Store libraries for python +description: Reference for Azure Data Lake Store libraries for python +keywords: Azure, python, SDK, API, Data Lake Store +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: azure-data-lake-storage +manager: douge +--- +# Azure Data Lake Store libraries for python + +## Install the libraries +### Client + +```bash +pip install azure-datalake-store +``` + +### Management + +```bash +pip install azure-mgmt-datalake-store +``` +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/datalakestore/management) + diff --git a/docs-ref-services/legacy/data-nspkg-readme.md b/docs-ref-services/legacy/data-nspkg-readme.md new file mode 100644 index 00000000..3a84b284 --- /dev/null +++ b/docs-ref-services/legacy/data-nspkg-readme.md @@ -0,0 +1,20 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-data-nspkg, +ms.date: 09/08/2020 +ms.topic: reference +ms.devlang: python +ms.service: azure-python +--- +# Microsoft Azure Data SDK for Python + +This is the Microsoft Azure Data namespace package. + +This package is not intended to be installed directly by the end user. + +It provides the necessary files for other packages to extend the +azure.data namespace. + +If you are looking to install the Azure Data libraries, see the +[azure](https://pypi.python.org/pypi/azure) bundle package. + diff --git a/docs-ref-services/legacy/database-for-mysql-postgres.md b/docs-ref-services/legacy/database-for-mysql-postgres.md new file mode 100644 index 00000000..154ee088 --- /dev/null +++ b/docs-ref-services/legacy/database-for-mysql-postgres.md @@ -0,0 +1,203 @@ +--- +title: Azure MySQL/PostgreSQL libraries for Python +description: +keywords: Azure, Python, SDK, API, SQL, database, MySQL, PostgreSQL +ms.date: 10/02/2019 +ms.topic: reference +ms.devlang: azure-python +manager: douge +--- +# Azure Database for MySQL/PostgreSQL libraries for Python + +This article demonstrates how you can use Python to access data stored in Azure Database for MySQL and PostgreSQL. + +## MySQL + +Use Python to create and connect to an [Azure Database for MySQL](/azure/mysql/overview) server with the MySQL manager and pyodbc. + +### Management API + +Create and manage MySQL resources in your subscription with the management API. + +Install the MySQL management libraries with pip. +```bash +pip install azure-mgmt-rdbms +``` + +Please see the [Python SDK authentication](https://docs.microsoft.com/python/azure/python-sdk-azure-authenticate) page for details on obtaining credentials to authenticate with the management client. + +#### Create server example + +Creates an Azure Database for MySQL server and restricts access to a range of IP addresses using a firewall rule. + +Copy and paste the below code sample into a Python file (ex. `sample.py`) and update the subscription ID, resource group, server name, administrator user name, administrator password, and location with values of your own. + +```python +from azure.mgmt.rdbms.mysql import MySQLManagementClient +from azure.mgmt.rdbms.mysql.models import * + +SUBSCRIPTION_ID = "YOUR_AZURE_SUBSCRIPTION_ID" +RESOURCE_GROUP = "YOUR_AZURE_RESOURCE_GROUP" +SERVER = "YOUR_SERVER_NAME" +ADMIN_USER = "YOUR_ADMIN_USERNAME" +ADMIN_PASSWORD = "YOUR_ADMIN_PASSWORD" +LOCATION = "westus" + +client = MySQLManagementClient(credentials=creds, + subscription_id=SUBSCRIPTION_ID) + +server_creation_poller = client.servers.create( + RESOURCE_GROUP, + SERVER, + ServerForCreate( + properties=ServerPropertiesForDefaultCreate( + administrator_login=ADMIN_USER, + administrator_login_password=ADMIN_PASSWORD, + version=ServerVersion.one_one, + storage_profile=StorageProfile( + storage_mb=51200 + ) + ), + location=LOCATION, + sku=Sku( + name="GP_Gen5_2" + ) + ) +) + +server = server_creation_poller.result() + +# Open access to this server for IPs +rule_creation_poller = client.firewall_rules.create_or_update( + RESOURCE_GROUP, + SERVER, + "example_firewall_rule", # Custom firewall rule name + "123.123.123.123", # Start ip range + "123.123.123.124" # End ip range +) + +firewall_rule = rule_creation_poller.result() +``` + +### Client ODBC driver and pyodbc + +The recommended client library for accessing Azure Database for MySQL is the Microsoft [ODBC driver](/azure/sql-database/sql-database-connect-query-python#prerequisites). Use the ODBC driver to connect to the database and execute SQL statements directly. + +#### Example + +Connect to an Azure Database for MySQL server and select all records in the sales table. You can get the ODBC connection string for the database from the Azure Portal. + +```python +SERVER = 'YOUR_SEVER_NAME' + '.mysql.database.azure.com' +DATABASE = 'YOUR_DATABASE_NAME' +USERNAME = 'YOUR_MYSQL_USERNAME' +PASSWORD = 'YOUR_MYSQL_PASSWORD' + +DRIVER = '{MySQL ODBC 5.3 UNICODE Driver}' +cnxn = pyodbc.connect( + 'DRIVER=' + DRIVER + ';PORT=3306;SERVER=' + SERVER + ';PORT=3306;DATABASE=' + DATABASE + ';UID=' + USERNAME + ';PWD=' + PASSWORD) +cursor = cnxn.cursor() +selectsql = "SELECT * FROM SALES" # SALES is an example table name +cursor.execute(selectsql) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/postgresql/mysql/management) + +## PostgreSQL + +Use Python to create and connect to an [Azure Database for PostgreSQL](/azure/postgresql/overview) server with the PostgreSQL manager and pyodbc. + +Learn more about [Azure Database for PostgreSQL](https://docs.microsoft.com/azure/postgresql/). + +### Management API +Create and manage MySQL resources in your subscription with the management API. + +Install the PostgreSQL management libraries with pip. +```bash +pip install azure-mgmt-rdbms +``` + +Please see the [Python SDK authentication](https://docs.microsoft.com/python/azure/python-sdk-azure-authenticate) page for details on obtaining credentials to authenticate with the management client. + +#### Create server example + +Creates an Azure Database for PostgreSQL server and restricts access to a range of IP addresses using a firewall rule. + +Copy and paste the below code sample into a Python file (ex. `sample.py`) and update the subscription ID, resource group, server name, administrator user name, administrator password, and location with values of your own. + +```python +from azure.mgmt.rdbms.postgresql import PostgreSQLManagementClient +from azure.mgmt.rdbms.postgresql.models import * + +SUBSCRIPTION_ID = "YOUR_AZURE_SUBSCRIPTION_ID" +RESOURCE_GROUP = "YOUR_AZURE_RESOURCE_GROUP" +SERVER = "YOUR_SERVER_NAME" +ADMIN_USER = "YOUR_ADMIN_USERNAME" +ADMIN_PASSWORD = "YOUR_ADMIN_PASSWORD" +LOCATION = "westus" + +client = PostgreSQLManagementClient(credentials=creds, + subscription_id=SUBSCRIPTION_ID) + +server_creation_poller = client.servers.create( + RESOURCE_GROUP, + SERVER, + ServerForCreate( + properties=ServerPropertiesForDefaultCreate( + administrator_login=ADMIN_USER, + administrator_login_password=ADMIN_PASSWORD, + version=ServerVersion.one_one, + storage_profile=StorageProfile( + storage_mb=51200 + ) + ), + location=LOCATION, + sku=Sku( + name="GP_Gen5_2" + ) + ) +) + +server = server_creation_poller.result() + +# Open access to this server for IPs +rule_creation_poller = client.firewall_rules.create_or_update( + RESOURCE_GROUP, + SERVER, + "example_firewall_rule", # Custom firewall rule name + "123.123.123.123", # Start ip range + "123.123.123.124" # End ip range +) + +firewall_rule = rule_creation_poller.result() +``` + +### Client ODBC driver and pyodbc +The recommended client library for accessing Azure Database for PostgreSQL is the Microsoft [ODBC driver and pyodbc](https://docs.microsoft.com/azure/sql-database/sql-database-connect-query-python#prerequisites). + +#### Connect example + +Connect to an Azure Database for PostgreSQL server and select all records in the `SALES` table. You can get the ODBC connection string for the database from the Azure Portal. + +```python +import pyodbc + +SERVER = 'YOUR_SERVER_NAME.postgres.database.azure.com' +DATABASE = 'YOUR_DB_NAME' +USERNAME = 'YOUR_USERNAME' +PASSWORD = 'YOUR_PASSWORD' + +DRIVER = '{PostgreSQL ODBC Driver}' +cnxn = pyodbc.connect( + 'DRIVER=' + DRIVER + ';PORT=5432;SERVER=' + SERVER + + ';PORT=5432;DATABASE=' + DATABASE + ';UID=' + USERNAME + + ';PWD=' + PASSWORD) +cursor = cnxn.cursor() +selectsql = "SELECT * FROM SALES" # SALES is an example table name +cursor.execute(selectsql) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/postgresql/mysql/management) + diff --git a/docs-ref-services/legacy/devtest-labs.md b/docs-ref-services/legacy/devtest-labs.md new file mode 100644 index 00000000..1e3d61d0 --- /dev/null +++ b/docs-ref-services/legacy/devtest-labs.md @@ -0,0 +1,59 @@ +--- +title: Azure DevTest Labs libraries for python +description: Reference for Azure DevTest Labs libraries for python +keywords: Azure, python, SDK, API, DevTest Labs +ms.date: 02/21/2018 +ms.topic: reference +ms.devlang: python +ms.service: devtest-lab +manager: routlaw +--- +# Azure DevTest Labs libraries for python + +## [Management API](/python/api/overview/azure/devtestlabs/management) + +```bash +pip install azure-mgmt-devtestlabs +``` + +## Create the management client + +The following code creates an instance of the management client. + +You will need to provide your ``subscription_id`` which can be retrieved from [your subscription list](https://manage.windowsazure.com/#Workspaces/AdminTasks/SubscriptionMapping). + +See [Resource Management Authentication](/python/azure/python-sdk-azure-authenticate) for details on handling Azure Active Directory authentication with the Python SDK, and creating a ``Credentials`` instance. + +```python +from azure.mgmt.devtestlabs import DevTestLabsClient +from azure.common.credentials import UserPassCredentials + +# Replace this with your subscription id +subscription_id = '33333333-3333-3333-3333-333333333333' + +# See above for details on creating different types of AAD credentials +credentials = UserPassCredentials( + 'user@domain.com', # Your user + 'my_password', # Your password +) + +devtestlabs_client = DevTestLabsClient( + credentials, + subscription_id +) +``` + +## Create lab + +```python +async_lab = self.client.lab.create_or_update_resource( + 'MyResourceGroup', + 'MyLab', + {'location': 'westus'} +) +lab = async_lab.result() # Blocking wait +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/devtestlabs/management) + diff --git a/docs-ref-services/legacy/digitaltwins-core-readme.md b/docs-ref-services/legacy/digitaltwins-core-readme.md new file mode 100644 index 00000000..e891ba95 --- /dev/null +++ b/docs-ref-services/legacy/digitaltwins-core-readme.md @@ -0,0 +1,443 @@ +--- +title: Azure Azure Digital Twins Core client library for Python +keywords: Azure, python, SDK, API, azure-digitaltwins-core, digitaltwins +ms.date: 12/01/2020 +ms.topic: reference +ms.devlang: python +ms.service: digital-twins +--- +# Azure Azure Digital Twins Core client library for Python - version 1.1.0 + + +This package contains an SDK for Azure Digital Twins API to provide access to the Azure Digital Twins service for managing twins, models, relationships, etc. + +## Getting started + +### Introduction + +Azure Digital Twins is a developer platform for next-generation IoT solutions that lets you create, run, and manage digital representations of your business environment, securely and efficiently in the cloud. With Azure Digital Twins, creating live operational state representations is quick and cost-effective, and digital representations stay current with real-time data from IoT and other data sources. If you are new to Azure Digital Twins and would like to learn more about the platform, please make sure you check out the Azure Digital Twins [official documentation page](https://docs.microsoft.com/azure/digital-twins/overview). + +For an introduction on how to program against the Azure Digital Twins service, visit the [coding tutorial page](https://docs.microsoft.com/azure/digital-twins/tutorial-code) for an easy step-by-step guide. Visit [this tutorial](https://docs.microsoft.com/azure/digital-twins/tutorial-command-line-app) to learn how to interact with an Azure Digital Twin instance using a command-line client application. Finally, for a quick guide on how to build an end-to-end Azure Digital Twins solution that is driven by live data from your environment, make sure you check out [this helpful guide](https://docs.microsoft.com/azure/digital-twins/tutorial-end-to-end). + +The guides mentioned above can help you get started with key elements of Azure Digital Twins, such as creating Azure Digital Twins instances, models, twin graphs, etc. Use this samples guide below to familiarize yourself with the various APIs that help you program against Azure Digital Twins. + +### How to Install + +Install [azure-digitaltwins-core][pypi_package_keys] and +[azure-identity][azure_identity_pypi] with [pip][pip]: +```Bash +pip install azure-digitaltwins-core azure-identity +``` +[azure-identity][azure_identity] is used for Azure Active Directory +authentication as demonstrated below. + +### How to use + +#### Authentication, permission + +To create a new digital twins client, you need the endpoint to an Azure Digital Twin instance and credentials. +For the samples below, the `AZURE_URL`, `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` environment variables have to be set. +The client requires an instance of [TokenCredential](https://docs.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet) or [ServiceClientCredentials](https://docs.microsoft.com/dotnet/api/microsoft.rest.serviceclientcredentials?view=azure-dotnet). +In this samples, we illustrate how to use one derived class: [DefaultAzureCredentials](https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet). + +> Note: In order to access the data plane for the Digital Twins service, the entity must be given permissions. +> To do this, use the Azure CLI command: `az dt rbac assign-role --assignee '' --role owner -n ''` + +DefaultAzureCredential supports different authentication mechanisms and determines the appropriate credential type based of the environment it is executing in. +It attempts to use multiple credential types in an order until it finds a working credential. + +##### Sample code + +```python Snippet:dt_create_digitaltwins_service_client.py +# DefaultAzureCredential supports different authentication mechanisms and determines the appropriate credential type based of the environment it is executing in. +# It attempts to use multiple credential types in an order until it finds a working credential. + +# - AZURE_URL: The URL to the ADT in Azure +url = os.getenv("AZURE_URL") + +# DefaultAzureCredential expects the following three environment variables: +# - AZURE_TENANT_ID: The tenant ID in Azure Active Directory +# - AZURE_CLIENT_ID: The application (client) ID registered in the AAD tenant +# - AZURE_CLIENT_SECRET: The client secret for the registered application +credential = DefaultAzureCredential() +service_client = DigitalTwinsClient(url, credential) +``` + +## Key concepts + +Azure Digital Twins is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. +You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation](https://docs.microsoft.com/azure/digital-twins/). + +## Examples + +You can explore the digital twins APIs (using the client library) using the samples project. + +The samples project demonstrates the following: + +- Instantiate the client +- Create, get, and decommission models +- Create, query, and delete a digital twin +- Get and update components for a digital twin +- Create, get, and delete relationships between digital twins +- Create, get, and delete event routes for digital twin +- Publish telemetry messages to a digital twin and digital twin component + +### Create, list, decommission, and delete models + +#### Create models + +Let's create models using the code below. You need to pass an array containing list of models. + +```Python Snippet:dt_models_lifecycle +temporary_component = { + "@id": component_id, + "@type": "Interface", + "@context": "dtmi:dtdl:context;2", + "displayName": "Component1", + "contents": [ + { + "@type": "Property", + "name": "ComponentProp1", + "schema": "string" + }, + { + "@type": "Telemetry", + "name": "ComponentTelemetry1", + "schema": "integer" + } + ] +} + +temporary_model = { + "@id": model_id, + "@type": "Interface", + "@context": "dtmi:dtdl:context;2", + "displayName": "TempModel", + "contents": [ + { + "@type": "Property", + "name": "Prop1", + "schema": "string" + }, + { + "@type": "Component", + "name": "Component1", + "schema": component_id + }, + { + "@type": "Telemetry", + "name": "Telemetry1", + "schema": "integer" + } + ] +} + +new_models = [temporary_component, temporary_model] +models = service_client.create_models(new_models) +print('Created Models:') +print(models) +``` + +### List models +Using `list_models` to retrieve all created models + +```Python Snippet:dt_models_lifecycle +listed_models = service_client.list_models() +for model in listed_models: + print(model) +``` + +### Get model +Use `get_model` with model's unique identifier to get a specific model. + +```Python Snippet:dt_models_lifecycle +# Get a model +get_model = service_client.get_model(model_id) +print('Get Model:') +print(get_model) +``` + +### Decommission model +To decommision a model, pass in a model Id for the model you want to decommision. + +```Python Snippet:dt_models_lifecycle +# Decommission a model +service_client.decommission_model(model_id) +``` + +### Delete model +To delete a model, pass in a model Id for the model you want to delete. + +```Python Snippet:dt_models_lifecycle +# Delete a model +service_client.delete_model(model_id) +``` + +## Create and delete digital twins + +### Create digital twins +For Creating Twin you will need to provide Id of a digital Twin such as `my_twin` and the application/json digital twin based on the model created earlier. You can look at sample application/json [here](https://github.com/Azure/azure-sdk-for-python/tree/azure-digitaltwins-core_1.1.0/sdk/digitaltwins/azure-digitaltwins-core/samples/dtdl/digital_twins). + +```Python Snippet:dt_digitaltwins_lifecycle +digital_twin_id = 'digitalTwin-' + str(uuid.uuid4()) +temporary_twin = { + "$metadata": { + "$model": model_id + }, + "$dtId": digital_twin_id, + "Prop1": 42 +} + +created_twin = service_client.upsert_digital_twin(digital_twin_id, temporary_twin) +print('Created Digital Twin:') +print(created_twin) +``` + +### Get a digital twin + +Getting a digital twin is extremely easy. +```Python Snippet:dt_digitaltwins_lifecycle +get_twin = service_client.get_digital_twin(digital_twin_id) +print('Get Digital Twin:') +print(get_twin) +``` + +### Query digital twins + +Query the Azure Digital Twins instance for digital twins using the [Azure Digital Twins Query Store lanaguage](https://docs.microsoft.com/azure/digital-twins/concepts-query-language). Query calls support paging. Here's an example of how to query for digital twins and how to iterate over the results. + +Note that there may be a delay between before changes in your instance are reflected in queries. +For more details on query limitations, see (https://docs.microsoft.com/azure/digital-twins/how-to-query-graph#query-limitations) + +```Python Snippet:dt_digitaltwins_query +query_expression = 'SELECT * FROM digitaltwins' +query_result = service_client.query_twins(query_expression) +print('DigitalTwins:') +for twin in query_result: + print(twin) +``` + +### Delete digital twins + +Delete a digital twin simply by providing Id of a digital twin as below. + +```Python Snippet:dt_digitaltwins_lifecycle +service_client.delete_digital_twin(digital_twin_id) +``` + +## Get and update digital twin components + +### Update digital twin components + +To update a component or in other words to replace, remove and/or add a component property or subproperty within Digital Twin, you would need Id of a digital twin, component name and application/json-patch+json operations to be performed on the specified digital twin's component. Here is the sample code on how to do it. + +```Python Snippet:dt_component_lifecycle +component_name = "Component1" +patch = [ + { + "op": "replace", + "path": "/ComponentProp1", + "value": "value2" + } +] +service_client.update_component(digital_twin_id, component_name, patch) +``` + +### Get digital twin components + +Get a component by providing name of a component and Id of digital twin to which it belongs. + +```Python Snippet:dt_component_lifecycle +get_component = service_client.get_component(digital_twin_id, component_name) +print('Get Component:') +print(get_component) +``` + +## Create and list digital twin relationships + +### Create digital twin relationships + +`upsert_relationship` creates a relationship on a digital twin provided with Id of a digital twin, name of relationship such as "contains", Id of an relationship such as "FloorContainsRoom" and an application/json relationship to be created. Must contain property with key "\$targetId" to specify the target of the relationship. Sample payloads for relationships can be found [here](https://github.com/Azure/azure-sdk-for-python/blob/azure-digitaltwins-core_1.1.0/sdk/digitaltwins/azure-digitaltwins-core/samples/dtdl/relationships/hospitalRelationships.json). + +```Python Snippet:dt_scenario +hospital_relationships = [ + { + "$relationshipId": "BuildingHasFloor", + "$sourceId": building_twin_id, + "$relationshipName": "has", + "$targetId": floor_twin_id, + "isAccessRestricted": False + }, + { + "$relationshipId": "BuildingIsEquippedWithHVAC", + "$sourceId": building_twin_id, + "$relationshipName": "isEquippedWith", + "$targetId": hvac_twin_id + }, + { + "$relationshipId": "HVACCoolsFloor", + "$sourceId": hvac_twin_id, + "$relationshipName": "controlsTemperature", + "$targetId": floor_twin_id + }, + { + "$relationshipId": "FloorContainsRoom", + "$sourceId": floor_twin_id, + "$relationshipName": "contains", + "$targetId": room_twin_id + } +] + +for relationship in hospital_relationships: + service_client.upsert_relationship( + relationship["$sourceId"], + relationship["$relationshipId"], + relationship + ) +``` + +### List digital twin relationships + +`list_relationships` and `list_incoming_relationships` lists all the relationships and all incoming relationships respectively of a digital twin. + +```Python Snippet:dt_relationships_list +relationships = service_client.list_relationships(digital_twint_id) +for relationship in relationships: + print(relationship) +``` + +```Python Snippet:dt_incoming_relationships_list +incoming_relationships = service_client.list_incoming_relationships(digital_twin_id) +for incoming_relationship in incoming_relationships: + print(incoming_relationship) +``` + +## Create, list, and delete event routes of digital twins + +### Create event routes + +To create an event route, provide an Id of an event route such as "myEventRouteId" and event route data containing the endpoint and optional filter like the example shown below. + +```Python Snippet:dt_scenario +event_route_id = 'eventRoute-' + str(uuid.uuid4()) +event_filter = "$eventType = 'DigitalTwinTelemetryMessages' or $eventType = 'DigitalTwinLifecycleNotification'" +route = DigitalTwinsEventRoute( + endpoint_name=event_hub_endpoint_name, + filter=event_filter +) +service_client.upsert_event_route(event_route_id, route) +``` + +For more information on the event route filter language, see the "how to manage routes" [filter events documentation](https://github.com/Azure/azure-digital-twins/blob/private-preview/Documentation/how-to-manage-routes.md#filter-events). + +### List event routes + +List a specific event route given event route Id or all event routes setting options with `list_event_routes`. + +```Python Snippet:dt_event_routes_list +event_routes = service_client.list_event_routes() +for event_route in event_routes: + print(event_route) +``` + +### Delete event routes + +Delete an event route given event route Id. + +```Python Snippet:dt_scenario +service_client.delete_event_route(event_route_id) +``` + +### Publish telemetry messages for a digital twin + +To publish a telemetry message for a digital twin, you need to provide the digital twin Id, along with the payload on which telemetry that needs the update. + +```Python Snippet:dt_publish_telemetry +digita_twin_id = "" +telemetry_payload = '{"Telemetry1": 5}' +service_client.publish_telemetry( + digita_twin_id, + telemetry_payload +) +``` + +You can also publish a telemetry message for a specific component in a digital twin. In addition to the digital twin Id and payload, you need to specify the target component Id. + +```Python Snippet:dt_publish_component_telemetry +digita_twin_id = "" +component_name = "" +telemetry_payload = '{"Telemetry1": 5}' +service_client.publish_component_telemetry( + digita_twin_id, + component_name, + telemetry_payload +) +``` + +## Troubleshooting + +## Logging +This library uses the standard logging library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level. + +Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the logging_enable keyword argument: + +### Client level logging +```python Snippet:dt_digitaltwins_get.py +import sys +import logging + +# Create logger +logger = logging.getLogger('azure') +logger.setLevel(logging.DEBUG) +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +# Create service client and enable logging for all operations +service_client = DigitalTwinsClient(url, credential, logging_enable=True) +``` + +### Per-operation level logging +```python Snippet:dt_models_get.py +import sys +import logging + +# Create logger +logger = logging.getLogger('azure') +logger.setLevel(logging.DEBUG) +handler = logging.StreamHandler(stream=sys.stdout) +logger.addHandler(handler) + +# Get model with logging enabled +model = service_client.get_model(model_id, logging_enable=True) +``` + +### Optional Configuration +Optional keyword arguments can be passed in at the client and per-operation level. The azure-core [reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html) describes available configurations for retries, logging, transport protocols, and more. + +[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/azure-digitaltwins-core_1.1.0/sdk/identity/azure-identity +[azure_identity_pypi]: https://pypi.org/project/azure-identity/ +[default_cred_ref]: https://aka.ms/azsdk/python/identity/docs#azure.identity.DefaultAzureCredential +[pip]: https://pypi.org/project/pip/ + + +## Next steps + +### Provide Feedback + +If you encounter bugs or have suggestions, please +[open an issue](https://github.com/Azure/azure-sdk-for-python/issues). + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + diff --git a/docs-ref-services/legacy/dns.md b/docs-ref-services/legacy/dns.md new file mode 100644 index 00000000..e440ce39 --- /dev/null +++ b/docs-ref-services/legacy/dns.md @@ -0,0 +1,91 @@ +--- +title: Azure DNS libraries for python +description: Reference for Azure DNS libraries for python +keywords: Azure, python, SDK, API, DNS +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: dns +manager: douge +--- +# Azure DNS libraries for python + +## Overview + +[Azure DNS](/azure/dns/dns-overview) is a hosting service for DNS domains that provides DNS resolution via the Azure infrastructure. + +To get started with Azure DNS, see [Get started with Azure DNS using the Azure portal](/azure/dns/dns-getstarted-portal). + +## [Management API](/python/api/overview/azure/dns/management) + +```bash +pip install azure-mgmt-dns +``` + +## Create the management client + +The following code creates an instance of the management client. + +You will need to provide your ``subscription_id`` which can be retrieved +from [your subscription list](https://manage.windowsazure.com/#Workspaces/AdminTasks/SubscriptionMapping). + +See [Resource Management Authentication](/python/azure/python-sdk-azure-authenticate) +for details on handling Azure Active Directory authentication with the Python SDK, and creating a ``Credentials`` instance. + +```python +from azure.mgmt.dns import DnsManagementClient +from azure.common.credentials import UserPassCredentials + +# Replace this with your subscription id +subscription_id = '33333333-3333-3333-3333-333333333333' + +# See above for details on creating different types of AAD credentials +credentials = UserPassCredentials( + 'user@domain.com', # Your user + 'my_password', # Your password +) + +dns_client = DnsManagementClient( + credentials, + subscription_id +) +``` + +## Create DNS zone +```python +# The only valid value is 'global', otherwise you will get a: +# The subscription is not registered for the resource type 'dnszones' in the location 'westus'. +zone = dns_client.zones.create_or_update( + 'MyResourceGroup', + 'pydns.com', + { + 'zone_type': 'Public', # or Private + 'location': 'global' + } +) +``` + +## Create a Record Set +```python +record_set = dns_client.record_sets.create_or_update( + 'MyResourceGroup', + 'pydns.com', + 'MyRecordSet', + 'A', + { + "ttl": 300, + "arecords": [ + { + "ipv4_address": "1.2.3.4" + }, + { + "ipv4_address": "1.2.3.5" + } + ] + } +) +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/dns/management) + diff --git a/docs-ref-services/legacy/event-grid.md b/docs-ref-services/legacy/event-grid.md new file mode 100644 index 00000000..08947e42 --- /dev/null +++ b/docs-ref-services/legacy/event-grid.md @@ -0,0 +1,145 @@ +--- +title: Azure Event Grid libraries for Python +description: +keywords: Azure, Python, SDK, API, Event Grid +ms.date: 08/21/2017 +ms.topic: reference +ms.devlang: python +ms.service: event-grid +manager: routlaw +--- +# Event Grid libraries for Python + + +Azure Event Grid is a fully-managed intelligent event routing service that allows for uniform event consumption using a publish-subscribe model. + +[Learn more](/azure/event-grid/overview) about Azure Event Grid and get started with the [Azure Blob storage event tutorial](/azure/storage/blobs/storage-blob-event-quickstart). + +## Publish SDK + +Authenticate, create, handle, and publish events to topics using the Azure Event Grid publish SDK. + +### Installation + +Install the package with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```bash +pip install azure-eventgrid +``` + +### Example + +The following code publishes an event to a topic. You can retrieve the topic key and endpoint through the Azure Portal or through the Azure CLI: + +```azurecli-interactive +endpoint=$(az eventgrid topic show --name -g gridResourceGroup --query "endpoint" --output tsv) +key=$(az eventgrid topic key list --name -g gridResourceGroup --query "key1" --output tsv) +``` + +```python +from datetime import datetime +from azure.eventgrid import EventGridClient +from msrest.authentication import TopicCredentials + +def publish_event(self): + + credentials = TopicCredentials( + self.settings.EVENT_GRID_KEY + ) + event_grid_client = EventGridClient(credentials) + event_grid_client.publish_events( + "your-endpoint-here", + events=[{ + 'id' : "dbf93d79-3859-4cac-8055-51e3b6b54bea", + 'subject' : "Sample subject", + 'data': { + 'key': 'Sample Data' + }, + 'event_type': 'SampleEventType', + 'event_time': datetime(2018, 5, 2), + 'data_version': 1 + }] + ) +``` + +> [!div class="nextstepaction"] +> [Explore the Client APIs](/python/api/overview/azure/eventgrid/client) + +## Management SDK + +Create, update, or delete Event Grid instances, topics, and subscriptions with the management SDK. + +### Installation + +Install the package with [pip](https://pip.pypa.io/en/stable/quickstart/): + +```bash +pip install azure-mgmt-eventgrid +``` + +### Example + +The following creates a custom topic and subscribes an endpoint to the topic. The code then sends an event to the topic through HTTPS. +RequestBin is an open source, third-party tool that enables you to create an endpoint, and view requests that are sent to it. Go to [RequestBin](https://requestbin.com), and click **Create a RequestBin**. Copy the bin URL, because you need it when subscribing to the topic. + +```python +from azure.mgmt.resource import ResourceManagementClient +from azure.mgmt.eventgrid import EventGridManagementClient +import requests + +RESOURCE_GROUP_NAME = 'gridResourceGroup' +TOPIC_NAME = 'gridTopic1234' +LOCATION = 'westus2' +SUBSCRIPTION_ID = 'YOUR_SUBSCRIPTION_ID' +SUBSCRIPTION_NAME = 'gridSubscription' +REQUEST_BIN_URL = 'YOUR_REQUEST_BIN_URL' + +# create resource group +resource_client = ResourceManagementClient(credentials, SUBSCRIPTION_ID) +resource_client.resource_groups.create_or_update( + RESOURCE_GROUP_NAME, + { + 'location': LOCATION + } +) + +event_client = EventGridManagementClient(credentials, SUBSCRIPTION_ID) + +# create a custom topic +event_client.topics.create_or_update(RESOURCE_GROUP_NAME, TOPIC_NAME, LOCATION) + +# subscribe to a topic +scope = '/subscriptions/'+SUBSCRIPTION_ID+'/resourceGroups/'+RESOURCE_GROUP_NAME+'/providers/Microsoft.EventGrid/topics/'+TOPIC_NAME +event_client.event_subscriptions.create(scope, SUBSCRIPTION_NAME, + { + 'destination': { + 'endpoint_url': REQUEST_BIN_URL + } + } +) + +# send an event to topic +# get endpoint url +url = event_client.event_subscriptions.get_full_url(scope, SUBSCRIPTION_NAME).endpoint_url +# get key +key = event_client.topics.list_shared_access_keys(RESOURCE_GROUP_NAME,TOPIC_NAME).key1 +headers = {'aeg-sas-key': key} +s = requests.get('https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/event-grid/customevent.json') +r = requests.post(url, data=s, headers=headers) +print(r.status_code) +print(r.content) +``` +Browse to the RequestBin URL created earlier to see the event just sent. + +Clean up resources +```azurecli-interactive +az group delete --name gridResourceGroup +``` + +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/eventgrid/management) + +## Learn more + +[Receive events using the Event Grid SDK](/azure/event-grid/receive-events) + diff --git a/docs-ref-services/legacy/event-hubs.md b/docs-ref-services/legacy/event-hubs.md new file mode 100644 index 00000000..c9ccf03e --- /dev/null +++ b/docs-ref-services/legacy/event-hubs.md @@ -0,0 +1,32 @@ +--- +title: Azure Event Hubs libraries for python +description: Reference for Azure Event Hubs libraries for python +keywords: Azure, python, SDK, API, Event Hubs +ms.date: 07/10/2017 +ms.topic: reference +ms.devlang: python +ms.service: event-hubs +manager: douge +--- +# Azure Event Hubs libraries for python + +## Install the libraries + + +### Client + +```bash +pip install azure-eventhub +``` +> [!div class="nextstepaction"] +> [Explore the Client APIs](/python/api/overview/azure/eventhub-readme) + + +### Management + +```bash +pip install azure-mgmt-eventhub +``` +> [!div class="nextstepaction"] +> [Explore the Management APIs](/python/api/overview/azure/eventhubs/management) + diff --git a/docs-ref-services/legacy/eventhub-checkpointstoreblob-aio-readme.md b/docs-ref-services/legacy/eventhub-checkpointstoreblob-aio-readme.md new file mode 100644 index 00000000..06fb2720 --- /dev/null +++ b/docs-ref-services/legacy/eventhub-checkpointstoreblob-aio-readme.md @@ -0,0 +1,152 @@ +--- +title: Azure EventHubs Checkpoint Store client library for Python +keywords: Azure, python, SDK, API, azure-eventhub-checkpointstoreblob-aio, eventhubs +ms.date: 09/08/2020 +ms.topic: reference +ms.devlang: python +ms.service: event-hubs +--- +# Azure EventHubs Checkpoint Store client library for Python - version 1.1.1 + using Storage Blobs + +Azure EventHubs Checkpoint Store is used for storing checkpoints while processing events from Azure Event Hubs. +This Checkpoint Store package works as a plug-in package to `EventHubConsumerClient`. It uses Azure Storage Blob as the persistent store for maintaining checkpoints and partition ownership information. + +Please note that this is an async library, for sync version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob). + +[Source code](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob-aio/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.aio.html#azure.eventhub.aio.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) + +## Getting started + +### Prerequisites + +- Python 3.5.3 or later. +- **Microsoft Azure Subscription:** To use Azure services, including Azure Event Hubs, you'll need a subscription. If you do not have an existing Azure account, you may sign up for a free trial or use your MSDN subscriber benefits when you [create an account](https://azure.microsoft.com/). + +- **Event Hubs namespace with an Event Hub:** To interact with Azure Event Hubs, you'll also need to have a namespace and Event Hub available. If you are not familiar with creating Azure resources, you may wish to follow the step-by-step guide for [creating an Event Hub using the Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-create). There, you can also find detailed instructions for using the Azure CLI, Azure PowerShell, or Azure Resource Manager (ARM) templates to create an Event Hub. + +- **Azure Storage Account:** You'll need to have an Azure Storage Account and create a Azure Blob Storage Block Container to store the checkpoint data with blobs. You may follow the guide [creating an Azure Block Blob Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-blob-create-account-block-blob). + +### Install the package + +``` +$ pip install azure-eventhub-checkpointstoreblob-aio +``` + +## Key concepts + +### Checkpointing + +Checkpointing is a process by which readers mark or commit their position within a partition event sequence. +Checkpointing is the responsibility of the consumer and occurs on a per-partition basis within a consumer group. +This responsibility means that for each consumer group, each partition reader must keep track of its current position +in the event stream, and can inform the service when it considers the data stream complete. If a reader disconnects from +a partition, when it reconnects it begins reading at the checkpoint that was previously submitted by the last reader of +that partition in that consumer group. When the reader connects, it passes the offset to the event hub to specify the +location at which to start reading. In this way, you can use checkpointing to both mark events as "complete" by +downstream applications, and to provide resiliency if a failover between readers running on different machines occurs. +It is possible to return to older data by specifying a lower offset from this checkpointing process. Through this +mechanism, checkpointing enables both failover resiliency and event stream replay. + +### Offsets & sequence numbers +Both offset & sequence number refer to the position of an event within a partition. You can think of them as a +client-side cursor. The offset is a byte numbering of the event. The offset/sequence number enables an event consumer +(reader) to specify a point in the event stream from which they want to begin reading events. You can specify a +timestamp such that you receive events enqueued only after the given timestamp. Consumers are responsible for +storing their own offset values outside of the Event Hubs service. Within a partition, each event includes an offset, +sequence number and the timestamp of when it was enqueued. + +## Examples +- [Create an Azure EventHubs `EventHubConsumerClient`](#create-an-eventhubconsumerclient) +- [Consume events using a `BlobCheckpointStore`](#consume-events-using-a-blobcheckpointstore-to-do-checkpoint) + +### Create an `EventHubConsumerClient` +The easiest way to create a `EventHubConsumerClient` is to use a connection string. +```python +from azure.eventhub.aio import EventHubConsumerClient +eventhub_client = EventHubConsumerClient.from_connection_string("my_eventhub_namespace_connection_string", "my_consumer_group", eventhub_name="my_eventhub") +``` +For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub) for more details. + +### Consume events using a `BlobCheckpointStore` to do checkpoint +```python +import asyncio + +from azure.eventhub.aio import EventHubConsumerClient +from azure.eventhub.extensions.checkpointstoreblobaio import BlobCheckpointStore + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +storage_connection_str = '<< CONNECTION STRING OF THE STORAGE >>' +container_name = '<< STORAGE CONTAINER NAME>>' + +async def on_event(partition_context, event): + # Put your code here. + await partition_context.update_checkpoint(event) # Or update_checkpoint every N events for better performance. + +async def main(): + checkpoint_store = BlobCheckpointStore.from_connection_string( + storage_connection_str, + container_name + ) + client = EventHubConsumerClient.from_connection_string( + connection_str, + consumer_group, + eventhub_name=eventhub_name, + checkpoint_store=checkpoint_store, + ) + + async with client: + await client.receive(on_event) + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(main()) +``` + +#### Use `BlobCheckpointStore` with a different version of Azure Storage Service API +Some environments have different versions of Azure Storage Service API. +`BlobCheckpointStore` by default uses the Storage Service API version 2019-07-07. To use it against a different +version, specify `api_version` when you create the `BlobCheckpointStore` object. + + +## Troubleshooting + +### General +Enabling logging will be helpful to do trouble shooting. + +### Logging + +- Enable `azure.eventhub.extensions.checkpointstoreblobaio` logger to collect traces from the library. +- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library. +- Enable `azure.eventhub.extensions.checkpointstoreblobaio._vendor.storage` logger to collect traces from azure storage blob library. +- Enable `uamqp` logger to collect traces from the underlying uAMQP library. +- Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. + +## Next steps + +### Examples +- [./samples/receive_events_using_checkpoint_store_async.py](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_async.py) - EventHubConsumerClient with blob checkpoint store example +- [./samples/receive_events_using_checkpoint_store_storage_api_version_async.py](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_storage_api_version_async.py) - EventHubConsumerClient with blob checkpoint store and storage version example + + +### Documentation + +Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.aio.html#azure.eventhub.aio.CheckpointStore) + +### 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. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + + diff --git a/docs-ref-services/legacy/eventhub-checkpointstoreblob-readme.md b/docs-ref-services/legacy/eventhub-checkpointstoreblob-readme.md new file mode 100644 index 00000000..953878ea --- /dev/null +++ b/docs-ref-services/legacy/eventhub-checkpointstoreblob-readme.md @@ -0,0 +1,150 @@ +--- +title: Azure EventHubs Checkpoint Store client library for Python +keywords: Azure, python, SDK, API, azure-eventhub-checkpointstoreblob, eventhubs +ms.date: 09/08/2020 +ms.topic: reference +ms.devlang: python +ms.service: event-hubs +--- +# Azure EventHubs Checkpoint Store client library for Python - version 1.1.1 + using Storage Blobs + +Azure EventHubs Checkpoint Store is used for storing checkpoints while processing events from Azure Event Hubs. +This Checkpoint Store package works as a plug-in package to `EventHubConsumerClient`. It uses Azure Storage Blob as the persistent store for maintaining checkpoints and partition ownership information. + +Please note that this is a sync library, for async version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob-aio](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio). + +[Source code](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html#azure.eventhub.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) + +## Getting started + +### Prerequisites + +- Python2.7, Python 3.5.3 or later. +- **Microsoft Azure Subscription:** To use Azure services, including Azure Event Hubs, you'll need a subscription. If you do not have an existing Azure account, you may sign up for a free trial or use your MSDN subscriber benefits when you [create an account](https://azure.microsoft.com/). + +- **Event Hubs namespace with an Event Hub:** To interact with Azure Event Hubs, you'll also need to have a namespace and Event Hub available. If you are not familiar with creating Azure resources, you may wish to follow the step-by-step guide for [creating an Event Hub using the Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-create). There, you can also find detailed instructions for using the Azure CLI, Azure PowerShell, or Azure Resource Manager (ARM) templates to create an Event Hub. + +- **Azure Storage Account:** You'll need to have an Azure Storage Account and create a Azure Blob Storage Block Container to store the checkpoint data with blobs. You may follow the guide [creating an Azure Block Blob Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-blob-create-account-block-blob). + +### Install the package + +``` +$ pip install azure-eventhub-checkpointstoreblob +``` + +## Key concepts + +### Checkpointing + +Checkpointing is a process by which readers mark or commit their position within a partition event sequence. +Checkpointing is the responsibility of the consumer and occurs on a per-partition basis within a consumer group. +This responsibility means that for each consumer group, each partition reader must keep track of its current position +in the event stream, and can inform the service when it considers the data stream complete. If a reader disconnects from +a partition, when it reconnects it begins reading at the checkpoint that was previously submitted by the last reader of +that partition in that consumer group. When the reader connects, it passes the offset to the event hub to specify the +location at which to start reading. In this way, you can use checkpointing to both mark events as "complete" by +downstream applications, and to provide resiliency if a failover between readers running on different machines occurs. +It is possible to return to older data by specifying a lower offset from this checkpointing process. Through this +mechanism, checkpointing enables both failover resiliency and event stream replay. + +### Offsets & sequence numbers +Both offset & sequence number refer to the position of an event within a partition. You can think of them as a +client-side cursor. The offset is a byte numbering of the event. The offset/sequence number enables an event consumer +(reader) to specify a point in the event stream from which they want to begin reading events. You can specify a +timestamp such that you receive events enqueued only after the given timestamp. Consumers are responsible for +storing their own offset values outside of the Event Hubs service. Within a partition, each event includes an offset, +sequence number and the timestamp of when it was enqueued. + +## Examples +- [Create an Azure EventHubs `EventHubConsumerClient`](#create-an-eventhubconsumerclient) +- [Consume events using a `BlobCheckpointStore`](#consume-events-using-a-blobcheckpointstore-to-do-checkpoint) + +### Create an `EventHubConsumerClient` +The easiest way to create a `EventHubConsumerClient` is to use a connection string. +```python +from azure.eventhub import EventHubConsumerClient +eventhub_client = EventHubConsumerClient.from_connection_string("my_eventhub_namespace_connection_string", "my_consumer_group", eventhub_name="my_eventhub") +``` +For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub) for more details. + +### Consume events using a `BlobCheckpointStore` to do checkpoint +```python + +from azure.eventhub import EventHubConsumerClient +from azure.eventhub.extensions.checkpointstoreblob import BlobCheckpointStore + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +storage_connection_str = '<< CONNECTION STRING OF THE STORAGE >>' +container_name = '<< STORAGE CONTAINER NAME>>' + + +def on_event(partition_context, event): + # Put your code here. + partition_context.update_checkpoint(event) # Or update_checkpoint every N events for better performance. + +def main(): + checkpoint_store = BlobCheckpointStore.from_connection_string( + storage_connection_str, + container_name + ) + client = EventHubConsumerClient.from_connection_string( + connection_str, + consumer_group, + eventhub_name=eventhub_name, + checkpoint_store=checkpoint_store, + ) + + with client: + client.receive(on_event) + +if __name__ == '__main__': + main() +``` + +#### Use `BlobCheckpointStore` with a different version of Azure Storage Service API +Some environments have different versions of Azure Storage Service API. +`BlobCheckpointStore` by default uses the Storage Service API version 2019-07-07. To use it against a different +version, specify `api_version` when you create the `BlobCheckpointStore` object. + + +## Troubleshooting + +### General +Enabling logging will be helpful to do trouble shooting. + +### Logging + +- Enable `azure.eventhub.extensions.checkpointstoreblob` logger to collect traces from the library. +- Enable `azure.eventhub` logger to collect traces from the main azure-eventhub library. +- Enable `azure.eventhub.extensions.checkpointstoreblob._vendor.storage` logger to collect traces from azure storage blob library. +- Enable `uamqp` logger to collect traces from the underlying uAMQP library. +- Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. + +## Next steps + +### Examples +- [./samples/receive_events_using_checkpoint_store.py](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store.py) - EventHubConsumerClient with blob checkpoint store example +- [./samples/receive_events_using_checkpoint_store_storage_api_version.py](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store_storage_api_version.py) - EventHubConsumerClient with blob checkpoint store and storage version example + +### Documentation + +Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html#azure.eventhub.CheckpointStore) + +### 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. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + + diff --git a/docs-ref-services/legacy/eventhub-readme.md b/docs-ref-services/legacy/eventhub-readme.md new file mode 100644 index 00000000..844f3e28 --- /dev/null +++ b/docs-ref-services/legacy/eventhub-readme.md @@ -0,0 +1,443 @@ +--- +title: Azure Event Hubs client library for Python +keywords: Azure, python, SDK, API, azure-eventhub, eventhubs +ms.date: 09/08/2020 +ms.topic: reference +ms.devlang: python +ms.service: event-hubs +--- +# Azure Event Hubs client library for Python - version 5.2.0 + + +Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream +them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected +devices and applications. Once Event Hubs has collected the data, you can retrieve, transform, and store it by using +any real-time analytics provider or with batching/storage adapters. If you would like to know more about Azure Event Hubs, +you may wish to review: [What is Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about)? + +The Azure Event Hubs client library allows for publishing and consuming of Azure Event Hubs events and may be used to: + +- Emit telemetry about your application for business intelligence and diagnostic purposes. +- Publish facts about the state of your application which interested parties may observe and use as a trigger for taking action. +- Observe interesting operations and interactions happening within your business or other ecosystem, allowing loosely coupled systems to interact without the need to bind them together. +- Receive events from one or more publishers, transform them to better meet the needs of your ecosystem, then publish the transformed events to a new stream for consumers to observe. + +[Source code](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/azure/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-eventhub_5.2.0/sdk/eventhub/azure-eventhub/samples) +## Getting started + +### Prerequisites + +- Python 2.7, 3.5.3 or later. +- **Microsoft Azure Subscription:** To use Azure services, including Azure Event Hubs, you'll need a subscription. +If you do not have an existing Azure account, you may sign up for a free trial or use your MSDN subscriber benefits when you [create an account](https://account.windowsazure.com/Home/Index). + +- **Event Hubs namespace with an Event Hub:** To interact with Azure Event Hubs, you'll also need to have a namespace and Event Hub available. +If you are not familiar with creating Azure resources, you may wish to follow the step-by-step guide +for [creating an Event Hub using the Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-create). +There, you can also find detailed instructions for using the Azure CLI, Azure PowerShell, or Azure Resource Manager (ARM) templates to create an Event Hub. + +### Install the package + +Install the Azure Event Hubs client library for Python - version 5.2.0 + with pip: + +``` +$ pip install azure-eventhub +``` + +### Authenticate the client + +Interaction with Event Hubs starts with an instance of EventHubConsumerClient or EventHubProducerClient class. You need either the host name, SAS/AAD credential and event hub name or a connection string to instantiate the client object. + +**[Create client from connection string:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.2.0/sdk/eventhub/azure-eventhub/samples/sync_samples/connection_string_authentication.py)** + +For the Event Hubs client library to interact with an Event Hub, the easiest means is to use a connection string, which is created automatically when creating an Event Hubs namespace. +If you aren't familiar with shared access policies in Azure, you may wish to follow the step-by-step guide to [get an Event Hubs connection string](https://docs.microsoft.com/azure/event-hubs/event-hubs-get-connection-string). + +- The `from_connection_string` method takes the connection string of the form +`Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=` and +entity name to your Event Hub instance. You can get the connection string from the [Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal). + +**[Create client using the azure-identity library:](https://github.com/Azure/azure-sdk-for-python/blob/azure-eventhub_5.2.0/sdk/eventhub/azure-eventhub/samples/sync_samples/client_identity_authentication.py)** + +Alternately, one can use a Credential object to authenticate via AAD with the azure-identity package. + +- This constructor demonstrated in the sample linked above takes the host name and entity name of your Event Hub instance and credential that implements the +[TokenCredential](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/core/azure-core/azure/core/credentials.py) +protocol. There are implementations of the `TokenCredential` protocol available in the +[azure-identity package](https://pypi.org/project/azure-identity/). The host name is of the format ``. +- When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the +Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, +please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory). + +## Key concepts + +- An **EventHubProducerClient** is a source of telemetry data, diagnostics information, usage logs, or other log data, +as part of an embedded device solution, a mobile device application, a game title running on a console or other device, +some client or server based business solution, or a web site. + +- An **EventHubConsumerClient** picks up such information from the Event Hub and processes it. Processing may involve aggregation, +complex computation, and filtering. Processing may also involve distribution or storage of the information in a raw or transformed fashion. +Event Hub consumers are often robust and high-scale platform infrastructure parts with built-in analytics capabilities, +like Azure Stream Analytics, Apache Spark, or Apache Storm. + +- A **partition** is an ordered sequence of events that is held in an Event Hub. Azure Event Hubs provides message streaming +through a partitioned consumer pattern in which each consumer only reads a specific subset, or partition, of the message stream. +As newer events arrive, they are added to the end of this sequence. The number of partitions is specified at the time an Event Hub is created and cannot be changed. + +- A **consumer group** is a view of an entire Event Hub. Consumer groups enable multiple consuming applications to each +have a separate view of the event stream, and to read the stream independently at their own pace and from their own position. +There can be at most 5 concurrent readers on a partition per consumer group; however it is recommended that there is only +one active consumer for a given partition and consumer group pairing. Each active reader receives all of the events from +its partition; if there are multiple readers on the same partition, then they will receive duplicate events. + +For more concepts and deeper discussion, see: [Event Hubs Features](https://docs.microsoft.com/azure/event-hubs/event-hubs-features). +Also, the concepts for AMQP are well documented in [OASIS Advanced Messaging Queuing Protocol (AMQP) Version 1.0](http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html). + +## Examples + +The following sections provide several code snippets covering some of the most common Event Hubs tasks, including: + +- [Inspect an Event Hub](#inspect-an-event-hub) +- [Publish events to an Event Hub](#publish-events-to-an-event-hub) +- [Consume events from an Event Hub](#consume-events-from-an-event-hub) +- [Consume events from an Event Hub in batches](#consume-events-from-an-event-hub-in-batches) +- [Publish events to an Event Hub asynchronously](#publish-events-to-an-event-hub-asynchronously) +- [Consume events from an Event Hub asynchronously](#consume-events-from-an-event-hub-asynchronously) +- [Consume events from an Event Hub in batches asynchronously](#consume-events-from-an-event-hub-in-batches-asynchronously) +- [Consume events and save checkpoints using a checkpoint store](#consume-events-and-save-checkpoints-using-a-checkpoint-store) +- [Use EventHubConsumerClient to work with IoT Hub](#use-eventhubconsumerclient-to-work-with-iot-hub) + +### Inspect an Event Hub + +Get the partition ids of an Event Hub. + +```python +from azure.eventhub import EventHubConsumerClient + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name) +partition_ids = client.get_partition_ids() +``` + +### Publish events to an Event Hub + +Use the `create_batch` method on `EventHubProducerClient` to create an `EventDataBatch` object which can then be sent using the `send_batch` method. +Events may be added to the `EventDataBatch` using the `add` method until the maximum batch size limit in bytes has been reached. +```python +from azure.eventhub import EventHubProducerClient, EventData + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name) + +event_data_batch = client.create_batch() +can_add = True +while can_add: + try: + event_data_batch.add(EventData('Message inside EventBatchData')) + except ValueError: + can_add = False # EventDataBatch object reaches max_size. + +with client: + client.send_batch(event_data_batch) +``` + +### Consume events from an Event Hub + +There are multiple ways to consume events from an EventHub. To simply trigger a callback when an event is received, +the `EventHubConsumerClient.receive` method will be of use as follows: + +```python +import logging +from azure.eventhub import EventHubConsumerClient + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name) + +logger = logging.getLogger("azure.eventhub") +logging.basicConfig(level=logging.INFO) + +def on_event(partition_context, event): + logger.info("Received event from partition {}".format(partition_context.partition_id)) + partition_context.update_checkpoint(event) + +with client: + client.receive( + on_event=on_event, + starting_position="-1", # "-1" is from the beginning of the partition. + ) + # receive events from specified partition: + # client.receive(on_event=on_event, partition_id='0') +``` + +### Consume events from an Event Hub in batches + +Whereas the above sample triggers the callback for each message as it is received, the following sample +triggers the callback on a batch of events, attempting to receive a number at a time. + +```python +import logging +from azure.eventhub import EventHubConsumerClient + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name) + +logger = logging.getLogger("azure.eventhub") +logging.basicConfig(level=logging.INFO) + +def on_event_batch(partition_context, events): + logger.info("Received event from partition {}".format(partition_context.partition_id)) + partition_context.update_checkpoint() + +with client: + client.receive_batch( + on_event_batch=on_event_batch, + starting_position="-1", # "-1" is from the beginning of the partition. + ) + # receive events from specified partition: + # client.receive_batch(on_event_batch=on_event_batch, partition_id='0') +``` + +### Publish events to an Event Hub asynchronously + +Use the `create_batch` method on `EventHubProcuer` to create an `EventDataBatch` object which can then be sent using the `send_batch` method. +Events may be added to the `EventDataBatch` using the `add` method until the maximum batch size limit in bytes has been reached. +```python +import asyncio +from azure.eventhub.aio import EventHubProducerClient # The package name suffixed with ".aio" for async +from azure.eventhub import EventData + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' + +async def create_batch(client): + event_data_batch = await client.create_batch() + can_add = True + while can_add: + try: + event_data_batch.add(EventData('Message inside EventBatchData')) + except ValueError: + can_add = False # EventDataBatch object reaches max_size. + return event_data_batch + +async def send(): + client = EventHubProducerClient.from_connection_string(connection_str, eventhub_name=eventhub_name) + batch_data = await create_batch(client) + async with client: + await client.send_batch(batch_data) + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(send()) +``` + +### Consume events from an Event Hub asynchronously + +This SDK supports both synchronous and asyncio based code. To receive as demonstrated in the samples above, but within +aio, one would need the following: + +```python +import logging +import asyncio +from azure.eventhub.aio import EventHubConsumerClient + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' + +logger = logging.getLogger("azure.eventhub") +logging.basicConfig(level=logging.INFO) + +async def on_event(partition_context, event): + logger.info("Received event from partition {}".format(partition_context.partition_id)) + await partition_context.update_checkpoint(event) + +async def receive(): + client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name) + async with client: + await client.receive( + on_event=on_event, + starting_position="-1", # "-1" is from the beginning of the partition. + ) + # receive events from specified partition: + # await client.receive(on_event=on_event, partition_id='0') + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(receive()) +``` + +### Consume events from an Event Hub in batches asynchronously + +All synchronous functions are supported in aio as well. As demonstrated above for synchronous batch receipt, one can accomplish +the same within asyncio as follows: + +```python +import logging +import asyncio +from azure.eventhub.aio import EventHubConsumerClient + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' + +logger = logging.getLogger("azure.eventhub") +logging.basicConfig(level=logging.INFO) + +async def on_event_batch(partition_context, events): + logger.info("Received event from partition {}".format(partition_context.partition_id)) + await partition_context.update_checkpoint() + +async def receive_batch(): + client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group, eventhub_name=eventhub_name) + async with client: + await client.receive_batch( + on_event_batch=on_event_batch, + starting_position="-1", # "-1" is from the beginning of the partition. + ) + # receive events from specified partition: + # await client.receive_batch(on_event_batch=on_event_batch, partition_id='0') + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(receive_batch()) +``` + +### Consume events and save checkpoints using a checkpoint store + +`EventHubConsumerClient` is a high level construct which allows you to receive events from multiple partitions at once +and load balance with other consumers using the same Event Hub and consumer group. + +This also allows the user to track progress when events are processed using checkpoints. + +A checkpoint is meant to represent the last successfully processed event by the user from a particular partition of +a consumer group in an Event Hub instance. The `EventHubConsumerClient` uses an instance of `CheckpointStore` to update checkpoints +and to store the relevant information required by the load balancing algorithm. + +Search pypi with the prefix `azure-eventhub-checkpointstore` to +find packages that support this and use the `CheckpointStore` implementation from one such package. Please note that both sync and async libraries are provided. + +In the below example, we create an instance of `EventHubConsumerClient` and use a `BlobCheckpointStore`. You need +to [create an Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal) +and a [Blob Container](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container) to run the code. + +[Azure Blob Storage Checkpoint Store Async](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio) +and [Azure Blob Storage Checkpoint Store Sync](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub-checkpointstoreblob) +are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store. + + +```python +import asyncio + +from azure.eventhub.aio import EventHubConsumerClient +from azure.eventhub.extensions.checkpointstoreblobaio import BlobCheckpointStore + +connection_str = '<< CONNECTION STRING FOR THE EVENT HUBS NAMESPACE >>' +consumer_group = '<< CONSUMER GROUP >>' +eventhub_name = '<< NAME OF THE EVENT HUB >>' +storage_connection_str = '<< CONNECTION STRING FOR THE STORAGE >>' +container_name = '<>' + +async def on_event(partition_context, event): + # do something + await partition_context.update_checkpoint(event) # Or update_checkpoint every N events for better performance. + +async def receive(client): + await client.receive( + on_event=on_event, + starting_position="-1", # "-1" is from the beginning of the partition. + ) + +async def main(): + checkpoint_store = BlobCheckpointStore.from_connection_string(storage_connection_str, container_name) + client = EventHubConsumerClient.from_connection_string( + connection_str, + consumer_group, + eventhub_name=eventhub_name, + checkpoint_store=checkpoint_store, # For load balancing and checkpoint. Leave None for no load balancing + ) + async with client: + await receive(client) + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(main()) +``` + +### Use EventHubConsumerClient to work with IoT Hub + +You can use `EventHubConsumerClient` to work with IoT Hub as well. This is useful for receiving telemetry data of IoT Hub from the +linked EventHub. The associated connection string will not have send claims, hence sending events is not possible. + +Please notice that the connection string needs to be for an [Event Hub-compatible endpoint](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin), +e.g. "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name" + +There are two ways to get the Event Hubs compatible endpoint: +- Manually get the "Built-in endpoints" of the IoT Hub in Azure Portal and receive from it. +```python +from azure.eventhub import EventHubConsumerClient + +connection_str = 'Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name' +consumer_group = '<< CONSUMER GROUP >>' +client = EventHubConsumerClient.from_connection_string(connection_str, consumer_group) + +partition_ids = client.get_partition_ids() +``` +- Programmatically retrieve the built-in Event Hubs compatible endpoint. +Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub/samples/async_samples/iot_hub_connection_string_receive_async.py). + +## Troubleshooting + +### General + +The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptions + +- **AuthenticationError:** Failed to authenticate because of wrong address, SAS policy/key pair, SAS token or azure identity. +- **ConnectError:** Failed to connect to the EventHubs. The AuthenticationError is a type of ConnectError. +- **ConnectionLostError:** Lose connection after a connection has been built. +- **EventDataError:** The EventData to be sent fails data validation. For instance, this error is raised if you try to send an EventData that is already sent. +- **EventDataSendError:** The Eventhubs service responds with an error when an EventData is sent. +- **OperationTimeoutError:** EventHubConsumer.send() times out. +- **EventHubError:** All other Eventhubs related errors. It is also the root error class of all the errors described above. + +### Logging + +- Enable `azure.eventhub` logger to collect traces from the library. +- Enable `uamqp` logger to collect traces from the underlying uAMQP library. +- Enable AMQP frame level trace by setting `logging_enable=True` when creating the client. + +## Next steps + +### More sample code + +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/tree/e400440b2608537d78faad12544782381cca18f8/sdk/eventhub/azure-eventhub/samples) directory for detailed examples of how to use this library to send and receive events to/from Event Hubs. + +### Documentation + +Reference documentation is available [here](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html). + +### 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. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the +PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + + + diff --git a/docs-ref-services/legacy/face-index.md b/docs-ref-services/legacy/face-index.md new file mode 100644 index 00000000..feb31ed3 --- /dev/null +++ b/docs-ref-services/legacy/face-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Face](cognitiveservices-vision-face-readme.md)|[azure-cognitiveservices-vision-face](https://pypi.org/project/azure-cognitiveservices-vision-face)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/cognitiveservices/azure-cognitiveservices-vision-face)| diff --git a/docs-ref-services/legacy/face.md b/docs-ref-services/legacy/face.md new file mode 100644 index 00000000..227820f0 --- /dev/null +++ b/docs-ref-services/legacy/face.md @@ -0,0 +1,11 @@ +--- +title: Azure Face SDK for Python +description: Reference for Azure Face SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: face +--- +# Azure Face SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](face-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/graph-rbac-index.md b/docs-ref-services/legacy/graph-rbac-index.md new file mode 100644 index 00000000..7128c186 --- /dev/null +++ b/docs-ref-services/legacy/graph-rbac-index.md @@ -0,0 +1,3 @@ +| Reference | Package | Source | +|---|---|---| +|[Graph RBAC](graphrbac-readme.md)|[azure-graphrbac](https://pypi.org/project/azure-graphrbac)|[GitHub](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/graphrbac/azure-graphrbac)| diff --git a/docs-ref-services/legacy/graph-rbac.md b/docs-ref-services/legacy/graph-rbac.md new file mode 100644 index 00000000..6938003c --- /dev/null +++ b/docs-ref-services/legacy/graph-rbac.md @@ -0,0 +1,11 @@ +--- +title: Azure Graph RBAC SDK for Python +description: Reference for Azure Graph RBAC SDK for Python +ms.date: 03/26/2025 +ms.topic: reference +ms.devlang: python +ms.service: graphrbac +--- +# Azure Graph RBAC SDK for Python - legacy +## Packages - legacy +[!INCLUDE [packages](graph-rbac-index.md)] \ No newline at end of file diff --git a/docs-ref-services/legacy/graphrbac-readme.md b/docs-ref-services/legacy/graphrbac-readme.md new file mode 100644 index 00000000..4f44a0c6 --- /dev/null +++ b/docs-ref-services/legacy/graphrbac-readme.md @@ -0,0 +1,14 @@ +--- +title: +keywords: Azure, python, SDK, API, azure-graphrbac, graphrbac +ms.date: 10/31/2024 +ms.topic: reference +ms.devlang: python +ms.service: graphrbac +--- +# Microsoft Azure SDK for Python + +This package has been deprecated and will no longer be maintained after 10-31-2024. This package will only receive security fixes until 10-31-2024. Refer to the samples in the [MS Graph SDK for Python repo](https://github.com/microsoftgraph/msgraph-sdk-python) instead. + +For additional support, open a new issue in the [Issues](https://github.com/microsoftgraph/msgraph-sdk-python/issues) section of the MS Graph SDK for Python repo. + diff --git a/docs-ref-services/legacy/hdinsight.md b/docs-ref-services/legacy/hdinsight.md new file mode 100644 index 00000000..7679a2fb --- /dev/null +++ b/docs-ref-services/legacy/hdinsight.md @@ -0,0 +1,414 @@ +--- +title: Azure HDInsight SDK for Python +description: Reference for Azure HDInsight SDK for Python. The HDInsight SDK for Python provides classes and methods that allow you to manage your HDInsight clusters. +ms.date: 04/10/2019 +ms.topic: reference +ms.devlang: python +ms.service: hdinsight +--- +# HDInsight SDK for Python + +## Overview + +The HDInsight SDK for Python provides classes and methods that allow you to manage your HDInsight clusters. It includes operations to create, delete, update, list, resize, execute script actions, monitor, get properties of HDInsight clusters, and more. + +## Prerequisites + +* An Azure account. If you don't have one, [get a free trial](https://azure.microsoft.com/free/). +* [Python](https://www.python.org/downloads/) +* [pip](https://pypi.org/project/pip/#description) + +## SDK Installation + +The HDInsight SDK for Python can be found in the [Python Package Index](https://pypi.org/project/azure-mgmt-hdinsight/) and can be installed by running: + +`pip install azure-mgmt-hdinsight` + +## Authentication + +The SDK first needs to be authenticated with your Azure subscription. Follow the example below to create a service principal and use it to authenticate. After this is done, you will have an instance of an `HDInsightManagementClient`, which contains many methods (outlined in below sections) that can be used to perform management operations. + +> [!NOTE] +> There are other ways to authenticate besides the below example that could potentially be better suited for your needs. All methods are outlined here: [Authenticate with the Azure Management Libraries for Python](https://docs.microsoft.com/python/azure/python-sdk-azure-authenticate?view=azure-python) + +### Authentication Example Using a Service Principal + +First, login to [Azure Cloud Shell](https://shell.azure.com/bash). Verify you are currently using the subscription in which you want the service principal created. + +```azurecli-interactive +az account show +``` + +Your subscription information is displayed as JSON. + +```json +{ + "environmentName": "AzureCloud", + "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "isDefault": true, + "name": "XXXXXXX", + "state": "Enabled", + "tenantId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "user": { + "cloudShellID": true, + "name": "XXX@XXX.XXX", + "type": "user" + } +} +``` + +If you're not logged into the correct subscription, select the correct one by running: +```azurecli-interactive +az account set -s +``` + +> [!IMPORTANT] +> If you have not already registered the HDInsight Resource Provider by another method (such as by creating an HDInsight Cluster through the Azure Portal), you need to do this once before you can authenticate. This can be done from the [Azure Cloud Shell](https://shell.azure.com/bash) by running the following command: +>```azurecli-interactive +>az provider register --namespace Microsoft.HDInsight +>``` + +Next, choose a name for your service principal and create it with the following command: + +```azurecli-interactive +az ad sp create-for-rbac --name --role Contributor --sdk-auth +``` + +The service principal information is displayed as JSON. + +```json +{ + "clientId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "clientSecret": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "subscriptionId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "tenantId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", + "activeDirectoryEndpointUrl": "https://login.microsoftonline.com", + "resourceManagerEndpointUrl": "https://management.azure.com/", + "activeDirectoryGraphResourceId": "https://graph.windows.net/", + "sqlManagementEndpointUrl": "https://management.core.windows.net:8443/", + "galleryEndpointUrl": "https://gallery.azure.com/", + "managementEndpointUrl": "https://management.core.windows.net/" +} +``` +Copy the below Python snippet and fill in `TENANT_ID`, `CLIENT_ID`, `CLIENT_SECRET`, and `SUBSCRIPTION_ID` with the strings from the JSON that was returned after running the command to create the service principal. + +```python +from azure.mgmt.hdinsight import HDInsightManagementClient +from azure.common.credentials import ServicePrincipalCredentials +from azure.mgmt.hdinsight.models import * + +# Tenant ID for your Azure Subscription +TENANT_ID = '' +# Your Service Principal App Client ID +CLIENT_ID = '' +# Your Service Principal Client Secret +CLIENT_SECRET = '' +# Your Azure Subscription ID +SUBSCRIPTION_ID = '' + +credentials = ServicePrincipalCredentials( + client_id = CLIENT_ID, + secret = CLIENT_SECRET, + tenant = TENANT_ID +) + +client = HDInsightManagementClient(credentials, SUBSCRIPTION_ID) +``` + + +## Cluster Management + +> [!NOTE] +> This section assumes you have already authenticated and constructed an `HDInsightManagementClient` instance and store it in a variable called `client`. Instructions for authenticating and obtaining an `HDInsightManagementClient` can be found in the Authentication section above. + +### Create a Cluster + +A new cluster can be created by calling `client.clusters.create()`. + +#### Samples + +Code samples for creating several common types of HDInsight clusters are available: [HDInsight Python Samples](https://github.com/Azure-Samples/hdinsight-python-sdk-samples). + +#### Example + +This example demonstrates how to create a Spark cluster with 2 head nodes and 1 worker node. + +> [!NOTE] +> You first need to create a Resource Group and Storage Account, as explained below. If you have already created these, you can skip these steps. + +##### Creating a Resource Group + +You can create a resource group using the [Azure Cloud Shell](https://shell.azure.com/bash) by running +```azurecli-interactive +az group create -l --n +``` +##### Creating a Storage Account + +You can create a storage account using the [Azure Cloud Shell](https://shell.azure.com/bash) by running: +```azurecli-interactive +az storage account create -n -g -l --sku +``` +Now run the following command to get the key for your storage account (you will need this to create a cluster): +```azurecli-interactive +az storage account keys list -n +``` +--- +The below Python snippet creates a Spark cluster with 2 head nodes and 1 worker node. Fill in the blank variables as explained in the comments and feel free to change other parameters to suit your specific needs. + +```python +# The name for the cluster you are creating +cluster_name = "" +# The name of your existing Resource Group +resource_group_name = "" +# Choose a username +username = "" +# Choose a password +password = "" +# Replace <> with the name of your storage account +storage_account = "<>.blob.core.windows.net" +# Storage account key you obtained above +storage_account_key = "" +# Choose a region +location = "" +container = "default" + +params = ClusterCreateProperties( + cluster_version="3.6", + os_type=OSType.linux, + tier=Tier.standard, + cluster_definition=ClusterDefinition( + kind="spark", + configurations={ + "gateway": { + "restAuthCredential.enabled_credential": "True", + "restAuthCredential.username": username, + "restAuthCredential.password": password + } + } + ), + compute_profile=ComputeProfile( + roles=[ + Role( + name="headnode", + target_instance_count=2, + hardware_profile=HardwareProfile(vm_size="Large"), + os_profile=OsProfile( + linux_operating_system_profile=LinuxOperatingSystemProfile( + username=username, + password=password + ) + ) + ), + Role( + name="workernode", + target_instance_count=1, + hardware_profile=HardwareProfile(vm_size="Large"), + os_profile=OsProfile( + linux_operating_system_profile=LinuxOperatingSystemProfile( + username=username, + password=password + ) + ) + ) + ] + ), + storage_profile=StorageProfile( + storageaccounts=[StorageAccount( + name=storage_account, + key=storage_account_key, + container=container, + is_default=True + )] + ) +) + +client.clusters.create( + cluster_name=cluster_name, + resource_group_name=resource_group_name, + parameters=ClusterCreateParametersExtended( + location=location, + tags={}, + properties=params + )) +``` + +### Get Cluster Details + +To get properties for a given cluster: + +```python +client.clusters.get("", "") +``` + +#### Example + +You can use `get` to confirm that you have successfully created your cluster. + +```python +my_cluster = client.clusters.get("", "") +print(my_cluster) +``` + +The output should look like: + +```output +{'additional_properties': {}, 'id': '/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups//providers/Microsoft.HDInsight/clusters/', 'name': '', 'type': 'Microsoft.HDInsight/clusters', 'location': '', 'tags': {}, 'etag': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'properties': } +``` + +### List Clusters + +#### List Clusters Under The Subscription + +```python +client.clusters.list() +``` +#### List Clusters By Resource Group + +```python +client.clusters.list_by_resource_group("") +``` +> [!NOTE] +> Both `list()` and `list_by_resource_group()` return a `ClusterPaged` object. Calling `advance_page()` returns a list of clusters on that page and advances the `ClusterPaged` object to the next page. This can be repeated until a `StopIteration` exception is raised, indicating that there are no more pages. + +#### Example + +The following example prints the properties of all clusters for the current subscription: + +```python +clusters_paged = client.clusters.list() +while True: + try: + for cluster in clusters_paged.advance_page(): + print(cluster) + except StopIteration: + break +``` + +### Delete a Cluster + +To delete a cluster: + +```python +client.clusters.delete("", "") +``` + +### Update Cluster Tags + +You can update the tags of a given cluster like so: + +```python +client.clusters.update("", "", tags={}) +``` + +#### Example + +```python +client.clusters.update("", "", tags={"tag1Name" : "tag1Value", "tag2Name" : "tag2Value"}) +``` + +### Resize Cluster + +You can resize a given cluster's number of worker nodes by specifying a new size like so: + +```python +client.clusters.resize("", "", target_instance_count=) +``` + +## Cluster Monitoring + +The HDInsight Management SDK can also be used to manage monitoring on your clusters via the Operations Management Suite (OMS). + +### Enable OMS Monitoring + +> [!NOTE] +> To enable OMS Monitoring, you must have an existing Log Analytics workspace. If you have not already created one, you can learn how to do that here: [Create a Log Analytics workspace in the Azure portal](https://docs.microsoft.com/azure/log-analytics/log-analytics-quick-create-workspace). + +To enable OMS Monitoring on your cluster: + +```python +client.extension.enable_monitoring("", "", workspace_id="") +``` + +### View Status Of OMS Monitoring + +To get the status of OMS on your cluster: + +```python +client.extension.get_monitoring_status("", "") +``` + +## Script Actions + +HDInsight provides a configuration method called script actions that invokes custom scripts to customize the cluster. +> [!NOTE] +> More information on how to use script actions can be found here: [Customize Linux-based HDInsight clusters using script actions](https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux) + +### Execute Script Actions +To execute script actions on a given cluster: + +```python +script_action1 = RuntimeScriptAction(name="