| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| active-directory-b2c | Add Api Connector Token Enrichment | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/add-api-connector-token-enrichment.md | Title: Token enrichment - Azure Active Directory B2C description: Enrich tokens with claims from external identity data sources using APIs or outbound webhooks.- - -- - Last updated 01/17/2023 |
| active-directory-b2c | Conditional Access Identity Protection Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/conditional-access-identity-protection-overview.md | Title: Identity Protection and Conditional Access in Azure AD B2C description: Learn how Identity Protection gives you visibility into risky sign-ins and risk detections. Find out how and Conditional Access lets you enforce organizational policies based on risk events in your Azure AD B2C tenants.- Last updated 01/11/2024- - - #Customer intent: As an Azure AD B2C application owner, I want to enhance the security of my applications by using Identity Protection and Conditional Access, so that I can detect and respond to risky authentications and enforce organizational policies. |
| active-directory-b2c | Configure Tokens | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/configure-tokens.md | |
| active-directory-b2c | Configure User Input | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/configure-user-input.md | Title: Add user attributes and customize user input description: Learn how to customize user input and add user attributes to the sign-up or sign-in journey in Azure Active Directory B2C.- - - Last updated 12/13/2023- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Protection Investigate Risk | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-protection-investigate-risk.md | Title: Investigate risk with Azure Active Directory B2C Identity Protection description: Learn how to investigate risky users, and detections in Azure AD B2C Identity Protection- Last updated 09/16/2021- |
| active-directory-b2c | Identity Provider Adfs Saml | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-adfs-saml.md | Title: Add AD FS as a SAML identity provider by using custom policies description: Set up AD FS 2016 using the SAML protocol and custom policies in Azure Active Directory B2C- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Adfs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-adfs.md | Title: Add AD FS as an OpenID Connect identity provider by using custom policies description: Set up AD FS 2016 using the OpenID Connect protocol and custom policies in Azure Active Directory B2C- - - Last updated 06/08/2022- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Amazon | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-amazon.md | Title: Set up sign-up and sign-in with an Amazon account description: Provide sign-up and sign-in to customers with Amazon accounts in your applications using Azure Active Directory B2C.- - - - Last updated 09/16/2021 You need to store the client secret that you previously recorded in your Azure A ## Configure Amazon as an identity provider -To enable users to sign in using a Amazon account, you need to define the account as a claims provider. that Azure AD B2C can communicate with through an endpoint. The endpoint provides a set of claims that are used by Azure AD B2C to verify that a specific user has authenticated. +To enable users to sign in using an Amazon account, you need to define the account as a claims provider. that Azure AD B2C can communicate with through an endpoint. The endpoint provides a set of claims that are used by Azure AD B2C to verify that a specific user has authenticated. You can define an Amazon account as a claims provider by adding it to the **ClaimsProviders** element in the extension file of your policy. |
| active-directory-b2c | Identity Provider Apple Id | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-apple-id.md | Title: Set up sign-up and sign-in with an Apple ID description: Provide sign-up and sign-in to customers with Apple ID in your applications using Azure Active Directory B2C.- - - Last updated 11/02/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Facebook | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-facebook.md | Title: Set up sign-up and sign-in with a Facebook account description: Provide sign-up and sign-in to customers with Facebook accounts in your applications using Azure Active Directory B2C.- - - Last updated 03/10/2022- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Generic Saml Options | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-generic-saml-options.md | Title: Set sign-in with SAML identity provider options description: Configure sign-in SAML identity provider (IdP) options in Azure Active Directory B2C.- - - Last updated 03/20/2023- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Generic Saml | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-generic-saml.md | Title: Set up sign-up and sign-in with SAML identity provider description: Set up sign-up and sign-in with any SAML identity provider (IdP) in Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Github | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-github.md | |
| active-directory-b2c | Identity Provider Google | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-google.md | |
| active-directory-b2c | Identity Provider Linkedin | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-linkedin.md | Title: Set up sign-up and sign-in with a LinkedIn account description: Provide sign-up and sign-in to customers with LinkedIn accounts in your applications using Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Microsoft Account | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-microsoft-account.md | Title: Set up sign-up and sign-in with a Microsoft Account description: Provide sign-up and sign-in to customers with Microsoft Accounts in your applications using Azure Active Directory B2C.- - - Last updated 05/01/2023- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Ping One | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-ping-one.md | Title: Set up sign-up and sign-in with a PingOne account description: Provide sign-up and sign-in to customers with PingOne accounts in your applications using Azure Active Directory B2C.- - - Last updated 12/2/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Qq | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-qq.md | Title: Set up sign-up and sign-in with a QQ account using Azure Active Directory B2C description: Provide sign-up and sign-in to customers with QQ accounts in your applications using Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Salesforce Saml | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-salesforce-saml.md | Title: Set up sign-in with a Salesforce SAML provider by using SAML protocol description: Set up sign-in with a Salesforce SAML provider by using SAML protocol in Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Salesforce | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-salesforce.md | Title: Set up sign-up and sign-in with a Salesforce account description: Provide sign-up and sign-in to customers with Salesforce accounts in your applications using Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Twitter | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-twitter.md | Title: Set up sign-up and sign-in with a Twitter account description: Provide sign-up and sign-in to customers with Twitter accounts in your applications using Azure Active Directory B2C.- - - Last updated 07/20/2022- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Wechat | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-wechat.md | Title: Set up sign-up and sign-in with a WeChat account description: Provide sign-up and sign-in to customers with WeChat accounts in your applications using Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Identity Provider Weibo | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/identity-provider-weibo.md | Title: Set up sign-up and sign-in with a Weibo account description: Provide sign-up and sign-in to customers with Weibo accounts in your applications using Azure Active Directory B2C.- - - Last updated 09/16/2021- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Language Customization | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/language-customization.md | Title: Language customization in Azure Active Directory B2C description: Learn about customizing the language experience in your user flows in Azure Active Directory B2C.- - - Last updated 12/28/2022- zone_pivot_groups: b2c-policy-type |
| active-directory-b2c | Session Behavior | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/session-behavior.md | Title: Configure session behavior - Azure Active Directory B2C description: Learn how to configure session behavior in Azure Active Directory B2C.- - - Last updated 01/11/2024- zone_pivot_groups: b2c-policy-type - #Customer intent: As a developer configuring session behavior in Azure Active Directory B2C, I want to understand the different types of single sign-on sessions (Azure AD B2C session, federated identity provider session, application session) and how to configure their behavior, so that I can implement the most appropriate SSO method for my policy. |
| active-directory-b2c | Troubleshoot With Application Insights | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/troubleshoot-with-application-insights.md | Title: Troubleshoot custom policies with Application Insights description: How to set up Application Insights to trace the execution of your custom policies.- - - Last updated 01/11/2024- zone_pivot_groups: b2c-policy-type - #Customer intent: As a developer working with Azure Active Directory B2C, I want to collect logs from my custom policies using Application Insights, so that I can diagnose and troubleshoot any problems that may occur. |
| active-directory-b2c | Tutorial Create User Flows | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/tutorial-create-user-flows.md | |
| active-directory-b2c | Tutorial Register Applications | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/active-directory-b2c/tutorial-register-applications.md | |
| ai-services | Batch Inference | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/batch-inference.md | |
| ai-services | Create Resource | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/create-resource.md | |
| ai-services | Deploy Anomaly Detection On Container Instances | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/deploy-anomaly-detection-on-container-instances.md | |
| ai-services | Deploy Anomaly Detection On Iot Edge | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/deploy-anomaly-detection-on-iot-edge.md | |
| ai-services | Identify Anomalies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/identify-anomalies.md | |
| ai-services | Postman | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/postman.md | |
| ai-services | Prepare Data | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/prepare-data.md | |
| ai-services | Streaming Inference | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/streaming-inference.md | |
| ai-services | Train Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/How-to/train-model.md | |
| ai-services | Anomaly Detector Container Configuration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/anomaly-detector-container-configuration.md | |
| ai-services | Anomaly Detector Container Howto | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/anomaly-detector-container-howto.md | |
| ai-services | Anomaly Detection Best Practices | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/concepts/anomaly-detection-best-practices.md | |
| ai-services | Best Practices Multivariate | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/concepts/best-practices-multivariate.md | |
| ai-services | Multivariate Architecture | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/concepts/multivariate-architecture.md | |
| ai-services | Troubleshoot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/concepts/troubleshoot.md | |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/overview.md | |
| ai-services | Client Libraries Multivariate | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/quickstarts/client-libraries-multivariate.md | |
| ai-services | Client Libraries | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/quickstarts/client-libraries.md | |
| ai-services | Regions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/regions.md | |
| ai-services | Service Limits | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/service-limits.md | |
| ai-services | Azure Data Explorer | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/tutorials/azure-data-explorer.md | |
| ai-services | Batch Anomaly Detection Powerbi | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/tutorials/batch-anomaly-detection-powerbi.md | |
| ai-services | Multivariate Anomaly Detection Synapse | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/tutorials/multivariate-anomaly-detection-synapse.md | |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/Anomaly-Detector/whats-new.md | |
| ai-services | App Schema Definition | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/app-schema-definition.md | |
| ai-services | Choose Natural Language Processing Service | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/choose-natural-language-processing-service.md | |
| ai-services | Client Libraries Rest Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/client-libraries-rest-api.md | Title: "Quickstart: Language Understanding (LUIS) SDK client libraries and REST API" description: Create and query a LUIS app with the LUIS SDK client libraries and REST API. Previously updated : 03/07/2022 Last updated : 01/19/2024 |
| ai-services | Application Design | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/concepts/application-design.md | |
| ai-services | Entities | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/concepts/entities.md | |
| ai-services | Intents | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/concepts/intents.md | |
| ai-services | Patterns Features | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/concepts/patterns-features.md | |
| ai-services | Utterances | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/concepts/utterances.md | |
| ai-services | Data Collection | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/data-collection.md | |
| ai-services | Developer Reference Resource | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/developer-reference-resource.md | |
| ai-services | Encrypt Data At Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/encrypt-data-at-rest.md | |
| ai-services | Faq | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/faq.md | |
| ai-services | Get Started Get Model Rest Apis | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/get-started-get-model-rest-apis.md | |
| ai-services | How To Application Settings Portal | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to-application-settings-portal.md | |
| ai-services | Entities | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/entities.md | |
| ai-services | Improve Application | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/improve-application.md | |
| ai-services | Intents | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/intents.md | |
| ai-services | Label Utterances | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/label-utterances.md | |
| ai-services | Orchestration Projects | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/orchestration-projects.md | |
| ai-services | Publish | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/publish.md | |
| ai-services | Sign In | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/sign-in.md | |
| ai-services | Train Test | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/how-to/train-test.md | |
| ai-services | Howto Add Prebuilt Models | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/howto-add-prebuilt-models.md | |
| ai-services | Luis Concept Data Alteration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-data-alteration.md | |
| ai-services | Luis Concept Data Conversion | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-data-conversion.md | |
| ai-services | Luis Concept Data Extraction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-data-extraction.md | |
| ai-services | Luis Concept Data Storage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-data-storage.md | |
| ai-services | Luis Concept Devops Automation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-devops-automation.md | description: How to implement CI/CD workflows for DevOps for Language Understand Previously updated : 06/01/2021 Last updated : 01/19/2024 ms. |
| ai-services | Luis Concept Devops Sourcecontrol | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-devops-sourcecontrol.md | description: How to maintain your Language Understanding (LUIS) app under source Previously updated : 06/14/2022 Last updated : 01/19/2024 |
| ai-services | Luis Concept Devops Testing | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-devops-testing.md | |
| ai-services | Luis Concept Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-model.md | |
| ai-services | Luis Concept Prebuilt Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-prebuilt-model.md | |
| ai-services | Luis Concept Prediction Score | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-concept-prediction-score.md | |
| ai-services | Luis Container Configuration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-container-configuration.md | |
| ai-services | Luis Container Howto | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-container-howto.md | |
| ai-services | Luis Container Limitations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-container-limitations.md | |
| ai-services | Luis Get Started Create App | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-get-started-create-app.md | |
| ai-services | Luis Get Started Get Intent From Browser | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-get-started-get-intent-from-browser.md | |
| ai-services | Luis Glossary | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-glossary.md | description: The glossary explains terms that you might encounter as you work wi Previously updated : 03/21/2022 Last updated : 01/19/2024 |
| ai-services | Luis How To Azure Subscription | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-azure-subscription.md | |
| ai-services | Luis How To Batch Test | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-batch-test.md | |
| ai-services | Luis How To Collaborate | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-collaborate.md | |
| ai-services | Luis How To Manage Versions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-manage-versions.md | |
| ai-services | Luis How To Model Intent Pattern | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-model-intent-pattern.md | |
| ai-services | Luis How To Use Dashboard | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-how-to-use-dashboard.md | |
| ai-services | Luis Language Support | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-language-support.md | |
| ai-services | Luis Limits | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-limits.md | |
| ai-services | Luis Migration Api V1 To V2 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-migration-api-v1-to-v2.md | |
| ai-services | Luis Migration Api V3 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-migration-api-v3.md | ms. Previously updated : 05/28/2021 Last updated : 01/19/2024 |
| ai-services | Luis Migration Authoring Entities | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-migration-authoring-entities.md | |
| ai-services | Luis Migration Authoring | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-migration-authoring.md | |
| ai-services | Luis Reference Application Settings | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-application-settings.md | |
| ai-services | Luis Reference Prebuilt Age | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-age.md | |
| ai-services | Luis Reference Prebuilt Currency | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-currency.md | |
| ai-services | Luis Reference Prebuilt Datetimev2 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-datetimev2.md | |
| ai-services | Luis Reference Prebuilt Deprecated | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-deprecated.md | |
| ai-services | Luis Reference Prebuilt Dimension | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-dimension.md | |
| ai-services | Luis Reference Prebuilt Domains | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-domains.md | |
| ai-services | Luis Reference Prebuilt Email | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-email.md | |
| ai-services | Luis Reference Prebuilt Entities | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-entities.md | |
| ai-services | Luis Reference Prebuilt Geographyv2 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-geographyV2.md | |
| ai-services | Luis Reference Prebuilt Keyphrase | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-keyphrase.md | |
| ai-services | Luis Reference Prebuilt Number | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-number.md | |
| ai-services | Luis Reference Prebuilt Ordinal V2 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-ordinal-v2.md | |
| ai-services | Luis Reference Prebuilt Ordinal | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-ordinal.md | |
| ai-services | Luis Reference Prebuilt Percentage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-percentage.md | |
| ai-services | Luis Reference Prebuilt Person | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-person.md | |
| ai-services | Luis Reference Prebuilt Phonenumber | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-phonenumber.md | |
| ai-services | Luis Reference Prebuilt Sentiment | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-sentiment.md | |
| ai-services | Luis Reference Prebuilt Temperature | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-temperature.md | |
| ai-services | Luis Reference Prebuilt Url | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-prebuilt-url.md | |
| ai-services | Luis Reference Regions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-regions.md | |
| ai-services | Luis Reference Response Codes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-reference-response-codes.md | |
| ai-services | Luis Traffic Manager | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-traffic-manager.md | |
| ai-services | Luis Tutorial Bing Spellcheck | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-tutorial-bing-spellcheck.md | |
| ai-services | Luis Tutorial Node Import Utterances Csv | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-tutorial-node-import-utterances-csv.md | |
| ai-services | Luis User Privacy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/luis-user-privacy.md | |
| ai-services | Migrate From Composite Entity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/migrate-from-composite-entity.md | |
| ai-services | Reference Entity List | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-entity-list.md | ms. Previously updated : 01/05/2022 Last updated : 01/19/2024 # List entity |
| ai-services | Reference Entity Machine Learned Entity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-entity-machine-learned-entity.md | |
| ai-services | Reference Entity Pattern Any | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-entity-pattern-any.md | |
| ai-services | Reference Entity Regular Expression | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-entity-regular-expression.md | |
| ai-services | Reference Entity Simple | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-entity-simple.md | |
| ai-services | Reference Pattern Syntax | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/reference-pattern-syntax.md | |
| ai-services | Role Based Access Control | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/role-based-access-control.md | |
| ai-services | Schema Change Prediction Runtime | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/schema-change-prediction-runtime.md | |
| ai-services | Build Decomposable Application | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/tutorial/build-decomposable-application.md | |
| ai-services | What Is Luis | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/what-is-luis.md | keywords: Azure, artificial intelligence, ai, natural language processing, nlp, Previously updated : 07/19/2022 Last updated : 01/19/2024 |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/LUIS/whats-new.md | |
| ai-services | Find Similar Faces | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/computer-vision/how-to/find-similar-faces.md | |
| ai-services | Video Retrieval | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/computer-vision/how-to/video-retrieval.md | |
| ai-services | Reference Video Search | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/computer-vision/reference-video-search.md | |
| ai-services | Api Reference | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/api-reference.md | |
| ai-services | Client Libraries | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/client-libraries.md | |
| ai-services | Encrypt Data At Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/encrypt-data-at-rest.md | |
| ai-services | Export Delete Data | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/export-delete-data.md | |
| ai-services | Image Lists Quickstart Dotnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/image-lists-quickstart-dotnet.md | |
| ai-services | Image Moderation Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/image-moderation-api.md | |
| ai-services | Language Support | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/language-support.md | |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/overview.md | |
| ai-services | Samples Dotnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/samples-dotnet.md | |
| ai-services | Samples Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/samples-rest.md | |
| ai-services | Term Lists Quickstart Dotnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/term-lists-quickstart-dotnet.md | |
| ai-services | Text Moderation Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/text-moderation-api.md | |
| ai-services | Try Image Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/try-image-api.md | |
| ai-services | Try Image List Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/try-image-list-api.md | |
| ai-services | Try Terms List Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/try-terms-list-api.md | |
| ai-services | Try Text Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/try-text-api.md | |
| ai-services | Video Moderation Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-moderator/video-moderation-api.md | |
| ai-services | Harm Categories | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/concepts/harm-categories.md | -keywords: |
| ai-services | Jailbreak Detection | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/concepts/jailbreak-detection.md | -keywords: |
| ai-services | Use Blocklist | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/how-to/use-blocklist.md | -keywords: |
| ai-services | Quickstart Image | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/quickstart-image.md | -keywords: # QuickStart: Analyze image content |
| ai-services | Quickstart Jailbreak | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/quickstart-jailbreak.md | -keywords: # Quickstart: Detect jailbreak risk (preview) |
| ai-services | Quickstart Protected Material | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/quickstart-protected-material.md | -keywords: # Quickstart: Detect protected material (preview) |
| ai-services | Quickstart Text | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/content-safety/quickstart-text.md | -keywords: # QuickStart: Analyze text content |
| ai-services | Compare Alternatives | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/custom-vision-service/concepts/compare-alternatives.md | |
| ai-services | Choose Model Feature | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/choose-model-feature.md | The following decision charts highlight the features of each **Document Intellig |**Structured, semi-structured, and unstructured documents**.|● Structured → surveys</br>● Semi-structured → invoices</br>● Unstructured → letters| [**Custom neural model**](concept-custom-neural.md)| |**A collection of several models each trained on similar-type documents.** |● Supply purchase orders</br>● Equipment purchase orders</br>● Furniture purchase orders</br> **All composed into a single model**.| [**Composed custom model**](concept-composed-models.md)| +## Custom classification model ++| Training set | Example documents | Your best solution | +| --|--|-| +|**At least two different types of documents**. |Forms, letters, or documents | [**Custom classification model**](./concept-custom-classifier.md)| +++ ## Next steps * [Learn how to process your own forms and documents](quickstarts/try-document-intelligence-studio.md) with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) |
| ai-services | Concept Add On Capabilities | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-add-on-capabilities.md | monikerRange: '>=doc-intel-3.1.0' :::moniker range=">=doc-intel-3.1.0" -Document Intelligence supports more sophisticated and modular analysis capabilities. Use the add-on features to extend the results to include more features extracted from your documents. Some add-on features incur an extra cost. These optional features can be enabled and disabled depending on the scenario of the document extraction. The following add-on capabilities are available for `2023-07-31 (GA)` and later releases: +Document Intelligence supports more sophisticated and modular analysis capabilities. Use the add-on features to extend the results to include more features extracted from your documents. Some add-on features incur an extra cost. These optional features can be enabled and disabled depending on the scenario of the document extraction. To enable a feature, add the associated feature name to the `features` query string property. You can enable more than one add-on feature on a request by providing a comma-separated list of features. The following add-on capabilities are available for `2023-07-31 (GA)` and later releases. * [`ocrHighResolution`](#high-resolution-extraction) Document Intelligence supports more sophisticated and modular analysis capabilit > [!NOTE] >-> Not all add-on capabilities are supported by all models. For more information, *see* [model data extraction](concept-model-overview.md#model-data-extraction). +> Not all add-on capabilities are supported by all models. For more information, *see* [model data extraction](concept-model-overview.md#analysis-features). The following add-on capability is available for `2023-10-31-preview` and later releases: * [`keyValuePairs`](#key-value-pairs)+ * [`queryFields`](#query-fields) > [!NOTE] The following add-on capability is available for `2023-10-31-preview` and later ::: moniker-end +|Add-on Capability| Add-On/Free|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)| +|-|--||--||| +|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a| +|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a| +|High resolution extraction|Add-On| ✔️| ✔️| n/a| n/a| +|Barcode extraction|Free| ✔️| ✔️| n/a| n/a| +|Language detection|Free| ✔️| ✔️| n/a| n/a| +|Key value pairs|Free| ✔️|n/a|n/a| n/a| +|Query fields|Add-On*| ✔️|n/a|n/a| n/a| +++Add-On* - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details. + ## High resolution extraction The task of recognizing small text from large-size documents, like engineering drawings, is a challenge. Often the text is mixed with other graphical elements and has varying fonts, sizes and orientations. Moreover, the text can be broken into separate parts or connected with other symbols. Document Intelligence now supports extracting content from these types of documents with the `ocr.highResolution` capability. You get improved quality of content extraction from A1/A2/A3 documents by enabling this add-on capability. +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=ocrHighResolution +``` ++```REST +https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?api-version=2023-07-31&features=ocrHighResolution +``` + ## Formula extraction The `ocr.formula` capability extracts all identified formulas, such as mathematical equations, in the `formulas` collection as a top level object under `content`. Inside `content`, detected formulas are represented as `:formula:`. Each entry in this collection represents a formula that includes the formula type as `inline` or `display`, and its LaTeX representation as `value` along with its `polygon` coordinates. Initially, formulas appear at the end of each page. The `ocr.formula` capability extracts all identified formulas, such as mathemati ] ``` + ### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=formulas +``` ++```REST +https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?api-version=2023-07-31&features=formulas +``` + ## Font property extraction The `ocr.font` capability extracts all font properties of text extracted in the `styles` collection as a top-level object under `content`. Each style object specifies a single font property, the text span it applies to, and its corresponding confidence score. The existing style property is extended with more font properties such as `similarFontFamily` for the font of the text, `fontStyle` for styles such as italic and normal, `fontWeight` for bold or normal, `color` for color of the text, and `backgroundColor` for color of the text bounding box. The `ocr.font` capability extracts all font properties of text extracted in the ] ``` +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=styleFont +``` ++```REST +https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?api-version=2023-07-31&features=styleFont +``` + ## Barcode property extraction The `ocr.barcode` capability extracts all identified barcodes in the `barcodes` collection as a top level object under `content`. Inside the `content`, detected barcodes are represented as `:barcode:`. Each entry in this collection represents a barcode and includes the barcode type as `kind` and the embedded barcode content as `value` along with its `polygon` coordinates. Initially, barcodes appear at the end of each page. The `confidence` is hard-coded for as 1. The `ocr.barcode` capability extracts all identified barcodes in the `barcodes` | `ITF` |:::image type="content" source="media/barcodes/interleaved-two-five.png" alt-text="Screenshot of the interleaved-two-of-five barcode (ITF).":::| | `Data Matrix` |:::image type="content" source="media/barcodes/datamatrix.gif" alt-text="Screenshot of the Data Matrix.":::| +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=barcodes +``` ++```REST +https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?api-version=2023-07-31&features=barcodes +``` + ## Language detection -It predicts the detected primary language for each text line along with the `confidence` in the `languages` collection under `analyzeResult`. +Adding the `languages` feature to the `analyzeResult` request predicts the detected primary language for each text line along with the `confidence` in the `languages` collection under `analyzeResult`. ```json "languages": [ It predicts the detected primary language for each text line along with the `con ] ``` +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=languages +``` ++```REST +https://{your resource}.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?api-version=2023-07-31&features=languages +``` + :::moniker range="doc-intel-4.0.0" ## Key-value Pairs +In earlier API versions, the prebuilt-document model extracted key-value pairs from forms and documents. With the addition of the `keyValuePairs` feature to prebuilt-layout, the layout model now produces the same results. + Key-value pairs are specific spans within the document that identify a label or key and its associated response or value. In a structured form, these pairs could be the label and the value the user entered for that field. In an unstructured document, they could be the date a contract was executed on based on the text in a paragraph. The AI model is trained to extract identifiable keys and values based on a wide variety of document types, formats, and structures. Keys can also exist in isolation when the model detects that a key exists, with no associated value or when processing optional fields. For example, a middle name field can be left blank on a form in some instances. Key-value pairs are spans of text contained in the document. For documents where the same value is described in different ways, for example, customer/user, the associated key is either customer or user (based on context). +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=keyValuePairs +``` + ## Query Fields +Query fields are an add-on capability to extend the schema extracted from any prebuilt model or define a specific key name when the key name is variable. To use query fields, set the features to `queryFields` and provide a comma-separated list of field names in the `queryFields` property. + * Document Intelligence now supports query field extractions. With query field extraction, you can add fields to the extraction process using a query request without the need for added training. * Use query fields when you need to extend the schema of a prebuilt or custom model or need to extract a few fields with the output of layout. For query field extraction, specify the fields you want to extract and Document * In addition to the query fields, the response includes text, tables, selection marks, and other relevant data. +### REST API ++```REST +https://{your resource}.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=queryFields&queryFields=TERMS +``` + :::moniker-end ## Next steps For query field extraction, specify the fields you want to extract and Document > [!div class="nextstepaction"] > Learn more: > [**Read model**](concept-read.md) [**Layout model**](concept-layout.md).++> [!div class="nextstepaction"] +> SDK samples: +> [**python**](/python/api/overview/azure/ai-documentintelligence-readme). + |
| ai-services | Concept Composed Models | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-composed-models.md | -With composed models, you can assign multiple custom models to a composed model called with a single model ID. It's useful when you've trained several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction. +With composed models, you can assign multiple custom models to a composed model called with a single model ID. It's useful when you train several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction. * ```Custom form``` and ```Custom template``` models can be composed together into a single composed model. With the introduction of [**custom classification models**](./concept-custom-cla ### Composed model compatibility -|Custom model type|Models trained with v2.1 and v2.0 | Custom template models v3.0 |Custom neural models v3.0 (preview) |Custom neural models 3.0 (GA)| +|Custom model type|Models trained with v2.1 and v2.0 | Custom template models v3.0 |Custom neural models 3.0|Custom Neural models v3.1| |--|--|--|--|--| |**Models trained with version 2.1 and v2.0** |Supported|Supported|Not Supported|Not Supported|-|**Custom template models v3.0** |Supported|Supported|Not Supported|NotSupported| -|**Custom template models v3.0 (GA)** |Not Supported|Not Supported|Supported|Not Supported| -|**Custom neural models v3.0 (preview)**|Not Supported|Not Supported|Supported|Not Supported| -|**Custom Neural models v3.0 (GA)**|Not Supported|Not Supported|Not Supported|Supported| +|**Custom template models v3.0** |Supported|Supported|Not Supported|Not Supported| +|**Custom template models v3.0** |Not Supported|Not Supported|Not Supported|Not Supported| +|**Custom template models v3.1** |Not Supported|Not Supported|Not Supported|Not Supported| +|**Custom Neural models v3.0**|Not Supported|Not Supported|Supported|Supported| +|**Custom Neural models v3.1**|Not Supported|Not Supported|Supported|Supported| + * To compose a model trained with a prior version of the API (v2.1 or earlier), train a model with the v3.0 API using the same labeled dataset. That addition ensures that the v2.1 model can be composed with other models. |
| ai-services | Concept Custom Classifier | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-custom-classifier.md | A custom classification model can replace [a composed model](concept-composed-mo ## Language support Classification models currently only support English language documents.++Classification models can now be trained on documents of different languages. See [supported languages](language-support-custom.md) for a complete list. ## Input requirements -* For best results, provide one clear photo or high-quality scan per document. +* For best results, provide five clear photos or high-quality scans per document type. * Supported file formats: Classification models currently only support English language documents. |Prebuilt | Γ£ö | Γ£ö | | |Custom | Γ£ö | Γ£ö | | - ✱ Microsoft Office files are currently not supported for other models or versions. + * For PDF and TIFF, up to 2000 pages can be processed (with a free tier subscription, only the first two pages are processed). Classification models currently only support English language documents. * For custom classification model training, the total size of training data is `1GB` with a maximum of 10,000 pages. +## Document splitting ++When you have more than one document in a file, the classifier can identify the different document types contained within the input file. The classifier response contains the page ranges for each of the identified document types contained within a file. This response can include multiple instances of the same document type. ++The analyze operation now includes a `splitMode` property that gives you granular control over the splitting behavior. ++* To treat the entire input file as a single document for classification set the splitMode to `none`. When you do so, the service returns just one class for the entire input file. +* To classify each page of the input file, set the splitMode to `perPage`. The service attempts to classify each page as an individual document. +* Set the splitMode to `auto` and the service identifies the documents and associated page ranges. + ## Best practices Custom classification models require a minimum of five samples per class to train. If the classes are similar, adding extra training samples improves model accuracy. +The classifier attempts to assign each document to one of the classes, if you expect the model to see document types not in the classes that are part of the training dataset, you should plan to set a threshold on the classification score or add a few representative samples of the document types to an ```"other"``` class. Adding an ```"other"``` class ensures that unneeded documents don't impact your classifier quality. + ## Training a model -Custom classification models are supported by **v4.0:2023-10-31-preview** and **v3.1:2023-07-31 (GA)** APIs. [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) provides a no-code user interface to interactively train a custom classifier. +Custom classification models are supported by **v4.0:2023-10-31-preview** and **v3.1:2023-07-31 (GA)** APIs. [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) provides a no-code user interface to interactively train a custom classifier. Follow the [how to guide](how-to-guides/build-a-custom-classifier.md) to get started. When using the REST API, if you organize your documents by folders, you can use the ```azureBlobSource``` property of the request to train a classification model. https://{endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-07- "car-maint": { "azureBlobSource": { "containerUrl": "SAS URL to container",- "prefix": "sample1/car-maint/" + "prefix": "{path to dataset root}/car-maint/" } }, "cc-auth": { "azureBlobSource": { "containerUrl": "SAS URL to container",- "prefix": "sample1/cc-auth/" + "prefix": "{path to dataset root}/cc-auth/" } }, "deed-of-trust": { "azureBlobSource": { "containerUrl": "SAS URL to container",- "prefix": "sample1/deed-of-trust/" + "prefix": "{path to dataset root}/deed-of-trust/" } } } Alternatively, if you have a flat list of files or only plan to use a few select "car-maint": { "azureBlobFileListSource": { "containerUrl": "SAS URL to container",- "fileList": "sample1/car-maint.jsonl" + "fileList": "{path to dataset root}/car-maint.jsonl" } }, "cc-auth": { "azureBlobFileListSource": { "containerUrl": "SAS URL to container",- "fileList": "sample1/cc-auth.jsonl" + "fileList": "{path to dataset root}/cc-auth.jsonl" } }, "deed-of-trust": { "azureBlobFileListSource": { "containerUrl": "SAS URL to container",- "fileList": "sample1/deed-of-trust.jsonl" + "fileList": "{path to dataset root}/deed-of-trust.jsonl" } } } Alternatively, if you have a flat list of files or only plan to use a few select ``` -File list `car-maint.jsonl` contains the following files. +As an example, the file list `car-maint.jsonl` contains the following files. ```json-{"file":"sample1/car-maint/Commercial Motor Vehicle - Adatum.pdf"} -{"file":"sample1/car-maint/Commercial Motor Vehicle - Fincher.pdf"} -{"file":"sample1/car-maint/Commercial Motor Vehicle - Lamna.pdf"} -{"file":"sample1/car-maint/Commercial Motor Vehicle - Liberty.pdf"} -{"file":"sample1/car-maint/Commercial Motor Vehicle - Trey.pdf"} +{"file":"classifier/car-maint/Commercial Motor Vehicle - Adatum.pdf"} +{"file":"classifier/car-maint/Commercial Motor Vehicle - Fincher.pdf"} +{"file":"classifier/car-maint/Commercial Motor Vehicle - Lamna.pdf"} +{"file":"classifier/car-maint/Commercial Motor Vehicle - Liberty.pdf"} +{"file":"classifier/car-maint/Commercial Motor Vehicle - Trey.pdf"} ``` ## Model response Analyze an input file with the document classification model :::moniker range="doc-intel-4.0.0" ```rest-https://{endpoint}/documentintelligence/documentClassifiers:build?api-version=2023-10-31-preview +https://{endpoint}/documentintelligence/documentClassifiers/{classifier}:analyze?api-version=2023-10-31-preview ``` :::moniker-end |
| ai-services | Concept Custom Label | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-custom-label.md | Tabular fields support **cross page tables** by default. To label a table that s Tabular fields are also useful when extracting repeating information within a document that isn't recognized as a table. For example, a repeating section of work experiences in a resume can be labeled and extracted as a tabular field. +> [!NOTE] +> Table field when labeled are extracted as part of the `documents` section of the response. The response also contains a `tables` section which contains the tables extracted from the document by the layout model. If you have labeled a field as a table, look for the field in the documents section of the response. + ## Labeling guidelines * **Labeling values is required.** Don't include the surrounding text. For example when labeling a checkbox, name the field to indicate the check box selection for example ```selectionYes``` and ```selectionNo``` rather than labeling the yes or no text in the document. |
| ai-services | Concept Document Intelligence Studio | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-document-intelligence-studio.md | monikerRange: '>=doc-intel-3.0.0' **This content applies to:**  **v3.0 (GA)** | **Latest versions:**  [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true)  [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true) ::: moniker-end -[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md) to get started analyzing documents with pretrained models. Build custom template models and reference the models in your applications using the [Python SDK v3.0](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and other quickstarts. +[Document Intelligence Studio](https://documentintelligence.ai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the Document Intelligence Studio to: ++* Learn more about the different capabilities in Document Intelligence. +* Use your Document Intelligence resource to test models on sample documents or upload your own documents. +* Experiment with different add-on and preview features to adapt the output to your needs. +* Train custom classification models to classify documents. +* Train custom extraction models to extract fields from documents. +* Get sample code for the language-specific SDKs to integrate into your applications. ++Use the [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md) to get started analyzing documents with document analysis or prebuilt models. Build custom models and reference the models in your applications using one of the [language specific SDKs](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and other quickstarts. The following image shows the landing page for Document Intelligence Studio. :::image border="true" type="content" source="media/studio/welcome-to-studio.png" alt-text="Document Intelligence Studio Homepage"::: +## Getting started ++If you're visiting the Studio for the first time, follow the [getting started guide](studio-overview.md#get-started-using-document-intelligence-studio) to set up the Studio for use. + ## Analyze options * Document Intelligence supports sophisticated analysis capabilities. The Studio allows one entry point (Analyze options button) for configuring the add-on capabilities with ease. The following image shows the landing page for Document Intelligence Studio. ## Document Intelligence model support -* **Read**: Try out Document Intelligence's Read feature to extract text lines, words, detected languages, and handwritten style if detected. Start with the [Studio Read feature](https://formrecognizer.appliedai.azure.com/studio/read). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Read overview](concept-read.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true). +* **Read**: Try out Document Intelligence's Read feature to extract text lines, words, detected languages, and handwritten style if detected. Start with the [Studio Read feature](https://documentintelligence.ai.azure.com/studio/read). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Read overview](concept-read.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true). -* **Layout**: Try out Document Intelligence's Layout feature to extract text, tables, selection marks, and structure information. Start with the [Studio Layout feature](https://formrecognizer.appliedai.azure.com/studio/layout). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Layout overview](concept-layout.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model). +* **Layout**: Try out Document Intelligence's Layout feature to extract text, tables, selection marks, and structure information. Start with the [Studio Layout feature](https://documentintelligence.ai.azure.com/studio/layout). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Layout overview](concept-layout.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model). -* **Prebuilt models**: Document Intelligence's prebuilt models enable you to add intelligent document processing to your apps and flows without having to train and build your own models. As an example, start with the [Studio Invoice feature](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=invoice). Explore with sample documents and your documents. Use the interactive visualization, extracted fields list, and JSON output to understand how the feature works. See the [Models overview](concept-model-overview.md) to learn more and get started with the [Python SDK quickstart for Prebuilt Invoice](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#prebuilt-model). +* **Prebuilt models**: Document Intelligence's prebuilt models enable you to add intelligent document processing to your apps and flows without having to train and build your own models. As an example, start with the [Studio Invoice feature](https://documentintelligence.ai.azure.com/studio/prebuilt?formType=invoice). Explore with sample documents and your documents. Use the interactive visualization, extracted fields list, and JSON output to understand how the feature works. See the [Models overview](concept-model-overview.md) to learn more and get started with the [Python SDK quickstart for Prebuilt Invoice](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#prebuilt-model). -* **Custom extraction models**: Document Intelligence's custom models enable you to extract fields and values from models trained with your data, tailored to your forms and documents. Create standalone custom models or combine two or more custom models to create a composed model to extract data from multiple form types. Start with the [Studio Custom models feature](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects). Use the help wizard, labeling interface, training step, and visualizations to understand how the feature works. Test the custom model with your sample documents and iterate to improve the model. See the [Custom models overview](concept-custom.md) to learn more. +* **Custom extraction models**: Document Intelligence's custom models enable you to extract fields and values from models trained with your data, tailored to your forms and documents. Create standalone custom models or combine two or more custom models to create a composed model to extract data from multiple form types. Start with the [Studio Custom models feature](https://documentintelligence.ai.azure.com/studio/custommodel/projects). Use the help wizard, labeling interface, training step, and visualizations to understand how the feature works. Test the custom model with your sample documents and iterate to improve the model. See the [Custom models overview](concept-custom.md) to learn more. * **Custom classification models**: Document classification is a new scenario supported by Document Intelligence. the document classifier API supports classification and splitting scenarios. Train a classification model to identify the different types of documents your application supports. The input file for the classification model can contain multiple documents and classifies each document within an associated page range. See [custom classification models](concept-custom-classifier.md) to learn more. The following image shows the landing page for Document Intelligence Studio. ## Next steps -* Visit the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio) to begin using the models and features. +* Visit the [Document Intelligence Studio](https://documentintelligence.ai.azure.com/) to begin using the models and features. * Get started with our [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md). |
| ai-services | Concept Model Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-model-overview.md | -|Model|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)| -|-|--||--|| -|[Add-on capabilities](concept-add-on-capabilities.md) | ✔️| ✔️| n/a| n/a| -|[Business card](concept-business-card.md) | deprecated|✔️|✔️|✔️ | -|[Contract](concept-contract.md) | ✔️| ✔️| n/a| n/a| -|[Custom classifier](concept-custom-classifier.md) | ✔️| ✔️| n/a| n/a| -|[Custom composed](concept-composed-models.md) | ✔️| ✔️| ✔️| ✔️| -|[Custom neural](concept-custom-neural.md) | ✔️| ✔️| ✔️| n/a| -|[Custom template](concept-custom-template.md) | ✔️| ✔️| ✔️| ✔️| -|[General document](concept-general-document.md) | deprecated| ✔️| ✔️| n/a| -|[Health insurance card](concept-health-insurance-card.md)| ✔️| ✔️| ✔️| n/a| -|[ID document](concept-id-document.md) | ✔️| ✔️| ✔️| ✔️| -|[Invoice](concept-invoice.md) | ✔️| ✔️| ✔️| ✔️| -|[Layout](concept-layout.md) | ✔️| ✔️| ✔️| ✔️| -|[Read](concept-read.md) | ✔️| ✔️| ✔️| n/a| -|[Receipt](concept-receipt.md) | ✔️| ✔️| ✔️| ✔️| -|[US 1098 Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| -|[US 1098-E Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| -|[US 1098-T Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| -|[US 1099 Tax](concept-tax-document.md) | ✔️| n/a| n/a| n/a| -|[US W2 Tax](concept-tax-document.md) | ✔️| ✔️| ✔️| n/a| +|**Model Type**| **Model**|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)| +|-|--||--||| +|Document analysis models|[Read](concept-read.md) | ✔️| ✔️| ✔️| n/a| +|Document analysis models|[Layout](concept-layout.md) | ✔️| ✔️| ✔️| ✔️| +|Document analysis models|[General document](concept-general-document.md) |moved to layout| ✔️| ✔️| n/a| +|Prebuilt models|[Business card](concept-business-card.md) | deprecated|✔️|✔️|✔️ | +|Prebuilt models|[Contract](concept-contract.md) | ✔️| ✔️| n/a| n/a| +|Prebuilt models|[Health insurance card](concept-health-insurance-card.md)| ✔️| ✔️| ✔️| n/a| +|Prebuilt models|[ID document](concept-id-document.md) | ✔️| ✔️| ✔️| ✔️| +|Prebuilt models|[Invoice](concept-invoice.md) | ✔️| ✔️| ✔️| ✔️| +|Prebuilt models|[Receipt](concept-receipt.md) | ✔️| ✔️| ✔️| ✔️| +|Prebuilt models|[US 1098 Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| +|Prebuilt models|[US 1098-E Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| +|Prebuilt models|[US 1098-T Tax](concept-tax-document.md) | ✔️| ✔️| n/a| n/a| +|Prebuilt models|[US 1099 Tax](concept-tax-document.md) | ✔️| n/a| n/a| n/a| +|Prebuilt models|[US W2 Tax](concept-tax-document.md) | ✔️| ✔️| ✔️| n/a| +|Prebuilt models|[Add-on capabilities](concept-add-on-capabilities.md) | ✔️| ✔️| n/a| n/a| +|Custom models|[Custom classifier](concept-custom-classifier.md) | ✔️| ✔️| n/a| n/a| +|Custom models|[Custom neural](concept-custom-neural.md) | ✔️| ✔️| ✔️| n/a| +|Custom models|[Custom template](concept-custom-template.md) | ✔️| ✔️| ✔️| ✔️| +|Custom models|[Custom composed](concept-composed-models.md) | ✔️| ✔️| ✔️| ✔️| ++|**Add-on Capability**| **Add-On/Free**|[2023-10-31-preview](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP)|[`2023-07-31` (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[`2022-08-31` (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)| +|-|--||--||| +|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a| +|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a| +|High resolution extraction|Add-On| ✔️| ✔️| n/a| n/a| +|Barcode extraction|Free| ✔️| ✔️| n/a| n/a| +|Language detection|Free| ✔️| ✔️| n/a| n/a| +|Key value pairs|Free| ✔️|n/a|n/a| n/a| +|Query fields|Add-On*| ✔️|n/a|n/a| n/a| +++Add-On* - Query fields are priced differently than the other add-on features. See [pricing](https://azure.microsoft.com/pricing/details/ai-document-intelligence/) for details. ::: moniker range=">=doc-intel-3.0.0" For all models, except Business card model, Document Intelligence now supports a * [`barcodes`](concept-add-on-capabilities.md#barcode-property-extraction) * [`languages`](concept-add-on-capabilities.md#language-detection) * [`keyValuePairs`](concept-add-on-capabilities.md#key-value-pairs) (2023-10-31-preview)-* [`queryFields`](concept-add-on-capabilities.md#query-fields) (2023-31-preview) +* [`queryFields`](concept-add-on-capabilities.md#query-fields) (2023-10-31-preview). `Not available with the US.Tax models` ## Analysis features -|Model ID|Content Extraction|Query fields|Paragraphs|Paragraph Roles|Selection Marks|Tables|Key-Value Pairs|Languages|Barcodes|Document Analysis|Formulas*|Style Font*|High Resolution*| -|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-| -|prebuilt-read|✓| | | | | |O|O| |O|O|O| -|prebuilt-layout|✓|✓|✓|✓|✓|✓| |O|O| |O|O|O| -|prebuilt-document|✓|✓|✓|✓|✓|✓|✓|O|O| |O|O|O| -|prebuilt-businessCard|✓|✓| | | | | | | |✓| | | | -|prebuilt-idDocument|✓|✓|| | | | |O|O|✓|O|O|O| -|prebuilt-invoice|✓|✓| | |✓|✓|O|O|O|✓|O|O|O| -|prebuilt-receipt|✓|✓| | | | | |O|O|✓|O|O|O| -|prebuilt-healthInsuranceCard.us|✓|✓| | | | | |O|O|✓|O|O|O| -|prebuilt-tax.us.w2|✓|✓| | |✓| | |O|O|✓|O|O|O| -|prebuilt-tax.us.1098|✓|✓| | |✓| | |O|O|✓|O|O|O| -|prebuilt-tax.us.1098E|✓|✓| | |✓| | |O|O|✓|O|O|O| -|prebuilt-tax.us.1098T|✓|✓| | |✓| | |O|O|✓|O|O|O| -|prebuilt-tax.us.1099(variations)|✓|✓| | |✓| | |O|O|✓|O|O|O| -|prebuilt-contract|✓|✓|✓|✓| | |O|O|✓|O|O|O| -|{ customModelName }|✓|✓|✓|✓|✓|✓| |O|O|✓|O|O|O| --✓ - Enabled</br> -O - Optional</br> -\* - Premium features incur extra costs ### Read OCR |
| ai-services | Concept Query Fields | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-query-fields.md | Title: Query field extraction - Document Intelligence (formerly Form Recognizer) -description: Use Document Intelligence to extract query field data. +description: Use Document Intelligence query fields to extend model schema. - ignite-2023 Previously updated : 11/21/2023 Last updated : 01/19/2024 monikerRange: 'doc-intel-4.0.0' monikerRange: 'doc-intel-4.0.0' # Document Intelligence query field extraction -**Document Intelligence now supports query field extractions using Azure OpenAI capabilities. With query field extraction, you can add fields to the extraction process using a query request without the need for added training. -+**Document Intelligence now supports query field to extend the schema of any prebuilt model to extract the specific fields you need. Query fields can also be added to layout to extract fields in addition to structure from forms or documents. > [!NOTE] >-> Document Intelligence Studio query field extraction is currently available with the general document model starting with the `2023-07-31 (GA)` API and later releases. +> Document Intelligence Studio query field extraction is currently available with layout and prebuilt models, excluding the UX.Tax prebuilt models. ++## Query fields or key value pairs ++Query fields and key value pairs perform similar functions, there are a few distinctions to be aware of when deciding which feature to choose. ++* Key value pairs are only available with layout and invoice models. If you're looking to extend the schema for a prebuilt model, use query fields. ++* You don't know the specific fields to be extracted, or the number of fields is large (greater than 20), key value pairs might be a better solution. -## Select query fields +* Key-value pairs extract the keys and values as they exist in the form or document, you need to plan for any key variations. For example, keys `First Name` or `Given Name`. With query fields, you define the key and the model only extracts the corresponding value. ++* Use query fields when the value you require can't be described as a key value pair in the document. For example, the agreement date of a contract. For query field extraction, specify the fields you want to extract and Document Intelligence analyzes the document accordingly. Here's an example: -* If you're processing a contract in the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/document), use the `2023-07-31` version: +* If you're processing a contract in the [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/layout), use the `2023-10-31-preview` or later API version: :::image type="content" source="media/studio/query-fields.png" alt-text="Screenshot of the query fields button in Document Intelligence Studio."::: -* You can pass a list of field labels like `Party1`, `Party2`, `TermsOfUse`, `PaymentTerms`, `PaymentDate`, and `TermEndDate`" as part of the analyze document request. +* You can pass a list of field labels like `Party1`, `Party2`, `TermsOfUse`, `PaymentTerms`, `PaymentDate`, and `TermEndDate`" as part of the `AnalyzeDocument` request. :::image type="content" source="media/studio/query-field-select.png" alt-text="Screenshot of query fields selection window in Document Intelligence Studio."::: -* Document Intelligence utilizes the capabilities of both [**Azure OpenAI Service**](../../ai-services/openai/overview.md) and extraction models to analyze and extract the field data and return the values in a structured JSON output. --* In addition to the query fields, the response includes text, tables, selection marks, general document key-value pairs, and other relevant data. +* In addition to the query fields, the response includes the model output. For a list of features or schema extracted by each model, see [model analysis features](concept-model-overview.md#analysis-features). ## Query fields REST API request** Use the query fields feature with the [general document model](concept-general-document.md), to add fields to the extraction process without having to train a custom model: ```http-POST https://{endpoint}/formrecognizer/documentModels/prebuilt-document:analyze?api-version=2023-07-31&queryFields=Party1, Party2, PaymentDate HTTP/1.1 +POST https://{endpoint}/documentintelligence/documentModels/prebuilt-layout:analyze?api-version=2023-10-31-preview&features=queryFields&queryFields=Terms,PaymentDate HTTP/1.1 Host: *.cognitiveservices.azure.com Content-Type: application/json Ocp-Apim-Subscription-Key: Ocp-Apim-Subscription-Key: > [!div class="nextstepaction"] > [Try the Document Intelligence Studio quickstart](./quickstarts/try-document-intelligence-studio.md)++> [!div class="nextstepaction"] +> [Learn about other add-on capabilities](concept-add-on-capabilities.md) |
| ai-services | Concept Read | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-read.md | Try extracting text from forms and documents using the Document Intelligence Stu ### Microsoft Office and HTML text extraction -Use the parameter `api-version=2023-07-31` when using the REST API or the corresponding SDKs of that API version to extract text from Microsoft Word, Excel, PowerPoint, and HTML files. The following illustration shows extraction of the digital text and text in the Word document by running OCR on the images. Text from embedded images isn't included in the extraction. --> [!NOTE] -> -> * [Add-on capabilities](concept-add-on-capabilities.md) are not supported for Microsoft Word, Excel, PowerPoint, and HTML file formats. ---The page units in the model output are computed as shown: +When analyzing Microsft Office and HTML files, the page units in the model output are computed as shown: **File format** | **Computed page unit** | **Total pages** | | | | | |
| ai-services | Concept Retrieval Augumented Generation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/concept-retrieval-augumented-generation.md | Markdown is a structured and formatted markup language and a popular input for e * **Scalability and AI quality**. The Layout model is highly scalable in Optical Character Recognition (OCR), table extraction, and [document structure analysis](concept-layout.md#document-layout-analysis). It supports [309 printed and 12 handwritten languages](language-support-ocr.md#model-id-prebuilt-layout), further ensuring high-quality results driven by AI capabilities. -* **Large learning model (LLM) compatibility**. The Layout model Markdown formatted output is LLM friendly and facilitates seamless integration into your workflows. You can turn any table in a document into Markdown format and avoid extensive effort parsing the documents for greater LLM understanding. +* **Large language model (LLM) compatibility**. The Layout model Markdown formatted output is LLM friendly and facilitates seamless integration into your workflows. You can turn any table in a document into Markdown format and avoid extensive effort parsing the documents for greater LLM understanding. **Text image processed with Document Intelligence Studio and output to MarkDown using Layout model** |
| ai-services | Language Support Ocr | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/language-support-ocr.md | Azure AI Document Intelligence models provide multilingual document processing s ##### Model ID: **prebuilt-read** -### [**Read: handwritten text**](#tab/read-hand) ---The following table lists read model language support for extracting and analyzing **handwritten** text.</br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| Russian (preview) | `ru` | -|Thai (preview) | `th` | Arabic (preview) | `ar` | ---The following table lists read model language support for extracting and analyzing **handwritten** text.</br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| --The following table lists read model language support for extracting and analyzing **handwritten** text.</br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| -- ### [**Read: printed text**](#tab/read-print) :::moniker range=">=doc-intel-3.1.0" The following table lists read model language support for extracting and analyzi :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Abaza|abq| - |Abkhazian|ab| - |Achinese|ace| - |Acoli|ach| - |Adangme|ada| - |Adyghe|ady| - |Afar|aa| - |Afrikaans|af| - |Akan|ak| - |Albanian|sq| - |Algonquin|alq| - |Angika (Devanagari)|anp| - |Arabic|ar| - |Asturian|ast| - |Asu (Tanzania)|asa| - |Avaric|av| - |Awadhi-Hindi (Devanagari)|awa| - |Aymara|ay| - |Azerbaijani (Latin)|az| - |Bafia|ksf| - |Bagheli|bfy| - |Bambara|bm| - |Bashkir|ba| - |Basque|eu| - |Belarusian (Cyrillic)|be, be-cyrl| - |Belarusian (Latin)|be, be-latn| - |Bemba (Zambia)|bem| - |Bena (Tanzania)|bez| - |Bhojpuri-Hindi (Devanagari)|bho| - |Bikol|bik| - |Bini|bin| - |Bislama|bi| - |Bodo (Devanagari)|brx| - |Bosnian (Latin)|bs| - |Brajbha|bra| - |Breton|br| - |Bulgarian|bg| - |Bundeli|bns| - |Buryat (Cyrillic)|bua| - |Catalan|ca| - |Cebuano|ceb| - |Chamling|rab| - |Chamorro|ch| - |Chechen|ce| - |Chhattisgarhi (Devanagari)|hne| - |Chiga|cgg| - |Chinese Simplified|zh-Hans| - |Chinese Traditional|zh-Hant| - |Choctaw|cho| - |Chukot|ckt| - |Chuvash|cv| - |Cornish|kw| - |Corsican|co| - |Cree|cr| - |Creek|mus| - |Crimean Tatar (Latin)|crh| - |Croatian|hr| - |Crow|cro| - |Czech|cs| - |Danish|da| - |Dargwa|dar| - |Dari|prs| - |Dhimal (Devanagari)|dhi| - |Dogri (Devanagari)|doi| - |Duala|dua| - |Dungan|dng| - |Dutch|nl| - |Efik|efi| - |English|en| - |Erzya (Cyrillic)|myv| - |Estonian|et| - |Faroese|fo| - |Fijian|fj| - |Filipino|fil| - |Finnish|fi| + |Abaza|`abq`| + |Abkhazian|`ab`| + |Achinese|`ace`| + |Acoli|`ach`| + |Adangme|`ada`| + |Adyghe|`ady`| + |Afar|`aa`| + |Afrikaans|`af`| + |Akan|`ak`| + |Albanian|`sq`| + |Algonquin|`alq`| + |Angika (Devanagari)|`anp`| + |Arabic|`ar`| + |Asturian|`ast`| + |Asu (Tanzania)|`asa`| + |Avaric|`av`| + |Awadhi-Hindi (Devanagari)|`awa`| + |Aymara|`ay`| + |Azerbaijani (Latin)|`az`| + |Bafia|`ksf`| + |Bagheli|`bfy`| + |Bambara|`bm`| + |Bashkir|`ba`| + |Basque|`eu`| + |Belarusian (Cyrillic)|`be`, `be-cyrl`| + |Belarusian (Latin)|`be`, `be-latn`| + |Bemba (Zambia)|`bem`| + |Bena (Tanzania)|`bez`| + |Bhojpuri-Hindi (Devanagari)|`bho`| + |Bikol|`bik`| + |Bini|`bin`| + |Bislama|`bi`| + |Bodo (Devanagari)|`brx`| + |Bosnian (Latin)|`bs`| + |Brajbha|`bra`| + |Breton|`br`| + |Bulgarian|`bg`| + |Bundeli|`bns`| + |Buryat (Cyrillic)|`bua`| + |Catalan|`ca`| + |Cebuano|`ceb`| + |Chamling|`rab`| + |Chamorro|`ch`| + |Chechen|`ce`| + |Chhattisgarhi (Devanagari)|`hne`| + |Chiga|`cgg`| + |Chinese Simplified|`zh-Hans`| + |Chinese Traditional|`zh-Hant`| + |Choctaw|`cho`| + |Chukot|`ckt`| + |Chuvash|`cv`| + |Cornish|`kw`| + |Corsican|`co`| + |Cree|`cr`| + |Creek|`mus`| + |Crimean Tatar (Latin)|`crh`| + |Croatian|`hr`| + |Crow|`cro`| + |Czech|`cs`| + |Danish|`da`| + |Dargwa|`dar`| + |Dari|`prs`| + |Dhimal (Devanagari)|`dhi`| + |Dogri (Devanagari)|`doi`| + |Duala|`dua`| + |Dungan|`dng`| + |Dutch|`nl`| + |Efik|`efi`| + |English|`en`| + |Erzya (Cyrillic)|`myv`| + |Estonian|`et`| + |Faroese|`fo`| + |Fijian|`fj`| + |Filipino|`fil`| + |Finnish|`fi`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Fon|fon| - |French|fr| - |Friulian|fur| - |Ga|gaa| - |Gagauz (Latin)|gag| - |Galician|gl| - |Ganda|lg| - |Gayo|gay| - |German|de| - |Gilbertese|gil| - |Gondi (Devanagari)|gon| - |Greek|el| - |Greenlandic|kl| - |Guarani|gn| - |Gurung (Devanagari)|gvr| - |Gusii|guz| - |Haitian Creole|ht| - |Halbi (Devanagari)|hlb| - |Hani|hni| - |Haryanvi|bgc| - |Hawaiian|haw| - |Hebrew|he| - |Herero|hz| - |Hiligaynon|hil| - |Hindi|hi| - |Hmong Daw (Latin)|mww| - |Ho(Devanagiri)|hoc| - |Hungarian|hu| - |Iban|iba| - |Icelandic|is| - |Igbo|ig| - |Iloko|ilo| - |Inari Sami|smn| - |Indonesian|id| - |Ingush|inh| - |Interlingua|ia| - |Inuktitut (Latin)|iu| - |Irish|ga| - |Italian|it| - |Japanese|ja| - |Jaunsari (Devanagari)|Jns| - |Javanese|jv| - |Jola-Fonyi|dyo| - |Kabardian|kbd| - |Kabuverdianu|kea| - |Kachin (Latin)|kac| - |Kalenjin|kln| - |Kalmyk|xal| - |Kangri (Devanagari)|xnr| - |Kanuri|kr| - |Karachay-Balkar|krc| - |Kara-Kalpak (Cyrillic)|kaa-cyrl| - |Kara-Kalpak (Latin)|kaa| - |Kashubian|csb| - |Kazakh (Cyrillic)|kk-cyrl| - |Kazakh (Latin)|kk-latn| - |Khakas|kjh| - |Khaling|klr| - |Khasi|kha| - |K'iche'|quc| - |Kikuyu|ki| - |Kildin Sami|sjd| - |Kinyarwanda|rw| - |Komi|kv| - |Kongo|kg| - |Korean|ko| - |Korku|kfq| - |Koryak|kpy| - |Kosraean|kos| - |Kpelle|kpe| - |Kuanyama|kj| - |Kumyk (Cyrillic)|kum| - |Kurdish (Arabic)|ku-arab| - |Kurdish (Latin)|ku-latn| - |Kurukh (Devanagari)|kru| - |Kyrgyz (Cyrillic)|ky| - |Lak|lbe| - |Lakota|lkt| + |`Fon`|`fon`| + |French|`fr`| + |Friulian|`fur`| + |`Ga`|`gaa`| + |Gagauz (Latin)|`gag`| + |Galician|`gl`| + |Ganda|`lg`| + |Gayo|`gay`| + |German|`de`| + |Gilbertese|`gil`| + |Gondi (Devanagari)|`gon`| + |Greek|`el`| + |Greenlandic|`kl`| + |Guarani|`gn`| + |Gurung (Devanagari)|`gvr`| + |Gusii|`guz`| + |Haitian Creole|`ht`| + |Halbi (Devanagari)|`hlb`| + |Hani|`hni`| + |Haryanvi|`bgc`| + |Hawaiian|`haw`| + |Hebrew|`he`| + |Herero|`hz`| + |Hiligaynon|`hil`| + |Hindi|`hi`| + |Hmong Daw (Latin)|`mww`| + |Ho(Devanagiri)|`hoc`| + |Hungarian|`hu`| + |Iban|`iba`| + |Icelandic|`is`| + |Igbo|`ig`| + |Iloko|`ilo`| + |Inari Sami|`smn`| + |Indonesian|`id`| + |Ingush|`inh`| + |Interlingua|`ia`| + |Inuktitut (Latin)|`iu`| + |Irish|`ga`| + |Italian|`it`| + |Japanese|`ja`| + |Jaunsari (Devanagari)|`Jns`| + |Javanese|`jv`| + |Jola-Fonyi|`dyo`| + |Kabardian|`kbd`| + |Kabuverdianu|`kea`| + |Kachin (Latin)|`kac`| + |Kalenjin|`kln`| + |Kalmyk|`xal`| + |Kangri (Devanagari)|`xnr`| + |Kanuri|`kr`| + |Karachay-Balkar|`krc`| + |Kara-Kalpak (Cyrillic)|`kaa-cyrl`| + |Kara-Kalpak (Latin)|`kaa`| + |Kashubian|`csb`| + |Kazakh (Cyrillic)|`kk-cyrl`| + |Kazakh (Latin)|`kk-latn`| + |Khakas|`kjh`| + |Khaling|`klr`| + |Khasi|`kha`| + |K'iche'|`quc`| + |Kikuyu|`ki`| + |Kildin Sami|`sjd`| + |Kinyarwanda|`rw`| + |Komi|`kv`| + |Kongo|`kg`| + |Korean|`ko`| + |Korku|`kfq`| + |Koryak|`kpy`| + |Kosraean|`kos`| + |Kpelle|`kpe`| + |Kuanyama|`kj`| + |Kumyk (Cyrillic)|`kum`| + |Kurdish (Arabic)|`ku-arab`| + |Kurdish (Latin)|`ku-latn`| + |Kurukh (Devanagari)|`kru`| + |Kyrgyz (Cyrillic)|`ky`| + |`Lak`|`lbe`| + |Lakota|`lkt`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Latin|la| - |Latvian|lv| - |Lezghian|lex| - |Lingala|ln| - |Lithuanian|lt| - |Lower Sorbian|dsb| - |Lozi|loz| - |Lule Sami|smj| - |Luo (Kenya and Tanzania)|luo| - |Luxembourgish|lb| - |Luyia|luy| - |Macedonian|mk| - |Machame|jmc| - |Madurese|mad| - |Mahasu Pahari (Devanagari)|bfz| - |Makhuwa-Meetto|mgh| - |Makonde|kde| - |Malagasy|mg| - |Malay (Latin)|ms| - |Maltese|mt| - |Malto (Devanagari)|kmj| - |Mandinka|mnk| - |Manx|gv| - |Maori|mi| - |Mapudungun|arn| - |Marathi|mr| - |Mari (Russia)|chm| - |Masai|mas| - |Mende (Sierra Leone)|men| - |Meru|mer| - |Meta'|mgo| - |Minangkabau|min| - |Mohawk|moh| - |Mongolian (Cyrillic)|mn| - |Mongondow|mog| - |Montenegrin (Cyrillic)|cnr-cyrl| - |Montenegrin (Latin)|cnr-latn| - |Morisyen|mfe| - |Mundang|mua| - |Nahuatl|nah| - |Navajo|nv| - |Ndonga|ng| - |Neapolitan|nap| - |Nepali|ne| - |Ngomba|jgo| - |Niuean|niu| - |Nogay|nog| - |North Ndebele|nd| - |Northern Sami (Latin)|sme| - |Norwegian|no| - |Nyanja|ny| - |Nyankole|nyn| - |Nzima|nzi| - |Occitan|oc| - |Ojibwa|oj| - |Oromo|om| - |Ossetic|os| - |Pampanga|pam| - |Pangasinan|pag| - |Papiamento|pap| - |Pashto|ps| - |Pedi|nso| - |Persian|fa| - |Polish|pl| - |Portuguese|pt| - |Punjabi (Arabic)|pa| - |Quechua|qu| - |Ripuarian|ksh| - |Romanian|ro| - |Romansh|rm| - |Rundi|rn| - |Russian|ru| - |Rwa|rwk| - |Sadri (Devanagari)|sck| - |Sakha|sah| - |Samburu|saq| - |Samoan (Latin)|sm| - |Sango|sg| + |Latin|`la`| + |Latvian|`lv`| + |Lezghian|`lex`| + |Lingala|`ln`| + |Lithuanian|`lt`| + |Lower Sorbian|`dsb`| + |Lozi|`loz`| + |Lule Sami|`smj`| + |Luo (Kenya and Tanzania)|`luo`| + |Luxembourgish|`lb`| + |Luyia|`luy`| + |Macedonian|`mk`| + |Machame|`jmc`| + |Madurese|`mad`| + |Mahasu Pahari (Devanagari)|`bfz`| + |Makhuwa-Meetto|`mgh`| + |Makonde|`kde`| + |Malagasy|`mg`| + |Malay (Latin)|`ms`| + |Maltese|`mt`| + |Malto (Devanagari)|`kmj`| + |Mandinka|`mnk`| + |Manx|`gv`| + |Maori|`mi`| + |Mapudungun|`arn`| + |Marathi|`mr`| + |Mari (Russia)|`chm`| + |Masai|`mas`| + |Mende (Sierra Leone)|`men`| + |Meru|`mer`| + |Meta'|`mgo`| + |Minangkabau|`min`| + |Mohawk|`moh`| + |Mongolian (Cyrillic)|`mn`| + |Mongondow|`mog`| + |Montenegrin (Cyrillic)|`cnr-cyrl`| + |Montenegrin (Latin)|`cnr-latn`| + |Morisyen|`mfe`| + |Mundang|`mua`| + |Nahuatl|`nah`| + |Navajo|`nv`| + |Ndonga|`ng`| + |Neapolitan|`nap`| + |Nepali|`ne`| + |Ngomba|`jgo`| + |Niuean|`niu`| + |Nogay|`nog`| + |North Ndebele|`nd`| + |Northern Sami (Latin)|`sme`| + |Norwegian|`no`| + |Nyanja|`ny`| + |Nyankole|`nyn`| + |Nzima|`nzi`| + |Occitan|`oc`| + |Ojibwa|`oj`| + |Oromo|`om`| + |Ossetic|`os`| + |Pampanga|`pam`| + |Pangasinan|`pag`| + |Papiamento|`pap`| + |Pashto|`ps`| + |Pedi|`nso`| + |Persian|`fa`| + |Polish|`pl`| + |Portuguese|`pt`| + |Punjabi (Arabic)|`pa`| + |Quechua|`qu`| + |Ripuarian|`ksh`| + |Romanian|`ro`| + |Romansh|`rm`| + |Rundi|`rn`| + |Russian|`ru`| + |`Rwa`|`rwk`| + |Sadri (Devanagari)|`sck`| + |Sakha|`sah`| + |Samburu|`saq`| + |Samoan (Latin)|`sm`| + |Sango|`sg`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Sangu (Gabon)|snq| - |Sanskrit (Devanagari)|sa| - |Santali(Devanagiri)|sat| - |Scots|sco| - |Scottish Gaelic|gd| - |Sena|seh| - |Serbian (Cyrillic)|sr-cyrl| - |Serbian (Latin)|sr, sr-latn| - |Shambala|ksb| - |Shona|sn| - |Siksika|bla| - |Sirmauri (Devanagari)|srx| - |Skolt Sami|sms| - |Slovak|sk| - |Slovenian|sl| - |Soga|xog| - |Somali (Arabic)|so| - |Somali (Latin)|so-latn| - |Songhai|son| - |South Ndebele|nr| - |Southern Altai|alt| - |Southern Sami|sma| - |Southern Sotho|st| - |Spanish|es| - |Sundanese|su| - |Swahili (Latin)|sw| - |Swati|ss| - |Swedish|sv| - |Tabassaran|tab| - |Tachelhit|shi| - |Tahitian|ty| - |Taita|dav| - |Tajik (Cyrillic)|tg| - |Tamil|ta| - |Tatar (Cyrillic)|tt-cyrl| - |Tatar (Latin)|tt| - |Teso|teo| - |Tetum|tet| - |Thai|th| - |Thangmi|thf| - |Tok Pisin|tpi| - |Tongan|to| - |Tsonga|ts| - |Tswana|tn| - |Turkish|tr| - |Turkmen (Latin)|tk| - |Tuvan|tyv| - |Udmurt|udm| - |Uighur (Cyrillic)|ug-cyrl| - |Ukrainian|uk| - |Upper Sorbian|hsb| - |Urdu|ur| - |Uyghur (Arabic)|ug| - |Uzbek (Arabic)|uz-arab| - |Uzbek (Cyrillic)|uz-cyrl| - |Uzbek (Latin)|uz| - |Vietnamese|vi| - |Volap├╝k|vo| - |Vunjo|vun| - |Walser|wae| - |Welsh|cy| - |Western Frisian|fy| - |Wolof|wo| - |Xhosa|xh| - |Yucatec Maya|yua| - |Zapotec|zap| - |Zarma|dje| - |Zhuang|za| - |Zulu|zu| + |Sangu (Gabon)|`snq`| + |Sanskrit (Devanagari)|`sa`| + |Santali(Devanagiri)|`sat`| + |Scots|`sco`| + |Scottish Gaelic|`gd`| + |Sena|`seh`| + |Serbian (Cyrillic)|`sr-cyrl`| + |Serbian (Latin)|`sr`, s`r-latn`| + |Shambala|`ksb`| + |Shona|`sn`| + |Siksika|`bla`| + |Sirmauri (Devanagari)|`srx`| + |Skolt Sami|`sms`| + |Slovak|`sk`| + |Slovenian|`sl`| + |Soga|`xog`| + |Somali (Arabic)|`so`| + |Somali (Latin)|`so-latn`| + |Songhai|`son`| + |South Ndebele|`nr`| + |Southern Altai|`alt`| + |Southern Sami|`sma`| + |Southern Sotho|`st`| + |Spanish|`es`| + |Sundanese|`su`| + |Swahili (Latin)|`sw`| + |Swati|`ss`| + |Swedish|`sv`| + |Tabassaran|`tab`| + |Tachelhit|`shi`| + |Tahitian|`ty`| + |Taita|`dav`| + |Tajik (Cyrillic)|`tg`| + |Tamil|`ta`| + |Tatar (Cyrillic)|`tt-cyrl`| + |Tatar (Latin)|`tt`| + |Teso|`teo`| + |Tetum|`tet`| + |Thai|`th`| + |Thangmi|`thf`| + |Tok Pisin|`tpi`| + |Tongan|`to`| + |Tsonga|`ts`| + |Tswana|`tn`| + |Turkish|`tr`| + |Turkmen (Latin)|`tk`| + |Tuvan|`tyv`| + |Udmurt|`udm`| + |Uighur (Cyrillic)|`ug-cyrl`| + |Ukrainian|`uk`| + |Upper Sorbian|`hsb`| + |Urdu|`ur`| + |Uyghur (Arabic)|`ug`| + |Uzbek (Arabic)|`uz-arab`| + |Uzbek (Cyrillic)|`uz-cyrl`| + |Uzbek (Latin)|`uz`| + |Vietnamese|`vi`| + |Volap├╝k|`vo`| + |Vunjo|`vun`| + |Walser|`wae`| + |Welsh|`cy`| + |Western Frisian|`fy`| + |Wolof|`wo`| + |Xhosa|`xh`| + |Yucatec Maya|`yua`| + |Zapotec|`zap`| + |Zarma|`dje`| + |Zhuang|`za`| + |Zulu|`zu`| :::column-end::: :::row-end::: The following table lists read model language support for extracting and analyzi :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Afrikaans|af| - |Angika|anp| - |Arabic|ar| - |Asturian|ast| - |Awadhi|awa| - |Azerbaijani|az| - |Belarusian (Cyrillic)|be, be-cyrl| - |Belarusian (Latin)|be-latn| - |Bagheli|bfy| - |Mahasu Pahari|bfz| - |Bulgarian|bg| - |Haryanvi|bgc| - |Bhojpuri|bho| - |Bislama|bi| - |Bundeli|bns| - |Breton|br| - |Braj|bra| - |Bodo|brx| - |Bosnian|bs| - |Buriat|bua| - |Catalan|ca| - |Cebuano|ceb| - |Chamorro|ch| - |Montenegrin (Latin)|cnr, cnr-latn| - |Montenegrin (Cyrillic)|cnr-cyrl| - |Corsican|co| - |Crimean Tatar|crh| - |Czech|cs| - |Kashubian|csb| - |Welsh|cy| - |Danish|da| - |German|de| - |Dhimal|dhi| - |Dogri|doi| - |Lower Sorbian|dsb| - |English|en| - |Spanish|es| - |Estonian|et| - |Basque|eu| - |Persian|fa| - |Finnish|fi| - |Filipino|fil| + |Afrikaans|`af`| + |Angika|`anp`| + |Arabic|`ar`| + |Asturian|`ast`| + |Awadhi|`awa`| + |Azerbaijani|`az`| + |Belarusian (Cyrillic)|`be`, `be-cyrl`| + |Belarusian (Latin)|`be-latn`| + |Bagheli|`bfy`| + |Mahasu Pahari|`bfz`| + |Bulgarian|`bg`| + |Haryanvi|`bgc`| + |Bhojpuri|`bho`| + |Bislama|`bi`| + |Bundeli|`bns`| + |Breton|`br`| + |Braj|`bra`| + |Bodo|`brx`| + |Bosnian|`bs`| + |Buriat|`bua`| + |Catalan|`ca`| + |Cebuano|`ceb`| + |Chamorro|`ch`| + |Montenegrin (Latin)|`cnr`, `cnr-latn`| + |Montenegrin (Cyrillic)|`cnr-cyrl`| + |Corsican|`co`| + |Crimean Tatar|`crh`| + |Czech|`cs`| + |Kashubian|`csb`| + |Welsh|`cy`| + |Danish|`da`| + |German|`de`| + |Dhimal|`dhi`| + |Dogri|`doi`| + |Lower Sorbian|`dsb`| + |English|`en`| + |Spanish|`es`| + |Estonian|`et`| + |Basque|`eu`| + |Persian|`fa`| + |Finnish|`fi`| + |Filipino|`fil`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Fijian|fj| - |Faroese|fo| - |French|fr| - |Friulian|fur| - |Western Frisian|fy| - |Irish|ga| - |Gagauz|gag| - |Scottish Gaelic|gd| - |Gilbertese|gil| - |Galician|gl| - |Gondi|gon| - |Manx|gv| - |Gurung|gvr| - |Hawaiian|haw| - |Hindi|hi| - |Halbi|hlb| - |Chhattisgarhi|hne| - |Hani|hni| - |Ho|hoc| - |Croatian|hr| - |Upper Sorbian|hsb| - |Haitian|ht| - |Hungarian|hu| - |Interlingua|ia| - |Indonesian|id| - |Icelandic|is| - |Italian|it| - |Inuktitut|iu| + |Fijian|`fj`| + |Faroese|`fo`| + |French|`fr`| + |Friulian|`fur`| + |Western Frisian|`fy`| + |Irish|`ga`| + |Gagauz|`gag`| + |Scottish Gaelic|`gd`| + |Gilbertese|`gil`| + |Galician|`gl`| + |Gondi|`gon`| + |Manx|`gv`| + |Gurung|`gvr`| + |Hawaiian|`haw`| + |Hindi|`hi`| + |Halbi|`hlb`| + |Chhattisgarhi|`hne`| + |Hani|`hni`| + |`Ho`|`hoc`| + |Croatian|`hr`| + |Upper Sorbian|`hsb`| + |Haitian|`ht`| + |Hungarian|`hu`| + |Interlingua|`ia`| + |Indonesian|`id`| + |Icelandic|`is`| + |Italian|`it`| + |Inuktitut|`iu`| |Japanese|- |Jaunsari|jns| - |Javanese|jv| - |Kara-Kalpak (Latin)|kaa, kaa-latn| - |Kara-Kalpak (Cyrillic)|kaa-cyrl| - |Kachin|kac| - |Kabuverdianu|kea| - |Korku|kfq| - |Khasi|kha| - |Kazakh (Latin)|kk, kk-latn| - |Kazakh (Cyrillic)|kk-cyrl| - |Kalaallisut|kl| - |Khaling|klr| - |Malto|kmj| + |Jaunsari|`jns`| + |Javanese|`jv`| + |Kara-Kalpak (Latin)|`kaa`, `kaa-latn`| + |Kara-Kalpak (Cyrillic)|`kaa-cyrl`| + |Kachin|`kac`| + |Kabuverdianu|`kea`| + |Korku|`kfq`| + |Khasi|`kha`| + |Kazakh (Latin)|`kk`, `kk-latn`| + |Kazakh (Cyrillic)|`kk-cyrl`| + |Kalaallisut|`kl`| + |Khaling|`klr`| + |Malto|`kmj`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:| |Korean|- |Kosraean|kos| - |Koryak|kpy| - |Karachay-Balkar|krc| - |Kurukh|kru| - |K├╢lsch|ksh| - |Kurdish (Latin)|ku, ku-latn| - |Kurdish (Arabic)|ku-arab| - |Kumyk|kum| - |Cornish|kw| - |Kirghiz|ky| - |Latin|la| - |Luxembourgish|lb| - |Lakota|lkt| - |Lithuanian|lt| - |Maori|mi| - |Mongolian|mn| - |Marathi|mr| - |Malay|ms| - |Maltese|mt| - |Hmong Daw|mww| - |Erzya|myv| - |Neapolitan|nap| - |Nepali|ne| - |Niuean|niu| - |Dutch|nl| - |Norwegian|no| - |Nogai|nog| - |Occitan|oc| - |Ossetian|os| - |Panjabi|pa| - |Polish|pl| - |Dari|prs| - |Pushto|ps| - |Portuguese|pt| - |K'iche'|quc| - |Camling|rab| - |Romansh|rm| - |Romanian|ro| - |Russian|ru| - |Sanskrit|sa| - |Santali|sat| + |Kosraean|`kos`| + |Koryak|`kpy`| + |Karachay-Balkar|`krc`| + |Kurukh|`kru`| + |K├╢lsch|`ksh`| + |Kurdish (Latin)|`ku`, `ku-latn`| + |Kurdish (Arabic)|`ku-arab`| + |Kumyk|`kum`| + |Cornish|`kw`| + |Kirghiz|`ky`| + |Latin|`la`| + |Luxembourgish|`lb`| + |Lakota|`lkt`| + |Lithuanian|`lt`| + |Maori|`mi`| + |Mongolian|`mn`| + |Marathi|`mr`| + |Malay|`ms`| + |Maltese|`mt`| + |Hmong `Daw`|`mww`| + |Erzya|`myv`| + |Neapolitan|`nap`| + |Nepali|`ne`| + |Niuean|`niu`| + |Dutch|`nl`| + |Norwegian|`no`| + |Nogai|`nog`| + |Occitan|`oc`| + |Ossetian|`os`| + |Panjabi|`pa`| + |Polish|`pl`| + |Dari|`prs`| + |Pushto|`ps`| + |Portuguese|`pt`| + |K'iche'|`quc`| + |Camling|`rab`| + |Romansh|`rm`| + |Romanian|`ro`| + |Russian|`ru`| + |Sanskrit|`sa`| + |Santali|`sat`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Sadri|sck| - |Scots|sco| - |Slovak|sk| - |Slovenian|sl| - |Samoan|sm| - |Southern Sami|sma| - |Northern Sami|sme| - |Lule Sami|smj| - |Inari Sami|smn| - |Skolt Sami|sms| - |Somali|so| - |Albanian|sq| - |Serbian (Latin)|sr, sr-latn| - |Sirmauri|srx| - |Swedish|sv| - |Swahili|sw| - |Tetum|tet| - |Tajik|tg| - |Thangmi|thf| - |Turkmen|tk| - |Tonga|to| - |Turkish|tr| - |Tatar|tt| - |Tuvinian|tyv| - |Uighur|ug| - |Urdu|ur| - |Uzbek (Latin)|uz, uz-latn| - |Uzbek (Cyrillic)|uz-cyrl| - |Uzbek (Arabic)|uz-arab| - |Volap├╝k|vo| - |Walser|wae| - |Kangri|xnr| - |Yucateco|yua| - |Zhuang|za| - |Chinese (Han (Simplified variant))|zh, zh-hans| - |Chinese (Han (Traditional variant))|zh-hant| - |Zulu|zu| + |Sadri|`sck`| + |Scots|`sco`| + |Slovak|`sk`| + |Slovenian|`sl`| + |Samoan|`sm`| + |Southern Sami|`sma`| + |Northern Sami|`sme`| + |Lule Sami|`smj`| + |Inari Sami|`smn`| + |Skolt Sami|`sms`| + |Somali|`so`| + |Albanian|`sq`| + |Serbian (Latin)|`sr`, `sr-latn`| + |Sirmauri|`srx`| + |Swedish|`sv`| + |Swahili|`sw`| + |Tetum|`tet`| + |Tajik|`tg`| + |Thangmi|`thf`| + |Turkmen|`tk`| + |Tonga|`to`| + |Turkish|`tr`| + |Tatar|`tt`| + |Tuvinian|`tyv`| + |Uighur|`ug`| + |Urdu|`ur`| + |Uzbek (Latin)|`uz`, `uz-latn`| + |Uzbek (Cyrillic)|`uz-cyrl`| + |Uzbek (Arabic)|`uz-arab`| + |Volap├╝k|`vo`| + |Walser|`wae`| + |Kangri|`xnr`| + |Yucateco|`yua`| + |Zhuang|`za`| + |Chinese (Han (Simplified variant))|`zh`, `zh-hans`| + |Chinese (Han (Traditional variant))|`zh-hant`| + |Zulu|`zu`| :::column-end::: :::row-end::: :::moniker-end +### [**Read: handwritten text**](#tab/read-hand) +++The following table lists read model language support for extracting and analyzing **handwritten** text.</br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| Russian (preview) | `ru` | +|Thai (preview) | `th` | Arabic (preview) | `ar` | +++The following table lists read model language support for extracting and analyzing **handwritten** text.</br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| ++The following table lists read model language support for extracting and analyzing **handwritten** text.</br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| ++ ### [**Read: language detection**](#tab/read-detection) The [Read model API](concept-read.md) supports **language detection** for the following languages in your documents. This list can include languages not currently supported for text extraction. The [Read model API](concept-read.md) supports **language detection** for the fo ##### Model ID: **prebuilt-layout** -### [**Layout: handwritten text**](#tab/layout-hand) ---The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| Russian (preview) | `ru` | -|Thai (preview) | `th` | Arabic (preview) | `ar` | ---##### Model ID: **prebuilt-layout** --The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| --- > [!NOTE] - > Document Intelligence v2.1 does not support handwritten text extraction. ----The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> --|Language| Language code (optional) | Language| Language code (optional) | -|:--|:-:|:--|:-:| -|English|`en`|Japanese |`ja`| -|Chinese Simplified |`zh-Hans`|Korean |`ko`| -|French |`fr`|Portuguese |`pt`| -|German |`de`|Spanish |`es`| -|Italian |`it`| Russian (preview) | `ru` | -|Thai (preview) | `th` | Arabic (preview) | `ar` | - ### [**Layout: printed text**](#tab/layout-print) :::moniker range=">=doc-intel-3.1.0" The following table lists the supported languages for printed text: :::row::: :::column span="":::- |Language| Code (optional) | + |**Language**| **Code (optional)** | |:--|:-:|- |Abaza|abq| - |Abkhazian|ab| - |Achinese|ace| - |Acoli|ach| - |Adangme|ada| - |Adyghe|ady| - |Afar|aa| - |Afrikaans|af| - |Akan|ak| - |Albanian|sq| - |Algonquin|alq| - |Angika (Devanagari)|anp| - |Arabic|ar| - |Asturian|ast| - |Asu (Tanzania)|asa| - |Avaric|av| - |Awadhi-Hindi (Devanagari)|awa| - |Aymara|ay| - |Azerbaijani (Latin)|az| - |Bafia|ksf| - |Bagheli|bfy| - |Bambara|bm| - |Bashkir|ba| - |Basque|eu| - |Belarusian (Cyrillic)|be, be-cyrl| - |Belarusian (Latin)|be, be-latn| - |Bemba (Zambia)|bem| - |Bena (Tanzania)|bez| - |Bhojpuri-Hindi (Devanagari)|bho| - |Bikol|bik| - |Bini|bin| - |Bislama|bi| - |Bodo (Devanagari)|brx| - |Bosnian (Latin)|bs| - |Brajbha|bra| - |Breton|br| - |Bulgarian|bg| - |Bundeli|bns| - |Buryat (Cyrillic)|bua| - |Catalan|ca| - |Cebuano|ceb| - |Chamling|rab| - |Chamorro|ch| - |Chechen|ce| - |Chhattisgarhi (Devanagari)|hne| - |Chiga|cgg| - |Chinese Simplified|zh-Hans| - |Chinese Traditional|zh-Hant| - |Choctaw|cho| - |Chukot|ckt| - |Chuvash|cv| - |Cornish|kw| - |Corsican|co| - |Cree|cr| - |Creek|mus| - |Crimean Tatar (Latin)|crh| - |Croatian|hr| - |Crow|cro| - |Czech|cs| - |Danish|da| - |Dargwa|dar| - |Dari|prs| - |Dhimal (Devanagari)|dhi| - |Dogri (Devanagari)|doi| - |Duala|dua| - |Dungan|dng| - |Dutch|nl| - |Efik|efi| - |English|en| - |Erzya (Cyrillic)|myv| - |Estonian|et| - |Faroese|fo| - |Fijian|fj| - |Filipino|fil| - |Finnish|fi| + |Abaza|`abq`| + |Abkhazian|`ab`| + |Achinese|`ace`| + |Acoli|`ach`| + |Adangme|`ada`| + |Adyghe|`ady`| + |Afar|`aa`| + |Afrikaans|`af`| + |Akan|`ak`| + |Albanian|`sq`| + |Algonquin|`alq`| + |Angika (Devanagari)|`anp`| + |Arabic|`ar`| + |Asturian|`ast`| + |Asu (Tanzania)|`asa`| + |Avaric|`av`| + |Awadhi-Hindi (Devanagari)|`awa`| + |Aymara|`ay`| + |Azerbaijani (Latin)|`az`| + |Bafia|`ksf`| + |Bagheli|`bfy`| + |Bambara|`bm`| + |Bashkir|`ba`| + |Basque|`eu`| + |Belarusian (Cyrillic)|`be`, `be-cyrl`| + |Belarusian (Latin)|`be`, `be-latn`| + |Bemba (Zambia)|`bem`| + |Bena (Tanzania)|`bez`| + |Bhojpuri-Hindi (Devanagari)|`bho`| + |Bikol|`bik`| + |Bini|`bin`| + |Bislama|`bi`| + |Bodo (Devanagari)|`brx`| + |Bosnian (Latin)|`bs`| + |Brajbha|`bra`| + |Breton|`br`| + |Bulgarian|`bg`| + |Bundeli|`bns`| + |Buryat (Cyrillic)|`bua`| + |Catalan|`ca`| + |Cebuano|`ceb`| + |Chamling|`rab`| + |Chamorro|`ch`| + |Chechen|`ce`| + |Chhattisgarhi (Devanagari)|`hne`| + |Chiga|`cgg`| + |Chinese Simplified|`zh-Hans`| + |Chinese Traditional|`zh-Hant`| + |Choctaw|`cho`| + |Chukot|`ckt`| + |Chuvash|`cv`| + |Cornish|`kw`| + |Corsican|`co`| + |Cree|`cr`| + |Creek|`mus`| + |Crimean Tatar (Latin)|`crh`| + |Croatian|`hr`| + |Crow|`cro`| + |Czech|`cs`| + |Danish|`da`| + |Dargwa|`dar`| + |Dari|`prs`| + |Dhimal (Devanagari)|`dhi`| + |Dogri (Devanagari)|`doi`| + |Duala|`dua`| + |Dungan|`dng`| + |Dutch|`nl`| + |Efik|`efi`| + |English|`en`| + |Erzya (Cyrillic)|`myv`| + |Estonian|`et`| + |Faroese|`fo`| + |Fijian|`fj`| + |Filipino|`fil`| + |Finnish|`fi`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Fon|fon| - |French|fr| - |Friulian|fur| - |Ga|gaa| - |Gagauz (Latin)|gag| - |Galician|gl| - |Ganda|lg| - |Gayo|gay| - |German|de| - |Gilbertese|gil| - |Gondi (Devanagari)|gon| - |Greek|el| - |Greenlandic|kl| - |Guarani|gn| - |Gurung (Devanagari)|gvr| - |Gusii|guz| - |Haitian Creole|ht| - |Halbi (Devanagari)|hlb| - |Hani|hni| - |Haryanvi|bgc| - |Hawaiian|haw| - |Hebrew|he| - |Herero|hz| - |Hiligaynon|hil| - |Hindi|hi| - |Hmong Daw (Latin)|mww| - |Ho(Devanagiri)|hoc| - |Hungarian|hu| - |Iban|iba| - |Icelandic|is| - |Igbo|ig| - |Iloko|ilo| - |Inari Sami|smn| - |Indonesian|id| - |Ingush|inh| - |Interlingua|ia| - |Inuktitut (Latin)|iu| - |Irish|ga| - |Italian|it| - |Japanese|ja| - |Jaunsari (Devanagari)|Jns| - |Javanese|jv| - |Jola-Fonyi|dyo| - |Kabardian|kbd| - |Kabuverdianu|kea| - |Kachin (Latin)|kac| - |Kalenjin|kln| - |Kalmyk|xal| - |Kangri (Devanagari)|xnr| - |Kanuri|kr| - |Karachay-Balkar|krc| - |Kara-Kalpak (Cyrillic)|kaa-cyrl| - |Kara-Kalpak (Latin)|kaa| - |Kashubian|csb| - |Kazakh (Cyrillic)|kk-cyrl| - |Kazakh (Latin)|kk-latn| - |Khakas|kjh| - |Khaling|klr| - |Khasi|kha| - |K'iche'|quc| - |Kikuyu|ki| - |Kildin Sami|sjd| - |Kinyarwanda|rw| - |Komi|kv| - |Kongo|kg| - |Korean|ko| - |Korku|kfq| - |Koryak|kpy| - |Kosraean|kos| - |Kpelle|kpe| - |Kuanyama|kj| - |Kumyk (Cyrillic)|kum| - |Kurdish (Arabic)|ku-arab| - |Kurdish (Latin)|ku-latn| + |`Fon`|`fon`| + |French|`fr`| + |Friulian|`fur`| + |`Ga`|`gaa`| + |Gagauz (Latin)|`gag`| + |Galician|`gl`| + |Ganda|`lg`| + |Gayo|`gay`| + |German|`de`| + |Gilbertese|`gil`| + |Gondi (Devanagari)|`gon`| + |Greek|`el`| + |Greenlandic|`kl`| + |Guarani|`gn`| + |Gurung (Devanagari)|`gvr`| + |Gusii|`guz`| + |Haitian Creole|`ht`| + |Halbi (Devanagari)|`hlb`| + |Hani|`hni`| + |Haryanvi|`bgc`| + |Hawaiian|`haw`| + |Hebrew|`he`| + |Herero|`hz`| + |Hiligaynon|`hil`| + |Hindi|`hi`| + |Hmong Daw (Latin)|`mww`| + |Ho(Devanagiri)|`hoc`| + |Hungarian|`hu`| + |Iban|`iba`| + |Icelandic|`is`| + |Igbo|`ig`| + |Iloko|`ilo`| + |Inari Sami|`smn`| + |Indonesian|`id`| + |Ingush|`inh`| + |Interlingua|`ia`| + |Inuktitut (Latin)|`iu`| + |Irish|`ga`| + |Italian|`it`| + |Japanese|`ja`| + |Jaunsari (Devanagari)|`Jns`| + |Javanese|`jv`| + |Jola-Fonyi|`dyo`| + |Kabardian|`kbd`| + |Kabuverdianu|`kea`| + |Kachin (Latin)|`kac`| + |Kalenjin|`kln`| + |Kalmyk|`xal`| + |Kangri (Devanagari)|`xnr`| + |Kanuri|`kr`| + |Karachay-Balkar|`krc`| + |Kara-Kalpak (Cyrillic)|`kaa-cyrl`| + |Kara-Kalpak (Latin)|`kaa`| + |Kashubian|`csb`| + |Kazakh (Cyrillic)|`kk-cyrl`| + |Kazakh (Latin)|`kk-latn`| + |Khakas|`kjh`| + |Khaling|`klr`| + |Khasi|`kha`| + |K'iche'|`quc`| + |Kikuyu|`ki`| + |Kildin Sami|`sjd`| + |Kinyarwanda|`rw`| + |Komi|`kv`| + |Kongo|`kg`| + |Korean|`ko`| + |Korku|`kfq`| + |Koryak|`kpy`| + |Kosraean|`kos`| + |Kpelle|`kpe`| + |Kuanyama|`kj`| + |Kumyk (Cyrillic)|`kum`| + |Kurdish (Arabic)|`ku-arab`| + |Kurdish (Latin)|`ku-latn`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Kurukh (Devanagari)|kru| - |Kyrgyz (Cyrillic)|ky| - |Lak|lbe| - |Lakota|lkt| - |Latin|la| - |Latvian|lv| - |Lezghian|lex| - |Lingala|ln| - |Lithuanian|lt| - |Lower Sorbian|dsb| - |Lozi|loz| - |Lule Sami|smj| - |Luo (Kenya and Tanzania)|luo| - |Luxembourgish|lb| - |Luyia|luy| - |Macedonian|mk| - |Machame|jmc| - |Madurese|mad| - |Mahasu Pahari (Devanagari)|bfz| - |Makhuwa-Meetto|mgh| - |Makonde|kde| - |Malagasy|mg| - |Malay (Latin)|ms| - |Maltese|mt| - |Malto (Devanagari)|kmj| - |Mandinka|mnk| - |Manx|gv| - |Maori|mi| - |Mapudungun|arn| - |Marathi|mr| - |Mari (Russia)|chm| - |Masai|mas| - |Mende (Sierra Leone)|men| - |Meru|mer| - |Meta'|mgo| - |Minangkabau|min| - |Mohawk|moh| - |Mongolian (Cyrillic)|mn| - |Mongondow|mog| - |Montenegrin (Cyrillic)|cnr-cyrl| - |Montenegrin (Latin)|cnr-latn| - |Morisyen|mfe| - |Mundang|mua| - |Nahuatl|nah| - |Navajo|nv| - |Ndonga|ng| - |Neapolitan|nap| - |Nepali|ne| - |Ngomba|jgo| - |Niuean|niu| - |Nogay|nog| - |North Ndebele|nd| - |Northern Sami (Latin)|sme| - |Norwegian|no| - |Nyanja|ny| - |Nyankole|nyn| - |Nzima|nzi| - |Occitan|oc| - |Ojibwa|oj| - |Oromo|om| - |Ossetic|os| - |Pampanga|pam| - |Pangasinan|pag| - |Papiamento|pap| - |Pashto|ps| - |Pedi|nso| - |Persian|fa| - |Polish|pl| - |Portuguese|pt| - |Punjabi (Arabic)|pa| - |Quechua|qu| - |Ripuarian|ksh| - |Romanian|ro| - |Romansh|rm| - |Rundi|rn| - |Russian|ru| + |Kurukh (Devanagari)|`kru`| + |Kyrgyz (Cyrillic)|`ky`| + |`Lak`|`lbe`| + |Lakota|`lkt`| + |Latin|`la`| + |Latvian|`lv`| + |Lezghian|`lex`| + |Lingala|`ln`| + |Lithuanian|`lt`| + |Lower Sorbian|`dsb`| + |Lozi|`loz`| + |Lule Sami|`smj`| + |Luo (Kenya and Tanzania)|`luo`| + |Luxembourgish|`lb`| + |Luyia|`luy`| + |Macedonian|`mk`| + |Machame|`jmc`| + |Madurese|`mad`| + |Mahasu Pahari (Devanagari)|`bfz`| + |Makhuwa-Meetto|`mgh`| + |Makonde|`kde`| + |Malagasy|`mg`| + |Malay (Latin)|`ms`| + |Maltese|`mt`| + |Malto (Devanagari)|`kmj`| + |Mandinka|`mnk`| + |Manx|`gv`| + |Maori|`mi`| + |Mapudungun|`arn`| + |Marathi|`mr`| + |Mari (Russia)|`chm`| + |Masai|`mas`| + |Mende (Sierra Leone)|`men`| + |Meru|`mer`| + |Meta'|`mgo`| + |Minangkabau|`min`| + |Mohawk|`moh`| + |Mongolian (Cyrillic)|`mn`| + |Mongondow|`mog`| + |Montenegrin (Cyrillic)|`cnr-cyrl`| + |Montenegrin (Latin)|`cnr-latn`| + |Morisyen|`mfe`| + |Mundang|`mua`| + |Nahuatl|`nah`| + |Navajo|`nv`| + |Ndonga|`ng`| + |Neapolitan|`nap`| + |Nepali|`ne`| + |Ngomba|`jgo`| + |Niuean|`niu`| + |Nogay|`nog`| + |North Ndebele|`nd`| + |Northern Sami (Latin)|`sme`| + |Norwegian|`no`| + |Nyanja|`ny`| + |Nyankole|`nyn`| + |Nzima|`nzi`| + |Occitan|`oc`| + |Ojibwa|`oj`| + |Oromo|`om`| + |Ossetic|`os`| + |Pampanga|`pam`| + |Pangasinan|`pag`| + |Papiamento|`pap`| + |Pashto|`ps`| + |Pedi|`nso`| + |Persian|`fa`| + |Polish|`pl`| + |Portuguese|`pt`| + |Punjabi (Arabic)|`pa`| + |Quechua|`qu`| + |Ripuarian|`ksh`| + |Romanian|`ro`| + |Romansh|`rm`| + |Rundi|`rn`| + |Russian|`ru`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Rwa|rwk| - |Sadri (Devanagari)|sck| - |Sakha|sah| - |Samburu|saq| - |Samoan (Latin)|sm| - |Sango|sg| - |Sangu (Gabon)|snq| - |Sanskrit (Devanagari)|sa| - |Santali(Devanagiri)|sat| - |Scots|sco| - |Scottish Gaelic|gd| - |Sena|seh| - |Serbian (Cyrillic)|sr-cyrl| - |Serbian (Latin)|sr, sr-latn| - |Shambala|ksb| - |Shona|sn| - |Siksika|bla| - |Sirmauri (Devanagari)|srx| - |Skolt Sami|sms| - |Slovak|sk| - |Slovenian|sl| - |Soga|xog| - |Somali (Arabic)|so| - |Somali (Latin)|so-latn| - |Songhai|son| - |South Ndebele|nr| - |Southern Altai|alt| - |Southern Sami|sma| - |Southern Sotho|st| - |Spanish|es| - |Sundanese|su| - |Swahili (Latin)|sw| - |Swati|ss| - |Swedish|sv| - |Tabassaran|tab| - |Tachelhit|shi| - |Tahitian|ty| - |Taita|dav| - |Tajik (Cyrillic)|tg| - |Tamil|ta| - |Tatar (Cyrillic)|tt-cyrl| - |Tatar (Latin)|tt| - |Teso|teo| - |Tetum|tet| - |Thai|th| - |Thangmi|thf| - |Tok Pisin|tpi| - |Tongan|to| - |Tsonga|ts| - |Tswana|tn| - |Turkish|tr| - |Turkmen (Latin)|tk| - |Tuvan|tyv| - |Udmurt|udm| - |Uighur (Cyrillic)|ug-cyrl| - |Ukrainian|uk| - |Upper Sorbian|hsb| - |Urdu|ur| - |Uyghur (Arabic)|ug| - |Uzbek (Arabic)|uz-arab| - |Uzbek (Cyrillic)|uz-cyrl| - |Uzbek (Latin)|uz| - |Vietnamese|vi| - |Volap├╝k|vo| - |Vunjo|vun| - |Walser|wae| - |Welsh|cy| - |Western Frisian|fy| - |Wolof|wo| - |Xhosa|xh| - |Yucatec Maya|yua| - |Zapotec|zap| - |Zarma|dje| - |Zhuang|za| - |Zulu|zu| + |`Rwa`|`rwk`| + |Sadri (Devanagari)|`sck`| + |Sakha|`sah`| + |Samburu|`saq`| + |Samoan (Latin)|`sm`| + |Sango|`sg`| + |Sangu (Gabon)|`snq`| + |Sanskrit (Devanagari)|`sa`| + |Santali(Devanagiri)|`sat`| + |Scots|`sco`| + |Scottish Gaelic|`gd`| + |Sena|`seh`| + |Serbian (Cyrillic)|`sr-cyrl`| + |Serbian (Latin)|`sr`, `sr-latn`| + |Shambala|`ksb`| + |Shona|`sn`| + |Siksika|`bla`| + |Sirmauri (Devanagari)|`srx`| + |Skolt Sami|`sms`| + |Slovak|`sk`| + |Slovenian|`sl`| + |Soga|`xog`| + |Somali (Arabic)|`so`| + |Somali (Latin)|`so-latn`| + |Songhai|`son`| + |South Ndebele|`nr`| + |Southern Altai|`alt`| + |Southern Sami|`sma`| + |Southern Sotho|`st`| + |Spanish|`es`| + |Sundanese|`su`| + |Swahili (Latin)|`sw`| + |Swati|`ss`| + |Swedish|`sv`| + |Tabassaran|`tab`| + |Tachelhit|`shi`| + |Tahitian|`ty`| + |Taita|`dav`| + |Tajik (Cyrillic)|`tg`| + |Tamil|`ta`| + |Tatar (Cyrillic)|`tt-cyrl`| + |Tatar (Latin)|`tt`| + |Teso|`teo`| + |Tetum|`tet`| + |Thai|`th`| + |Thangmi|`thf`| + |Tok Pisin|`tpi`| + |Tongan|`to`| + |Tsonga|`ts`| + |Tswana|`tn`| + |Turkish|`tr`| + |Turkmen (Latin)|`tk`| + |Tuvan|`tyv`| + |Udmurt|`udm`| + |Uighur (Cyrillic)|`ug-cyrl`| + |Ukrainian|`uk`| + |Upper Sorbian|`hsb`| + |Urdu|`ur`| + |Uyghur (Arabic)|`ug`| + |Uzbek (Arabic)|`uz-arab`| + |Uzbek (Cyrillic)|`uz-cyrl`| + |Uzbek (Latin)|`uz`| + |Vietnamese|`vi`| + |Volap├╝k|`vo`| + |Vunjo|`vun`| + |Walser|`wae`| + |Welsh|`cy`| + |Western Frisian|`fy`| + |Wolof|`wo`| + |Xhosa|`xh`| + |Yucatec Maya|`yua`| + |Zapotec|`zap`| + |Zarma|`dje`| + |Zhuang|`za`| + |Zulu|`zu`| :::column-end::: :::row-end::: The following table lists layout model language support for extracting and analy :::row::: :::column span="":::- |Language| Code (optional) | + |**Language**| **Code (optional)**| |:--|:-:|- |Afrikaans|af| - |Angika|anp| - |Arabic|ar| - |Asturian|ast| - |Awadhi|awa| - |Azerbaijani|az| - |Belarusian (Cyrillic)|be, be-cyrl| - |Belarusian (Latin)|be-latn| - |Bagheli|bfy| - |Mahasu Pahari|bfz| - |Bulgarian|bg| - |Haryanvi|bgc| - |Bhojpuri|bho| - |Bislama|bi| - |Bundeli|bns| - |Breton|br| - |Braj|bra| - |Bodo|brx| - |Bosnian|bs| - |Buriat|bua| - |Catalan|ca| - |Cebuano|ceb| - |Chamorro|ch| - |Montenegrin (Latin)|cnr, cnr-latn| - |Montenegrin (Cyrillic)|cnr-cyrl| - |Corsican|co| - |Crimean Tatar|crh| - |Czech|cs| - |Kashubian|csb| - |Welsh|cy| - |Danish|da| - |German|de| - |Dhimal|dhi| - |Dogri|doi| - |Lower Sorbian|dsb| - |English|en| - |Spanish|es| - |Estonian|et| - |Basque|eu| - |Persian|fa| - |Finnish|fi| - |Filipino|fil| + |Afrikaans|`af`| + |Angika|`anp`| + |Arabic|`ar`| + |Asturian|`ast`| + |Awadhi|`awa`| + |Azerbaijani|`az`| + |Belarusian (Cyrillic)|`be`, `be-cyrl`| + |Belarusian (Latin)|`be-latn`| + |Bagheli|`bfy`| + |Mahasu Pahari|`bfz`| + |Bulgarian|`bg`| + |Haryanvi|`bgc`| + |Bhojpuri|`bho`| + |Bislama|`bi`| + |Bundeli|`bns`| + |Breton|`br`| + |Braj|`bra`| + |Bodo|`brx`| + |Bosnian|`bs`| + |Buriat|`bua`| + |Catalan|`ca`| + |Cebuano|`ceb`| + |Chamorro|`ch`| + |Montenegrin (Latin)|`cnr`, `cnr-latn`| + |Montenegrin (Cyrillic)|`cnr-cyrl`| + |Corsican|`co`| + |Crimean Tatar|`crh`| + |Czech|`cs`| + |Kashubian|`csb`| + |Welsh|`cy`| + |Danish|`da`| + |German|`de`| + |Dhimal|`dhi`| + |Dogri|`doi`| + |Lower Sorbian|`dsb`| + |English|`en`| + |Spanish|`es`| + |Estonian|`et`| + |Basque|`eu`| + |Persian|`fa`| + |Finnish|`fi`| + |Filipino|`fil`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Fijian|fj| - |Faroese|fo| - |French|fr| - |Friulian|fur| - |Western Frisian|fy| - |Irish|ga| - |Gagauz|gag| - |Scottish Gaelic|gd| - |Gilbertese|gil| - |Galician|gl| - |Gondi|gon| - |Manx|gv| - |Gurung|gvr| - |Hawaiian|haw| - |Hindi|hi| - |Halbi|hlb| - |Chhattisgarhi|hne| - |Hani|hni| - |Ho|hoc| - |Croatian|hr| - |Upper Sorbian|hsb| - |Haitian|ht| - |Hungarian|hu| - |Interlingua|ia| - |Indonesian|id| - |Icelandic|is| - |Italian|it| - |Inuktitut|iu| + |Fijian|`fj`| + |Faroese|`fo`| + |French|`fr`| + |Friulian|`fur`| + |Western Frisian|`fy`| + |Irish|`ga`| + |Gagauz|`gag`| + |Scottish Gaelic|`gd`| + |Gilbertese|`gil`| + |Galician|`gl`| + |Gondi|`gon`| + |Manx|`gv`| + |Gurung|`gvr`| + |Hawaiian|`haw`| + |Hindi|`hi`| + |Halbi|`hlb`| + |Chhattisgarhi|`hne`| + |Hani|`hni`| + |`Ho`|`hoc`| + |Croatian|`hr`| + |Upper Sorbian|`hsb`| + |Haitian|`ht`| + |Hungarian|`hu`| + |Interlingua|`ia`| + |Indonesian|`id`| + |Icelandic|`is`| + |Italian|`it`| + |Inuktitut|`iu`| |Japanese|- |Jaunsari|jns| - |Javanese|jv| - |Kara-Kalpak (Latin)|kaa, kaa-latn| - |Kara-Kalpak (Cyrillic)|kaa-cyrl| - |Kachin|kac| - |Kabuverdianu|kea| - |Korku|kfq| - |Khasi|kha| - |Kazakh (Latin)|kk, kk-latn| - |Kazakh (Cyrillic)|kk-cyrl| - |Kalaallisut|kl| - |Khaling|klr| - |Malto|kmj| + |Jaunsari|`jns`| + |Javanese|`jv`| + |Kara-Kalpak (Latin)|`kaa`, `kaa-latn`| + |Kara-Kalpak (Cyrillic)|`kaa-cyrl`| + |Kachin|`kac`| + |Kabuverdianu|`kea`| + |Korku|`kfq`| + |Khasi|`kha`| + |Kazakh (Latin)|`kk`, `kk-latn`| + |Kazakh (Cyrillic)|`kk-cyrl`| + |Kalaallisut|`kl`| + |Khaling|`klr`| + |Malto|`kmj`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:| |Korean|- |Kosraean|kos| - |Koryak|kpy| - |Karachay-Balkar|krc| - |Kurukh|kru| - |K├╢lsch|ksh| - |Kurdish (Latin)|ku, ku-latn| - |Kurdish (Arabic)|ku-arab| - |Kumyk|kum| - |Cornish|kw| - |Kirghiz|ky| - |Latin|la| - |Luxembourgish|lb| - |Lakota|lkt| - |Lithuanian|lt| - |Maori|mi| - |Mongolian|mn| - |Marathi|mr| - |Malay|ms| - |Maltese|mt| - |Hmong Daw|mww| - |Erzya|myv| - |Neapolitan|nap| - |Nepali|ne| - |Niuean|niu| - |Dutch|nl| - |Norwegian|no| - |Nogai|nog| - |Occitan|oc| - |Ossetian|os| - |Panjabi|pa| - |Polish|pl| - |Dari|prs| - |Pushto|ps| - |Portuguese|pt| - |K'iche'|quc| - |Camling|rab| - |Romansh|rm| - |Romanian|ro| - |Russian|ru| - |Sanskrit|sa| - |Santali|sat| + |Kosraean|`kos`| + |Koryak|`kpy`| + |Karachay-Balkar|`krc`| + |Kurukh|`kru`| + |K├╢lsch|`ksh`| + |Kurdish (Latin)|`ku`, `ku-latn`| + |Kurdish (Arabic)|`ku-arab`| + |Kumyk|`kum`| + |Cornish|`kw`| + |Kirghiz|`ky`| + |Latin|`la`| + |Luxembourgish|`lb`| + |Lakota|`lkt`| + |Lithuanian|`lt`| + |Maori|`mi`| + |Mongolian|`mn`| + |Marathi|`mr`| + |Malay|`ms`| + |Maltese|`mt`| + |Hmong `Daw`|`mww`| + |Erzya|`myv`| + |Neapolitan|`nap`| + |Nepali|`ne`| + |Niuean|`niu`| + |Dutch|`nl`| + |Norwegian|`no`| + |Nogai|`nog`| + |Occitan|`oc`| + |Ossetian|`os`| + |Panjabi|`pa`| + |Polish|`pl`| + |Dari|`prs`| + |Pushto|`ps`| + |Portuguese|`pt`| + |K'iche'|`quc`| + |Camling|`rab`| + |Romansh|`rm`| + |Romanian|`ro`| + |Russian|`ru`| + |Sanskrit|`sa`| + |Santali|`sat`| :::column-end::: :::column span=""::: |Language| Code (optional) | |:--|:-:|- |Sadri|sck| - |Scots|sco| - |Slovak|sk| - |Slovenian|sl| - |Samoan|sm| - |Southern Sami|sma| - |Northern Sami|sme| - |Lule Sami|smj| - |Inari Sami|smn| - |Skolt Sami|sms| - |Somali|so| - |Albanian|sq| - |Serbian (Latin)|sr, sr-latn| - |Sirmauri|srx| - |Swedish|sv| - |Swahili|sw| - |Tetum|tet| - |Tajik|tg| - |Thangmi|thf| - |Turkmen|tk| - |Tonga|to| - |Turkish|tr| - |Tatar|tt| - |Tuvinian|tyv| - |Uighur|ug| - |Urdu|ur| - |Uzbek (Latin)|uz, uz-latn| - |Uzbek (Cyrillic)|uz-cyrl| - |Uzbek (Arabic)|uz-arab| - |Volap├╝k|vo| - |Walser|wae| - |Kangri|xnr| - |Yucateco|yua| - |Zhuang|za| - |Chinese (Han (Simplified variant))|zh, zh-hans| - |Chinese (Han (Traditional variant))|zh-hant| - |Zulu|zu| + |Sadri|`sck`| + |Scots|`sco`| + |Slovak|`sk`| + |Slovenian|`sl`| + |Samoan|`sm`| + |Southern Sami|`sma`| + |Northern Sami|`sme`| + |Lule Sami|`smj`| + |Inari Sami|`smn`| + |Skolt Sami|`sms`| + |Somali|`so`| + |Albanian|`sq`| + |Serbian (Latin)|`sr`, `sr-latn`| + |Sirmauri|`srx`| + |Swedish|`sv`| + |Swahili|`sw`| + |Tetum|`tet`| + |Tajik|`tg`| + |Thangmi|`thf`| + |Turkmen|`tk`| + |Tonga|`to`| + |Turkish|`tr`| + |Tatar|`tt`| + |Tuvinian|`tyv`| + |Uighur|`ug`| + |Urdu|`ur`| + |Uzbek (Latin)|`uz`, `uz-latn`| + |Uzbek (Cyrillic)|`uz-cyrl`| + |Uzbek (Arabic)|`uz-arab`| + |Volap├╝k|`vo`| + |Walser|`wae`| + |Kangri|`xnr`| + |Yucateco|`yua`| + |Zhuang|`za`| + |Chinese (Han (Simplified variant))|`zh`, `zh-hans`| + |Chinese (Han (Traditional variant))|`zh-hant`| + |Zulu|`zu`| :::column-end::: :::row-end::: The following table lists layout model language support for extracting and analy :::row-end::: :::moniker-end +### [**Layout: handwritten text**](#tab/layout-hand) +++The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| Russian (preview) | `ru` | +|Thai (preview) | `th` | Arabic (preview) | `ar` | +++##### Model ID: **prebuilt-layout** ++The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| +++ > [!NOTE] + > Document Intelligence v2.1 does not support handwritten text extraction. ++++The following table lists layout model language support for extracting and analyzing **handwritten** text. </br> ++|Language| Language code (optional) | Language| Language code (optional) | +|:--|:-:|:--|:-:| +|English|`en`|Japanese |`ja`| +|Chinese Simplified |`zh-Hans`|Korean |`ko`| +|French |`fr`|Portuguese |`pt`| +|German |`de`|Spanish |`es`| +|Italian |`it`| Russian (preview) | `ru` | +|Thai (preview) | `th` | Arabic (preview) | `ar` | + ## General document The following table lists layout model language support for extracting and analy :::moniker range="doc-intel-4.0.0" > [!IMPORTANT]-> Starting with Document Intelligence **v4.0:2023-10-31-preview** and going forward, the general document model (prebuilt-document) is deprecated. To extract key-value pairs, selection marks, text, tables, and structure from documents, use the following models: +> Starting with Document Intelligence **v4.0:2023-10-31-preview** and going forward, the general document model (prebuilt-document) is being added to layout (prebuilt-layout). To extract key-value pairs, selection marks, text, tables, and structure from documents, use the following models: -| Feature | version| Model ID | +| Key value pairs | version| Model ID | |- ||--|-|Layout model with **`features=keyValuePairs`** specified.|• v4:2023-10-31-preview</br>• v3.1:2023-07-31 (GA) |**`prebuilt-layout`**| -|General document model|• v3.1:2023-07-31 (GA)</br>• v3.0:2022-08-31 (GA)</br>• v2.1 (GA)|**`prebuilt-document`**| +|**Layout model** with query string **`features=keyValuePairs`** specified.|• v4:2023-10-31-preview</br>• v3.1:2023-07-31 (GA) |**`prebuilt-layout`**| +|General document model|• v3.1:2023-07-31 (GA)</br>• v3.0:2022-08-31 (GA)|**`prebuilt-document`**| :::moniker-end :::moniker range="doc-intel-3.1.0 || doc-intel-3.0.0" The following table lists layout model language support for extracting and analy The following table lists general document model language support. </br> -| Model ID| LanguageΓÇöLocale code | Default | +| Model `ID`| LanguageΓÇöLocale code | Default | |--|:-|:|-|**prebuilt-document**| English (United States)ΓÇöen-US| English (United States)ΓÇöen-US| +|**prebuilt-document**| English (United States)ΓÇöen-`US`| English (United States)ΓÇöen-`US`| :::moniker-end |
| ai-services | Language Support Prebuilt | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/language-support-prebuilt.md | Azure AI Document Intelligence models provide multilingual document processing s :::moniker range="doc-intel-4.0.0" > [!IMPORTANT]-> Starting with Document Intelligence **v4.0 (preview)**, and going forward, the business card model (prebuilt-businessCard) is deprecated. To extract data from business card formats, use the following: +> Starting with Document Intelligence **v4.0 (preview)**, and going forward, the business card model (prebuilt-businessCard) is deprecated. To extract data from business cards, use the following: | Feature | version| Model ID | |- ||--| Azure AI Document Intelligence models provide multilingual document processing s ***Model ID: prebuilt-businessCard*** -| LanguageΓÇöLocale code | Default | +| Language Locale code | Default | |:-|:|-| • English (United States)ΓÇöen-US</br>• English (Australia)ΓÇöen-AU</br>• English (Canada)ΓÇöen-CA</br>• English (United Kingdom)ΓÇöen-GB</br>• English (India)ΓÇöen-IN</br>• English (Japan)ΓÇöen-JP</br>• Japanese (Japan)ΓÇöja-JP | Autodetected (en-US or ja-JP) +| • English (United States) `en-US`</br>• English (Australia) en-AU</br>• English (Canada) `en-CA`</br>• English (United Kingdom)`en-GB`</br>• English (India) `en-IN`</br>• English (Japan) `en-JP`</br>• Japanese (Japan) `ja-JP` | Autodetected (en-US or ja-JP) :::moniker-end :::moniker range="doc-intel-2.1.0" -| LanguageΓÇöLocale code | Default | +| Language Locale code | Default | |:-|:|-|• English (United States)ΓÇöen-US</br>• English (Australia)ΓÇöen-AU</br>• English (Canada)ΓÇöen-CA</br>• English (United Kingdom)ΓÇöen-GB</br>• English (India)ΓÇöen-IN</li> | Autodetected | +|• English (United States) `en-US`</br>• English (Australia) en-AU</br>• English (Canada) en-CA</br>• English (United Kingdom) en-GB</br>• English (India) en-IN</li> | Autodetected | :::moniker-end ## Contract ***Model ID: prebuilt-contract*** -| LanguageΓÇöLocale code | Default | +| Language Locale code | Default | |:-|:|-| English (United States)ΓÇöen-US| English (United States)ΓÇöen-US| +| English (United States) `en-US`| English (United States) `en-US`| :::moniker-end Azure AI Document Intelligence models provide multilingual document processing s ***Model ID: prebuilt-healthInsuranceCard.us*** -| LanguageΓÇöLocale code | Default | +| Language Locale code | Default | |:-|:|-| English (United States)|English (United States)ΓÇöen-US| +| English (United States)|English (United States) `en-US`| :::moniker-end Azure AI Document Intelligence models provide multilingual document processing s ::: moniker-end | Region | Document types | |--|-| Azure AI Document Intelligence models provide multilingual document processing s | • Serbian (sr-Latn) | Serbia (latn-rs)| | • Albanian (`sq`) | Albania (`al`)| | • Swedish (`sv`) | Sweden (`se`)|-| • Chinese (simplified (zh-hans)) | China (zh-hans-cn)| -| • Chinese (traditional (zh-hant)) | Hong Kong SAR (zh-hant-hk), Taiwan (zh-hant-tw)| +| • Chinese (simplified (`zh-hans`)) | China (`zh-hans-cn`)| +| • Chinese (traditional (`zh-hant`)) | Hong Kong SAR (`zh-hant-hk`), Taiwan (`zh-hant-tw`)| ### [Supported Currency Codes](#tab/currency) Azure AI Document Intelligence models provide multilingual document processing s |Latvian|``lv``|Xitsonga|`ts`| |Lingala|``ln``||| - ### [Hotel receipts](#tab/hotel) | Supported Languages|Language code | |:--|:| Azure AI Document Intelligence models provide multilingual document processing s ::: moniker range="doc-intel-2.1.0" -| Model | LanguageΓÇöLocale code | Default | +| Model | Language Locale code | Default | |--|:-|:|-|Receipt| • English (United States)ΓÇöen-US</br> • English (Australia)ΓÇöen-AU</br> • English (Canada)ΓÇöen-CA</br> • English (United Kingdom)ΓÇöen-GB</br> • English (India)ΓÇöen-IN | Autodetected | +|Receipt| • English (United States) `en-US`</br> • English (Australia) `en-AU`</br> • English (Canada) `en-CA`</br> • English (United Kingdom) `en-GB`</br> • English (India) `en-IN`| Autodetected | ::: moniker-end ## Tax documents :::moniker range="doc-intel-4.0.0"- | Model ID | LanguageΓÇöLocale code | Default | + | Model ID | Language Locale code | Default | |--|:-|:|- |**prebuilt-tax.us.w2**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098E**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098T**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1099**|English (United States)|English (United States)ΓÇöen-US| + |**prebuilt-tax.us.w2**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098E**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098T**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1099**|English (United States)|English (United States) `en-US`| :::moniker-end :::moniker range="doc-intel-3.1.0"- | Model ID | LanguageΓÇöLocale code | Default | + | Model ID | Language Locale code | Default | |--|:-|:|- |**prebuilt-tax.us.w2**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098E**|English (United States)|English (United States)ΓÇöen-US| - |**prebuilt-tax.us.1098T**|English (United States)|English (United States)ΓÇöen-US| + |**prebuilt-tax.us.w2**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098E**|English (United States)|English (United States) `en-US`| + |**prebuilt-tax.us.1098T**|English (United States)|English (United States) `en-US`| :::moniker-end :::moniker range="doc-intel-3.0.0"- | Model ID | LanguageΓÇöLocale code | Default | + | Model ID | Language Locale code | Default | |--|:-|:|- |**prebuilt-tax.us.w2**|English (United States)|English (United States)ΓÇöen-US| + |**prebuilt-tax.us.w2**|English (United States)|English (United States) `en-US`| :::moniker-end |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/overview.md | Document analysis models enable text extraction from forms and documents and ret :::column-end::: :::column span=""::: :::image type="icon" source="media/overview/icon-layout.png" link="#layout":::</br>- [**Layout**](#layout) | Extract text </br>and document structure. + [**Layout**](#layout) | Extract text, tables, </br>and document structure. :::column-end::: :::row-end::: :::moniker-end You can use Document Intelligence to automate document processing in application |Model ID| Description |Automation use cases | Development options | |-|--|-|--|-|[**prebuilt-read**](concept-read.md)|● Extract **text** from documents.</br>● [Data and field extraction](concept-read.md#read-model-data-extraction)| ● Contract processing. </br>● Financial or medical report processing.|● [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/read)</br>● [**REST API**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&preserve-view=true&pivots=programming-language-rest-api)</br>● [**C# SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&preserve-view=true&pivots=programming-language-csharp)</br>● [**Python SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&preserve-view=true&pivots=programming-language-python)</br>● [**Java SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&preserve-view=true&pivots=programming-language-java)</br>● [**JavaScript**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-3.0.0&preserve-view=true&pivots=programming-language-javascript) | +|[**prebuilt-read**](concept-read.md)|● Extract **text** from documents.</br>● [Data extraction](concept-read.md#read-model-data-extraction)| ● Digitizing any document. </br>● Compliance and auditing. ● Processing handwritten notes before translation.|● [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/read)</br>● [**REST API**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api)</br>● [**C# SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-csharp)</br>● [**Python SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-python)</br>● [**Java SDK**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-java)</br>● [**JavaScript**](how-to-guides/use-sdk-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-javascript) | > [!div class="nextstepaction"] > [Return to model types](#document-analysis-models) You can use Document Intelligence to automate document processing in application | Model ID | Description |Automation use cases | Development options | |-|--|-|--|-|[**prebuilt-layout**](concept-layout.md) |● Extract **text and layout** information from documents.</br>● [Data and field extraction](concept-layout.md#data-extraction)</br>● Layout API is updated to a prebuilt model. |● Document indexing and retrieval by structure.</br>● Preprocessing prior to OCR analysis. |● [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/layout)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model)| +|[**prebuilt-layout**](concept-layout.md) |● Extract **text and layout** information from documents.</br>● [Data extraction](concept-layout.md#data-extraction) |● Document indexing and retrieval by structure.</br>● Financial and medical report analysis. |● [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/layout)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#layout-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#layout-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#layout-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#layout-model)| > [!div class="nextstepaction"] > [Return to model types](#document-analysis-models) |
| ai-services | Service Limits | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/service-limits.md | This article contains both a quick reference and detailed description of Azure A ## Model usage +|Document types supported|Read|Layout|Prebuilt models|Custom models| +|--|--|--|--|--| +| PDF | ✔️ | ✔️ | ✔️ | ✔️ | +| Images (JPEG/JPG), PNG, BMP, TIFF, HEIF | ✔️ | ✔️ | ✔️ | ✔️ | +| Office file types DOCX, PPTX, XLS | ✔️ | ✖️ | ✖️ | ✖️ | + :::moniker range="doc-intel-4.0.0" |Document types supported|Read|Layout|Prebuilt models|Custom models| |--|--|--|--|--| | PDF | ✔️ | ✔️ | ✔️ | ✔️ | | Images (JPEG/JPG), PNG, BMP, TIFF, HEIF | ✔️ | ✔️ | ✔️ | ✔️ |-| Office file types DOCX, PPT, XLS | ✔️ | ✔️ | ✖️ | ✖️ | +| Office file types DOCX, PPTX, XLS | ✔️ | ✔️ | ✖️ | ✖️ | :::moniker-end ::: moniker range=">=doc-intel-3.0.0" |
| ai-services | Studio Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/studio-overview.md | monikerRange: '>=doc-intel-3.0.0' Document Intelligence Studio is an online tool to visually explore, understand, train, and integrate features from the Document Intelligence service into your applications. The studio provides a platform for you to experiment with the different Document Intelligence models and sample returned data in an interactive manner without the need to write code. -The studio supports Document Intelligence v3.0 models and v3.0 model training. Previously trained v2.1 models with labeled data are supported, but not v2.1 model training. Refer to the [REST API migration guide](v3-1-migration-guide.md) for detailed information about migrating from v2.1 to v3.0. +[Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the Document Intelligence Studio to: +* Learn more about the different capabilities in Document Intelligence. +* Use your Document Intelligence resource to test models on sample documents or upload your own documents. +* Experiment with different add-on and preview features to adapt the output to your needs. +* Train custom classification models to classify documents. +* Train custom extraction models to extract fields from documents. +* Get sample code for the language specific SDKs to integrate into your applications. ++The studio supports Document Intelligence v3.0 and later API versions for model analysis and custom model training. Previously trained v2.1 models with labeled data are supported, but not v2.1 model training. Refer to the [REST API migration guide](v3-1-migration-guide.md) for detailed information about migrating from v2.1 to v3.0. ## Get started using Document Intelligence Studio The studio supports Document Intelligence v3.0 models and v3.0 model training. P 1. Navigate to the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/). If it's your first time logging in, a popup window appears prompting you to configure your service resource. You have two options: - **a. Access by Resource**. + **a. Access by Resource (recommended)**. * Choose your existing subscription. * Select an existing resource group within your subscription or create a new one. The studio supports Document Intelligence v3.0 models and v3.0 model training. P :::image type="content" source="media/containers/keys-and-endpoint.png" alt-text="Screenshot of keys and endpoint location in the Azure portal."::: -1. Once you've completed configuring your resource, you're able to try the different models offered by Document Intelligence Studio. From the front page, select any Document Intelligence model to try using with a no-code approach. +1. Once the resource is configured, you're able to try the different models offered by Document Intelligence Studio. From the front page, select any Document Intelligence model to try using with a no-code approach. :::image type="content" source="media/studio/welcome-to-studio.png" alt-text="Screenshot of Document Intelligence Studio front page."::: -1. After you've tried Document Intelligence Studio, use the [**C#**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**Java**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) or [**Python**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) client libraries or the [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) to get started incorporating Document Intelligence models into your own applications. +1. To test any of the document analysis or prebuilt models, select the model and use one o the sample documents or upload your own document to analyze. The analysis result is displayed at the right in the content-result-code window. ++1. Custom models need to be trained on your documents. See [custom models overview](concept-custom.md) for an overview of custom models. ++1. After validating the scenario in the Document Intelligence Studio, use the [**C#**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**Java**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) or [**Python**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) client libraries or the [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) to get started incorporating Document Intelligence models into your own applications. To learn more about each model, *see* concept pages. |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/document-intelligence/whats-new.md | +> [!IMPORTANT] +> Preview API versions are retured once the GA API is released. The 2023-02-28-preview API version is being retired, if you are still using the preview API or the associated SDK versions, please update your code to target the 2023-07-31 API version. + ## December 2023 The [Document Intelligence SDKs](sdk-overview-v4-0.md) targeting REST API **2023-10-31-preview** are now available for use! |
| ai-services | Cost Management | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/cost-management.md | |
| ai-services | Data Feeds From Different Sources | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/data-feeds-from-different-sources.md | |
| ai-services | Encryption | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/encryption.md | |
| ai-services | Glossary | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/glossary.md | |
| ai-services | Alerts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/alerts.md | |
| ai-services | Anomaly Feedback | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/anomaly-feedback.md | |
| ai-services | Configure Metrics | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/configure-metrics.md | |
| ai-services | Credential Entity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/credential-entity.md | |
| ai-services | Diagnose An Incident | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/diagnose-an-incident.md | |
| ai-services | Further Analysis | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/further-analysis.md | |
| ai-services | Manage Data Feeds | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/manage-data-feeds.md | |
| ai-services | Metrics Graph | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/metrics-graph.md | |
| ai-services | Onboard Your Data | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/how-tos/onboard-your-data.md | |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/overview.md | |
| ai-services | Rest Api And Client Library | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/quickstarts/rest-api-and-client-library.md | |
| ai-services | Web Portal | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/quickstarts/web-portal.md | description: Learn how to start using the Metrics Advisor web portal. Previously updated : 11/07/2022 Last updated : 01/19/2024 |
| ai-services | Enable Anomaly Notification | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/tutorials/enable-anomaly-notification.md | |
| ai-services | Write A Valid Query | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/tutorials/write-a-valid-query.md | |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/metrics-advisor/whats-new.md | |
| ai-services | Abuse Monitoring | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/abuse-monitoring.md | -keywords: # Abuse Monitoring |
| ai-services | Content Credentials | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/content-credentials.md | -keywords: # Content Credentials |
| ai-services | Content Filter | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/content-filter.md | -keywords: # Content filtering |
| ai-services | Gpt With Vision | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/gpt-with-vision.md | -keywords: # GPT-4 Turbo with Vision concepts |
| ai-services | Legacy Models | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/legacy-models.md | -keywords: # Azure OpenAI Service legacy models |
| ai-services | Model Versions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/model-versions.md | description: Learn about model versions in Azure OpenAI. Last updated 10/30/2023- recommendations: false-keywords: # Azure OpenAI Service model versions |
| ai-services | Models | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/models.md | -keywords: # Azure OpenAI Service models |
| ai-services | Prompt Engineering | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/prompt-engineering.md | -keywords: # Introduction to prompt engineering |
| ai-services | Provisioned Throughput | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/provisioned-throughput.md | Title: Azure OpenAI Service provisioned throughput description: Learn about provisioned throughput and Azure OpenAI. Previously updated : 1/16/2024- Last updated : 1/16/2024 recommendations: false-keywords: # What is provisioned throughput? |
| ai-services | Red Teaming | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/red-teaming.md | description: Learn about how red teaming and adversarial testing are an essentia Last updated 11/03/2023- recommendations: false-keywords: # Planning red teaming for large language models (LLMs) and their applications |
| ai-services | System Message | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/concepts/system-message.md | -keywords: # System message framework and template recommendations for Large Language Models (LLMs) |
| ai-services | Business Continuity Disaster Recovery | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/business-continuity-disaster-recovery.md | Last updated 8/17/2023 recommendations: false-keywords: |
| ai-services | Completions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/completions.md | Last updated 08/15/2023 recommendations: false-keywords: |
| ai-services | Content Filters | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/content-filters.md | Last updated 6/5/2023 recommendations: false-keywords: # How to configure content filters with Azure OpenAI Service |
| ai-services | Embeddings | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/embeddings.md | Last updated 01/16/2024 recommendations: false-keywords: # Learn how to generate embeddings with Azure OpenAI |
| ai-services | Fine Tuning | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/fine-tuning.md | Last updated 10/12/2023 zone_pivot_groups: openai-fine-tuning-keywords: # Customize a model with fine-tuning |
| ai-services | Gpt With Vision | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/gpt-with-vision.md | description: Learn about the options for using GPT-4 Turbo with Vision - Last updated 11/06/2023 -keywords: # Use GPT-4 Turbo with Vision |
| ai-services | Json Mode | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/json-mode.md | Last updated 12/05/2023 recommendations: false-keywords: |
| ai-services | Provisioned Throughput Onboarding | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/provisioned-throughput-onboarding.md | description: Learn about provisioned throughput units onboarding and Azure OpenA Last updated 01/15/2024- recommendations: false-keywords: # Provisioned throughput units onboarding |
| ai-services | Reproducible Output | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/reproducible-output.md | Last updated 11/17/2023 recommendations: false-keywords: |
| ai-services | Use Blocklists | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/use-blocklists.md | -keywords: # Use a blocklist in Azure OpenAI |
| ai-services | Use Your Data Securely | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/use-your-data-securely.md | To allow access to your Azure OpenAI service from your client machines, like usi ## Configure Azure AI Search +You can use basic pricing tier and higher for the configuration below. You donΓÇÖt have to use S2 pricing tier because the configuration doesn't require [private endpoint support for indexers with a skill set](/azure/search/search-limits-quotas-capacity#shared-private-link-resource-limits). See [step 8](#data-ingestion-architecture) of the data ingestion architecture diagram. The networking for custom skill is *bypass trusted service*, not *private endpoint*. + ### Enable managed identity To allow your other resources to recognize the Azure AI Search using Microsoft Entra ID authentication, you need to assign a managed identity for your Azure AI Search. The easiest way is to toggle on the system assigned managed identity in the Azure portal. |
| ai-services | Work With Code | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/work-with-code.md | -keywords: # Codex models and Azure OpenAI Service |
| ai-services | Working With Models | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/how-to/working-with-models.md | -keywords: # Working with Azure OpenAI models |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/overview.md | -keywords: # What is Azure OpenAI Service? |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/openai/whats-new.md | -keywords: # What's new in Azure OpenAI Service |
| ai-services | Concept Active Inactive Events | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-active-inactive-events.md | |
| ai-services | Concept Active Learning | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-active-learning.md | |
| ai-services | Concept Apprentice Mode | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-apprentice-mode.md | |
| ai-services | Concept Auto Optimization | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-auto-optimization.md | |
| ai-services | Concept Multi Slot Personalization | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-multi-slot-personalization.md | |
| ai-services | Concept Rewards | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concept-rewards.md | |
| ai-services | Concepts Exploration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concepts-exploration.md | |
| ai-services | Concepts Features | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concepts-features.md | |
| ai-services | Concepts Offline Evaluation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concepts-offline-evaluation.md | |
| ai-services | Concepts Reinforcement Learning | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concepts-reinforcement-learning.md | |
| ai-services | Concepts Scalability Performance | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/concepts-scalability-performance.md | |
| ai-services | Encrypt Data At Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/encrypt-data-at-rest.md | |
| ai-services | How Personalizer Works | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-personalizer-works.md | |
| ai-services | How To Create Resource | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-create-resource.md | |
| ai-services | How To Feature Evaluation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-feature-evaluation.md | |
| ai-services | How To Inference Explainability | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-inference-explainability.md | |
| ai-services | How To Learning Behavior | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-learning-behavior.md | |
| ai-services | How To Manage Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-manage-model.md | |
| ai-services | How To Multi Slot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-multi-slot.md | |
| ai-services | How To Offline Evaluation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-offline-evaluation.md | |
| ai-services | How To Settings | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-settings.md | |
| ai-services | How To Thick Client | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/how-to-thick-client.md | |
| ai-services | Quickstart Personalizer Sdk | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/quickstart-personalizer-sdk.md | |
| ai-services | Responsible Characteristics And Limitations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/responsible-characteristics-and-limitations.md | |
| ai-services | Responsible Data And Privacy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/responsible-data-and-privacy.md | |
| ai-services | Responsible Guidance Integration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/responsible-guidance-integration.md | |
| ai-services | Responsible Use Cases | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/responsible-use-cases.md | |
| ai-services | Terminology | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/terminology.md | |
| ai-services | Tutorial Use Azure Notebook Generate Loop Data | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/tutorial-use-azure-notebook-generate-loop-data.md | |
| ai-services | Tutorial Use Personalizer Chat Bot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/tutorial-use-personalizer-chat-bot.md | |
| ai-services | Tutorial Use Personalizer Web App | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/tutorial-use-personalizer-web-app.md | |
| ai-services | What Is Personalizer | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/what-is-personalizer.md | |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/whats-new.md | |
| ai-services | Where Can You Use Personalizer | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/personalizer/where-can-you-use-personalizer.md | |
| ai-services | Azure Resources | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/azure-resources.md | |
| ai-services | Best Practices | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/best-practices.md | |
| ai-services | Confidence Score | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/confidence-score.md | |
| ai-services | Data Sources And Content | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/data-sources-and-content.md | |
| ai-services | Development Lifecycle Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/development-lifecycle-knowledge-base.md | |
| ai-services | Plan | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/plan.md | |
| ai-services | Query Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/query-knowledge-base.md | |
| ai-services | Question Answer Set | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/question-answer-set.md | |
| ai-services | Role Based Access Control | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Concepts/role-based-access-control.md | |
| ai-services | Add Sharepoint Datasources | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/add-sharepoint-datasources.md | |
| ai-services | Change Default Answer | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/change-default-answer.md | |
| ai-services | Chit Chat Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/chit-chat-knowledge-base.md | |
| ai-services | Configure Qna Maker Resources | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/configure-qna-maker-resources.md | |
| ai-services | Edit Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/edit-knowledge-base.md | |
| ai-services | Get Analytics Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/get-analytics-knowledge-base.md | displayName: chat history, history, chat logs, logs Previously updated : 12/19/2023 Last updated : 01/19/2024 |
| ai-services | Improve Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/improve-knowledge-base.md | description: Improve the quality of your knowledge base with active learning. Re Previously updated : 12/19/2023 Last updated : 01/19/2024 ms.devlang: csharp |
| ai-services | Manage Knowledge Bases | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/manage-knowledge-bases.md | |
| ai-services | Manage Qna Maker App | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/manage-qna-maker-app.md | |
| ai-services | Metadata Generateanswer Usage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/metadata-generateanswer-usage.md | |
| ai-services | Migrate To Openai | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/migrate-to-openai.md | |
| ai-services | Multi Turn | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/multi-turn.md | |
| ai-services | Network Isolation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/network-isolation.md | |
| ai-services | Query Knowledge Base With Metadata | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/query-knowledge-base-with-metadata.md | |
| ai-services | Set Up Qnamaker Service Azure | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/set-up-qnamaker-service-azure.md | |
| ai-services | Test Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/test-knowledge-base.md | |
| ai-services | Use Active Learning | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/use-active-learning.md | |
| ai-services | Using Prebuilt Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/How-To/using-prebuilt-api.md | |
| ai-services | Language Support | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Overview/language-support.md | |
| ai-services | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Overview/overview.md | |
| ai-services | Add Question Metadata Portal | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Quickstarts/add-question-metadata-portal.md | |
| ai-services | Create Publish Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Quickstarts/create-publish-knowledge-base.md | |
| ai-services | Get Answer From Knowledge Base Using Url Tool | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Quickstarts/get-answer-from-knowledge-base-using-url-tool.md | |
| ai-services | Quickstart Sdk | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Quickstarts/quickstart-sdk.md | |
| ai-services | Create Faq Bot With Azure Bot Service | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Tutorials/create-faq-bot-with-azure-bot-service.md | |
| ai-services | Export Knowledge Base | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Tutorials/export-knowledge-base.md | |
| ai-services | Integrate With Power Virtual Assistant Fallback Topic | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/Tutorials/integrate-with-power-virtual-assistant-fallback-topic.md | |
| ai-services | Choose Natural Language Processing Service | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/choose-natural-language-processing-service.md | |
| ai-services | Encrypt Data At Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/encrypt-data-at-rest.md | |
| ai-services | Limits | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/limits.md | |
| ai-services | Reference App Service | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/reference-app-service.md | |
| ai-services | Reference Document Format Guidelines | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/reference-document-format-guidelines.md | |
| ai-services | Reference Markdown Format | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/reference-markdown-format.md | |
| ai-services | Reference Private Endpoint | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/reference-private-endpoint.md | |
| ai-services | Reference Tsv Format Batch Testing | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/reference-tsv-format-batch-testing.md | |
| ai-services | Troubleshooting | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/troubleshooting.md | |
| ai-services | Whats New | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/qnamaker/whats-new.md | |
| ai-services | Custom Keyword Basics | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/custom-keyword-basics.md | -# ms.devlang: csharp, objective-c, python zone_pivot_groups: programming-languages-speech-services |
| ai-services | Custom Neural Voice Lite | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/custom-neural-voice-lite.md | To create a custom neural voice lite project, follow these steps: > To create a custom neural voice Pro project, see [Create a project for custom neural voice](professional-voice-create-project.md). 1. Follow the instructions provided by the wizard to create your project. -1. Select the new project by name or select **Go to project**. You'll see these menu items in the left panel: **Record and build**, **Review model**, and **Deploy model**. +1. Select the new project by name or select **Go to project**. You see these menu items in the left panel: **Record and build**, **Review model**, and **Deploy model**. :::image type="content" source="media/custom-voice/lite/lite-project-get-started.png" alt-text="Screenshot with an overview of the CNV lite record, train, test, and deploy workflow."::: The CNV lite project expires after 90 days unless the [verbal statement](#submit-verbal-statement) recorded by the voice talent is submitted. ## Record and build a CNV lite model -Record at least 20 voice samples (up to 50) with provided scripts online. Voice samples recorded here will be used to create a synthetic version of your voice. +Record at least 20 voice samples (up to 50) with provided scripts online. Voice samples recorded here are used to create a synthetic version of your voice. Here are some tips to help you record your voice samples: - Use a good microphone. Increase the clarity of your samples by using a high-quality microphone. Speak about 8 inches away from the microphone to avoid mouth noises. To record and build a CNV lite model, follow these steps: 1. Select **Get started**. 1. Read the Voice talent terms of use carefully. Select the checkbox to acknowledge the terms of use. 1. Select **Accept**-1. Press the microphone icon to start the noise check. This noise check will take only a few seconds, and you won't need to speak during it. +1. Press the microphone icon to start the noise check. This noise check takes only a few seconds, and you don't need to speak during it. 1. If noise was detected, you can select **Check again** to repeat the noise check. If no noise was detected, you can select **Done** to proceed to the next step. :::image type="content" source="media/custom-voice/lite/cnv-record-noise-check.png" alt-text="Screenshot of the noise check results when noise was detected."::: 1. Review the recording tips and select **Got it**. For the best results, go to a quiet area without background noise before recording your voice samples. To submit the voice talent verbal statement, follow these steps: ## Deploy model -To deploy your voice model and use it in your applications, you must get the full access to custom neural voice. Request access on the [intake form](https://aka.ms/customneural). Within approximately 10 business days, you'll receive an email with the approval status. A [verbal statement](#submit-verbal-statement) recorded by the voice talent is also required before you can deploy the model for your business use. +To deploy your voice model and use it in your applications, you must get the full access to custom neural voice. Request access on the [intake form](https://aka.ms/customneural). Within approximately 10 business days, you receive an email with the approval status. A [verbal statement](#submit-verbal-statement) recorded by the voice talent is also required before you can deploy the model for your business use. To deploy a CNV lite model, follow these steps: |
| ai-services | Custom Neural Voice | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/custom-neural-voice.md | Custom neural voice (CNV) is a text to speech feature that lets you create a one > > Access to [Custom neural voice (CNV) Lite](custom-neural-voice-lite.md) is available for anyone to demo and evaluate CNV before investing in professional recordings to create a higher-quality voice. -Out of the box, [text to speech](text-to-speech.md) can be used with prebuilt neural voices for each [supported language](language-support.md?tabs=tts). The prebuilt neural voices work very well in most text to speech scenarios if a unique voice isn't required. +Out of the box, [text to speech](text-to-speech.md) can be used with prebuilt neural voices for each [supported language](language-support.md?tabs=tts). The prebuilt neural voices work well in most text to speech scenarios if a unique voice isn't required. Custom neural voice is based on the neural text to speech technology and the multilingual, multi-speaker, universal model. You can create synthetic voices that are rich in speaking styles, or adaptable cross languages. The realistic and natural sounding voice of custom neural voice can represent brands, personify machines, and allow users to interact with applications conversationally. See the [supported languages](language-support.md?tabs=tts) for custom neural voice. Before you get started in Speech Studio, here are some considerations: Here's an overview of the steps to create a custom neural voice in Speech Studio: -1. [Create a project](professional-voice-create-project.md) to contain your data, voice models, tests, and endpoints. Each project is specific to a country/region and language. If you are going to create multiple voices, it's recommended that you create a project for each voice. +1. [Create a project](professional-voice-create-project.md) to contain your data, voice models, tests, and endpoints. Each project is specific to a country/region and language. If you're going to create multiple voices, it's recommended that you create a project for each voice. 1. [Set up voice talent](professional-voice-create-project.md). Before you can train a neural voice, you must submit a recording of the voice talent's consent statement. The voice talent statement is a recording of the voice talent reading a statement that they consent to the usage of their speech data to train a custom voice model. 1. [Prepare training data](professional-voice-create-training-set.md) in the right [format](how-to-custom-voice-training-data.md). It's a good idea to capture the audio recordings in a professional quality recording studio to achieve a high signal-to-noise ratio. The quality of the voice model depends heavily on your training data. Consistent volume, speaking rate, pitch, and consistency in expressive mannerisms of speech are required. 1. [Train your voice model](professional-voice-train-voice.md). Select at least 300 utterances to create a custom neural voice. A series of data quality checks are automatically performed when you upload them. To build high-quality voice models, you should fix any errors and submit again. 1. [Test your voice](professional-voice-train-voice.md#test-your-voice-model). Prepare test scripts for your voice model that cover the different use cases for your apps. ItΓÇÖs a good idea to use scripts within and outside the training dataset, so you can test the quality more broadly for different content. 1. [Deploy and use your voice model](professional-voice-deploy-endpoint.md) in your apps. -You can tune, adjust, and use your custom voice, similarly as you would use a prebuilt neural voice. Convert text into speech in real-time, or generate audio content offline with text input. You can do this by using the [REST API](./rest-text-to-speech.md), the [Speech SDK](./get-started-text-to-speech.md), or the [Speech Studio](https://speech.microsoft.com/audiocontentcreation). +You can tune, adjust, and use your custom voice, similarly as you would use a prebuilt neural voice. Convert text into speech in real-time, or generate audio content offline with text input. You use the [REST API](./rest-text-to-speech.md), the [Speech SDK](./get-started-text-to-speech.md), or the [Speech Studio](https://speech.microsoft.com/audiocontentcreation). The style and the characteristics of the trained voice model depend on the style and the quality of the recordings from the voice talent used for training. However, you can make several adjustments by using [SSML (Speech Synthesis Markup Language)](./speech-synthesis-markup.md?tabs=csharp) when you make the API calls to your voice model to generate synthetic speech. SSML is the markup language used to communicate with the text to speech service to convert text into audio. The adjustments you can make include change of pitch, rate, intonation, and pronunciation correction. If the voice model is built with multiple styles, you can also use SSML to switch the styles. If you're using the old version of custom voice (which is scheduled to be retire ## Responsible AI -An AI system includes not only the technology, but also the people who will use it, the people who will be affected by it, and the environment in which it is deployed. Read the transparency notes to learn about responsible AI use and deployment in your systems. +An AI system includes not only the technology, but also the people who use it, the people who are affected by it, and the environment in which it's deployed. Read the transparency notes to learn about responsible AI use and deployment in your systems. * [Transparency note and use cases for custom neural voice](/legal/cognitive-services/speech-service/custom-neural-voice/transparency-note-custom-neural-voice?context=/azure/ai-services/speech-service/context/context) * [Characteristics and limitations for using custom neural voice](/legal/cognitive-services/speech-service/custom-neural-voice/characteristics-and-limitations-custom-neural-voice?context=/azure/ai-services/speech-service/context/context) |
| ai-services | Custom Speech Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/custom-speech-overview.md | With Custom Speech, you can upload your own data, test and train a custom model, Here's more information about the sequence of steps shown in the previous diagram: -1. [Create a project](how-to-custom-speech-create-project.md) and choose a model. Use a <a href="https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices" title="Create a Speech resource" target="_blank">Speech resource</a> that you create in the Azure portal. If you'll train a custom model with audio data, choose a Speech resource region with dedicated hardware for training audio data. See footnotes in the [regions](regions.md#speech-service) table for more information. +1. [Create a project](how-to-custom-speech-create-project.md) and choose a model. Use a <a href="https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices" title="Create a Speech resource" target="_blank">Speech resource</a> that you create in the Azure portal. If you train a custom model with audio data, choose a Speech resource region with dedicated hardware for training audio data. See footnotes in the [regions](regions.md#speech-service) table for more information. 1. [Upload test data](./how-to-custom-speech-upload-data.md). Upload test data to evaluate the speech to text offering for your applications, tools, and products. 1. [Test recognition quality](how-to-custom-speech-inspect-data.md). Use the [Speech Studio](https://aka.ms/speechstudio/customspeech) to play back uploaded audio and inspect the speech recognition quality of your test data. 1. [Test model quantitatively](how-to-custom-speech-evaluate-data.md). Evaluate and improve the accuracy of the speech to text model. The Speech service provides a quantitative word error rate (WER), which you can use to determine if more training is required. |
| ai-services | Customize Pronunciation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/customize-pronunciation.md | You can specify the phonetic pronunciation of words using the Universal Phone Se UPS pronunciations consist of a string of UPS phonemes, each separated by whitespace. UPS phoneme labels are all defined using ASCII character strings. -For steps on implementing UPS, see [Structured text phonetic pronunciation](how-to-custom-speech-test-and-train.md#structured-text-data-for-training). Structured text phonetic pronunciation data is separate from [pronunciation data](how-to-custom-speech-test-and-train.md#pronunciation-data-for-training), and they cannot be used together. The first one is "sounds-like" or spoken-form data, and is input as a separate file, and trains the model what the spoken form sounds like +For steps on implementing UPS, see [Structured text phonetic pronunciation](how-to-custom-speech-test-and-train.md#structured-text-data-for-training). Structured text phonetic pronunciation data is separate from [pronunciation data](how-to-custom-speech-test-and-train.md#pronunciation-data-for-training), and they can't be used together. The first one is "sounds-like" or spoken-form data, and is input as a separate file, and trains the model what the spoken form sounds like [Structured text phonetic pronunciation data](how-to-custom-speech-test-and-train.md#structured-text-data-for-training) is specified per syllable in a markdown file. Separately, [pronunciation data](how-to-custom-speech-test-and-train.md#pronunciation-data-for-training) it input on its own, and trains the model what the spoken form sounds like. You can either use a pronunciation data file on its own, or you can add pronunciation within a structured text data file. The Speech service doesn't support training a model with both of those datasets as input. |
| ai-services | Devices Sdk Release Notes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/devices-sdk-release-notes.md | The following sections list changes in the most recent releases. - Linux ARM is now supported. - Initial binaries for [Roobo v2 DDK](https://aka.ms/sdsdk-download-roobov2) are provided (Linux ARM64). - Windows users can use `AudioConfig.fromDefaultMicrophoneInput()` or `AudioConfig.fromMicrophoneInput(deviceName)` to specify the microphone to be used.-- The library size has been optimized.+- The library size is optimized. - Support for multi-turn recognition using the same speech/intent recognizer object. - Fix occasional issue where the process would stop responding while stopping recognition. - Sample apps now contain a sample participants.properties file to demonstrate the format of the file. The following sections list changes in the most recent releases. **Breaking changes** -- Due to the new keyword technology all keywords must be re-created at our improved keyword portal. To fully remove old keywords from the device uninstall the old app.+- Due to the new keyword technology, all keywords must be re-created at our improved keyword portal. To completely remove old keywords from the device, uninstall the old app. - adb uninstall com.microsoft.cognitiveservices.speech.samples.sdsdkstarterapp ## Speech Devices SDK 1.4.0: 2019-Apr release The following sections list changes in the most recent releases. **Breaking changes** -- [Installing a keyword](./custom-keyword-basics.md) has been simplified, it is now part of the app and does not need separate installation on the device.-- The keyword recognition has changed, and two events are supported.+- [Installing a keyword](./custom-keyword-basics.md) has been simplified, it's now part of the app and doesn't need separate installation on the device. +- The keyword recognition is changed, and two events are supported. - `RecognizingKeyword,` indicates the speech result contains (unverified) keyword text. - `RecognizedKeyword`, indicates that keyword recognition completed recognizing the given keyword. The following sections list changes in the most recent releases. ## Speech Devices SDK 1.0.1: 2018-Oct release - Updated the [Speech SDK](./speech-sdk.md) component to version 1.0.1. For more information, see its [release notes](./releasenotes.md).-- Speech recognition accuracy will be improved with our improved audio processing algorithm+- Speech recognition accuracy is improved with our improved audio processing algorithm - One continuous recognition audio session bug is fixed. **Breaking changes** -- With this release a number of breaking changes are introduced. Please check [this page](https://aka.ms/csspeech/breakingchanges_1_0_0) for details relating to the APIs.-- The keyword recognition model files are not compatible with Speech Devices SDK 1.0.1. The existing keyword files will be deleted after the new keyword files are written to the device.+- With this release many breaking changes are introduced. Check [this page](https://aka.ms/csspeech/breakingchanges_1_0_0) for details relating to the APIs. +- The keyword recognition model files aren't compatible with Speech Devices SDK 1.0.1. The existing keyword files will be deleted after the new keyword files are written to the device. ## Speech Devices SDK 0.5.0: 2018-Aug release |
| ai-services | Direct Line Speech | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/direct-line-speech.md | -Direct Line Speech is a robust, end-to-end solution for creating a flexible, extensible voice assistant. It is powered by the Bot Framework and its Direct Line Speech channel, that is optimized for voice-in, voice-out interaction with bots. +Direct Line Speech is a robust, end-to-end solution for creating a flexible, extensible voice assistant. It's powered by the Bot Framework and its Direct Line Speech channel, that is optimized for voice-in, voice-out interaction with bots. [Voice assistants](voice-assistants.md) listen to users and take an action in response, often speaking back. They use [speech to text](speech-to-text.md) to transcribe the user's speech, then take action on the natural language understanding of the text. This action frequently includes spoken output from the assistant generated with [text to speech](text-to-speech.md). -Direct Line Speech offers the highest levels of customization and sophistication for voice assistants. It's designed for conversational scenarios that are open-ended, natural, or hybrids of the two with task completion or command-and-control use. This high degree of flexibility comes with a greater complexity, and scenarios that are scoped to well-defined tasks using natural language input may want to consider [Custom Commands](custom-commands.md) for a streamlined solution experience. +Direct Line Speech offers the highest levels of customization and sophistication for voice assistants. It's designed for conversational scenarios that are open-ended, natural, or hybrids of the two with task completion or command-and-control use. This high degree of flexibility comes with a greater complexity. Consider [Custom Commands](custom-commands.md) for scenarios that are scoped to well-defined tasks using natural language input. Direct Line Speech supports these locales: `ar-eg`, `ar-sa`, `ca-es`, `da-dk`, `de-de`, `en-au`, `en-ca`, `en-gb`, `en-in`, `en-nz`, `en-us`, `es-es`, `es-mx`, `fi-fi`, `fr-ca`, `fr-fr`, `gu-in`, `hi-in`, `hu-hu`, `it-it`, `ja-jp`, `ko-kr`, `mr-in`, `nb-no`, `nl-nl`, `pl-pl`, `pt-br`, `pt-pt`, `ru-ru`, `sv-se`, `ta-in`, `te-in`, `th-th`, `tr-tr`, `zh-cn`, `zh-hk`, and `zh-tw`. Voice assistants built using Speech service can use the full range of customizat > [!NOTE] > Customization options vary by language/locale (see [Supported languages](./language-support.md?tabs=stt)). -Direct Line Speech and its associated functionality for voice assistants are an ideal supplement to the [Virtual Assistant Solution and Enterprise Template](/azure/bot-service/bot-builder-enterprise-template-overview). Though Direct Line Speech can work with any compatible bot, these resources provide a reusable baseline for high-quality conversational experiences as well as common supporting skills and models to get started quickly. +Direct Line Speech and its associated functionality for voice assistants are an ideal supplement to the [Virtual Assistant Solution and Enterprise Template](/azure/bot-service/bot-builder-enterprise-template-overview). Though Direct Line Speech can work with any compatible bot, these resources provide a reusable baseline for high-quality conversational experiences and common supporting skills and models to get started quickly. ## Reference docs |
| ai-services | Display Text Format | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/display-text-format.md | -Speech to text offers an array of formatting features to ensure that the transcribed text is clear and legible. Below is an overview of these features and how each one is used to improve the overall clarity of the final text output. +Speech to text offers an array of formatting features to ensure that the transcribed text is clear and legible. See the sections below for an overview of how each feature is used to improve the overall clarity of the final text output. ## ITN -Inverse Text Normalization (ITN) is a process that converts spoken words into their written form. For example, the spoken word "four" is converted to the written form "4". This process is performed by the speech to text service and isn't configurable. Some of the supported text formats include dates, times, decimals, currencies, addresses, emails, and phone numbers. You can speak naturally, and the service formats text as expected. The following table shows the ITN rules that are applied to the text output. +Inverse Text Normalization (ITN) is a process that converts spoken words into their written form. For example, the spoken word "four" is converted to the written form "4". The speech to text service completes this process and it's not configurable. Some of the supported text formats include dates, times, decimals, currencies, addresses, emails, and phone numbers. You can speak naturally, and the service formats text as expected. The following table shows the ITN rules that are applied to the text output. |Recognized speech|Display text| ||| Inverse Text Normalization (ITN) is a process that converts spoken words into th ## Capitalization -Speech to text models recognize words that should be capitalized to improve readability, accuracy, and grammar. For example, the Speech service will automatically capitalize proper nouns and words at the beginning of a sentence. Some examples are shown in this table. +Speech to text models recognize words that should be capitalized to improve readability, accuracy, and grammar. For example, the Speech service automatically capitalizes proper nouns and words at the beginning of a sentence. Some examples are shown in this table. |Recognized speech|Display text| ||| When you're using speech to text with continuous recognition, you can configure |`the options are apple forward slash banana forward slash orange period`|`The options are apple/banana/orange.`| |`are you sure question mark`|`Are you sure?`| -Use the Speech SDK to enable dictation mode when you're using speech to text with continuous recognition. This mode will cause the speech configuration instance to interpret word descriptions of sentence structures such as punctuation. +Use the Speech SDK to enable dictation mode when you're using speech to text with continuous recognition. This mode causes the speech configuration instance to interpret word descriptions of sentence structures such as punctuation. ::: zone pivot="programming-language-csharp" ```csharp |
| ai-services | Embedded Speech Performance Evaluations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/embedded-speech-performance-evaluations.md | Embedded speech models run fully on your target devices. Understanding the perfo **Real-time factor (RTF)** ΓÇô The real-time factor (RTF) of a device measures how fast the embedded speech model can process audio input. It's the ratio of the processing time to the audio length. For example, if a device processes a 1-minute audio file in 30 seconds, the RTF is 0.5. This metric evaluates the computational power of the device for running embedded speech models. It can help identify devices that are too slow to support the models. Measurement of this metric should only be done using file-based input rather than real-time microphone input. -To support real-time & interactive speech experiences, the device should have an RTF of `1` or lower. An RTF value higher than `1` means that the device can't keep up with the audio input and will cause poor user experiences. +To support real-time & interactive speech experiences, the device should have an RTF of `1` or lower. An RTF value higher than `1` means that the device can't keep up with the audio input, which can result in a poor user experience. When measuring the RTF of a device, it's important to measure multiple samples and analyze the distribution across percentiles. This allows you to capture the effect of variations in the device's behavior like different CPU clock speeds due to thermal throttling. The predefined measurement tests outlined in [Measuring the real-time factor on your device](#measuring-the-real-time-factor-on-your-device) automatically measure the RTF for each speech recognition result, yielding a sufficiently large sample size. When measuring the RTF of a device, it's important to measure multiple samples a For example, if the device is under moderate to high CPU load from all other applications running on the device, it's possible to encounter performance issues for running embedded speech in addition to the other applications, even with a powerful processor. -**Memory load** ΓÇô An embedded speech to text model consumes between 200-300 MB of memory at runtime. If your device has less memory available than that for the embedded speech process to use, frequent fallbacks to virtual memory and paging can introduce more latencies. This can affect both the real-time factor and user-perceived latency. +**Memory load** ΓÇô An embedded speech to text model consumes between 200-300 MB of memory at runtime. If your device has less memory available for the embedded speech process to use, frequent fallbacks to virtual memory and paging can introduce more latencies. This can affect both the real-time factor and user-perceived latency. ## Built-in performance optimizations |
| ai-services | Embedded Speech | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/embedded-speech.md | All text to speech locales [here](language-support.md?tabs=tts) (except fa-IR, P ## Embedded speech configuration -For cloud connected applications, as shown in most Speech SDK samples, you use the `SpeechConfig` object with a Speech resource key and region. For embedded speech, you don't use a Speech resource. Instead of a cloud resource, you use the [models and voices](#models-and-voices) that you downloaded to your local device. +For cloud connected applications, as shown in most Speech SDK samples, you use the `SpeechConfig` object with a Speech resource key and region. For embedded speech, you don't use a Speech resource. Instead of a cloud resource, you use the [models and voices](#models-and-voices) that you download to your local device. Use the `EmbeddedSpeechConfig` object to set the location of the models or voices. If your application is used for both speech to text and text to speech, you can use the same `EmbeddedSpeechConfig` object to set the location of the models and voices. You can find ready to use embedded speech samples at [GitHub](https://aka.ms/emb Hybrid speech with the `HybridSpeechConfig` object uses the cloud speech service by default and embedded speech as a fallback in case cloud connectivity is limited or slow. -With hybrid speech configuration for [speech to text](speech-to-text.md) (recognition models), embedded speech is used when connection to the cloud service fails after repeated attempts. Recognition may continue using the cloud service again if the connection is later resumed. +With hybrid speech configuration for [speech to text](speech-to-text.md) (recognition models), embedded speech is used when connection to the cloud service fails after repeated attempts. Recognition might continue using the cloud service again if the connection is later resumed. With hybrid speech configuration for [text to speech](text-to-speech.md) (voices), embedded and cloud synthesis are run in parallel and the final result is selected based on response speed. The best result is evaluated again on each new synthesis request. For cloud speech, you use the `SpeechConfig` object, as shown in the [speech to ## Embedded voices capabilities -For embedded voices, it is essential to note that certain SSML tags may not be currently supported due to differences in the model structure. For detailed information regarding the unsupported SSML tags, refer to the following table. +For embedded voices, it's essential to note that certain SSML tags might not be currently supported due to differences in the model structure. For detailed information regarding the unsupported SSML tags, refer to the following table. | Level 1 | Level 2 | Sub values | Support in embedded NTTS | |--|--|-|--| |
| ai-services | Gaming Concepts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/gaming-concepts.md | Azure AI services for Speech can be used to improve various gaming scenarios, bo Here are a few Speech features to consider for flexible and interactive game experiences: - Bring everyone into the conversation by synthesizing audio from text. Or by displaying text from audio.-- Make the game more accessible for players who are unable to read text in a particular language, including young players who haven't learned to read and write. Players can listen to storylines and instructions in their preferred language. +- Make the game more accessible for players who are unable to read text in a particular language, including young players who don't read or write. Players can listen to storylines and instructions in their preferred language. - Create game avatars and non-playable characters (NPC) that can initiate or participate in a conversation in-game. - Prebuilt neural voice can provide highly natural out-of-box voices with leading voice variety in terms of a large portfolio of languages and voices. - Custom neural voice for creating a voice that stays on-brand with consistent quality and speaking style. You can add emotions, accents, nuances, laughter, and other para linguistic sounds and expressions. When enabling this functionality in your game, keep in mind the following benefi - Fine-tuning Text to speech output with Speech Synthesis Markup Language (SSML) - With SSML, you can customize Text to speech outputs, with richer voice tuning supports. For more information, see [Speech Synthesis Markup Language (SSML) overview](speech-synthesis-markup.md). - Audio outputs - Each prebuilt neural voice model is available at 24 kHz and high-fidelity 48 kHz. If you select 48-kHz output format, the high-fidelity voice model with 48 kHz will be invoked accordingly. The sample rates other than 24 kHz and 48 kHz can be obtained through upsampling or downsampling when synthesizing. For example, 44.1 kHz is downsampled from 48 kHz. Each audio format incorporates a bitrate and encoding type. For more information, see the [supported audio formats](rest-text-to-speech.md?tabs=streaming#audio-outputs). For more information on 48-kHz high-quality voices, see [this introduction blog](https://techcommunity.microsoft.com/t5/ai-cognitive-services-blog/azure-neural-tts-voices-upgraded-to-48khz-with-hifinet2-vocoder/ba-p/3665252). -For an example, see the [Text to speech quickstart](get-started-text-to-speech.md). +For an example, see the [text to speech quickstart](get-started-text-to-speech.md). ## Speech to text With [language identification](language-identification.md), you can detect the l ## Speech translation -It's not unusual that players in the same game session natively speak different languages and may appreciate receiving both the original message and its translation. You can use [speech translation](speech-translation.md) to translate text between languages so players across the world can communicate with each other in their native language. +It's not unusual that players in the same game session natively speak different languages and might appreciate receiving both the original message and its translation. You can use [speech translation](speech-translation.md) to translate text between languages so players across the world can communicate with each other in their native language. For an example, see the [Speech translation quickstart](get-started-speech-translation.md). |
| ai-services | How To Async Meeting Transcription | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-async-meeting-transcription.md | description: Learn how to use asynchronous meeting transcription using the Speec Previously updated : 11/04/2019 Last updated : 1/18/2024 ms.devlang: csharp-# ms.devlang: csharp, java zone_pivot_groups: programming-languages-set-twenty-one In this article, asynchronous meeting transcription is demonstrated using the ** ## Asynchronous vs. real-time + asynchronous -With asynchronous transcription, you stream the meeting audio, but don't need a transcription returned in real-time. Instead, after the audio is sent, use the `meetingId` of `Meeting` to query for the status of the asynchronous transcription. When the asynchronous transcription is ready, you'll get a `RemoteMeetingTranscriptionResult`. +With asynchronous transcription, you stream the meeting audio, but don't need a transcription returned in real-time. Instead, after the audio is sent, use the `meetingId` of `Meeting` to query for the status of the asynchronous transcription. When the asynchronous transcription is ready, you get a `RemoteMeetingTranscriptionResult`. With real-time plus asynchronous, you get the transcription in real-time, but also get the transcription by querying with the `meetingId` (similar to asynchronous scenario). |
| ai-services | How To Audio Content Creation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-audio-content-creation.md | -Build highly natural audio content for a variety of scenarios, such as audiobooks, news broadcasts, video narrations, and chat bots. With Audio Content Creation, you can efficiently fine-tune Text to speech voices and design customized audio experiences. +Build highly natural audio content for various scenarios, such as audiobooks, news broadcasts, video narrations, and chat bots. With Audio Content Creation, you can efficiently fine-tune Text to speech voices and design customized audio experiences. The tool is based on [Speech Synthesis Markup Language (SSML)](speech-synthesis-markup.md). It allows you to adjust Text to speech output attributes in real-time or batch synthesis, such as voice characters, voice styles, speaking speed, pronunciation, and prosody. - No-code approach: You can use the Audio Content Creation tool for Text to speech synthesis without writing any code. The output audio might be the final deliverable that you want. For example, you can use the output audio for a podcast or a video narration. - Developer-friendly: You can listen to the output audio and adjust the SSML to improve speech synthesis. Then you can use the [Speech SDK](speech-sdk.md) or [Speech CLI](spx-basics.md) to integrate the SSML into your applications. For example, you can use the SSML for building a chat bot. -You have easy access to a broad portfolio of [languages and voices](language-support.md?tabs=tts). These voices include state-of-the-art prebuilt neural voices and your custom neural voice, if you've built one. +You have easy access to a broad portfolio of [languages and voices](language-support.md?tabs=tts). These voices include state-of-the-art prebuilt neural voices and your custom neural voice, if you built one. To learn more, view the Audio Content Creation tutorial video [on YouTube](https://youtu.be/ygApYuOOG6w). ## Get started -The Audio Content Creation tool in Speech Studio is free to access, but you'll pay for Speech service usage. To work with the tool, you need to sign in with an Azure account and create a Speech resource. For each Azure account, you have free monthly speech quotas, which include 0.5 million characters for prebuilt neural voices (referred to as *Neural* on the [pricing page](https://aka.ms/speech-pricing)). The monthly allotted amount is usually enough for a small content team of around 3-5 people. +The Audio Content Creation tool in Speech Studio is free to access, but you pay for Speech service usage. To work with the tool, you need to sign in with an Azure account and create a Speech resource. For each Azure account, you have free monthly speech quotas, which include 0.5 million characters for prebuilt neural voices (referred to as *Neural* on the [pricing page](https://aka.ms/speech-pricing)). Usually, the monthly allotted amount is enough for a small content team of around 3-5 people. The next sections cover how to create an Azure account and get a Speech resource. You can get your content into the Audio Content Creation tool in either of two w ## Export tuned audio -After you've reviewed your audio output and are satisfied with your tuning and adjustment, you can export the audio. +After you review your audio output and are satisfied with your tuning and adjustment, you can export the audio. 1. Select **Export** to create an audio creation task. After you've reviewed your audio output and are satisfied with your tuning and a ## Configure BYOS and anonymous public read access for blobs -If you lose access permission to your Bring Your Own Storage (BYOS), you won't be able to view, create, edit, or delete files. To resume your access, you need to remove the current storage and reconfigure the BYOS in the [Azure portal](https://portal.azure.com/#allservices). To learn more about how to configure BYOS, see [Mount Azure Storage as a local share in App Service](/azure/app-service/configure-connect-to-azure-storage?pivots=container-linux&tabs=portal). +If you lose access permission to your Bring Your Own Storage (BYOS), you can't view, create, edit, or delete files. To resume your access, you need to remove the current storage and reconfigure the BYOS in the [Azure portal](https://portal.azure.com/#allservices). To learn more about how to configure BYOS, see [Mount Azure Storage as a local share in App Service](/azure/app-service/configure-connect-to-azure-storage?pivots=container-linux&tabs=portal). -After configuring the BYOS permission, you need to configure anonymous public read access for related containers and blobs. Otherwise, blob data isn't available for public access and your lexicon file in the blob will be inaccessible. By default, a containerΓÇÖs public access setting is disabled. To grant anonymous users read access to a container and its blobs, first set **Allow Blob public access** to **Enabled** to allow public access for the storage account, then set the container's (named **acc-public-files**) public access level (**anonymous read access for blobs only**). To learn more about how to configure anonymous public read access, see [Configure anonymous public read access for containers and blobs](/azure/storage/blobs/anonymous-read-access-configure?tabs=portal). +After configuring the BYOS permission, you need to configure anonymous public read access for related containers and blobs. Otherwise, blob data isn't available for public access and your lexicon file in the blob is inaccessible. By default, a containerΓÇÖs public access setting is disabled. To grant anonymous users read access to a container and its blobs, first set **Allow Blob public access** to **Enabled** to allow public access for the storage account, then set the container's (named **acc-public-files**) public access level (**anonymous read access for blobs only**). To learn more about how to configure anonymous public read access, see [Configure anonymous public read access for containers and blobs](/azure/storage/blobs/anonymous-read-access-configure?tabs=portal). ## Add or remove Audio Content Creation users -If more than one user wants to use Audio Content Creation, you can grant them access to the Azure subscription and the Speech resource. If you add users to an Azure subscription, they can access all the resources under the Azure subscription. But if you add users to a Speech resource only, they'll have access only to the Speech resource and not to other resources under this Azure subscription. Users with access to the Speech resource can use the Audio Content Creation tool. +If more than one user wants to use Audio Content Creation, you can grant them access to the Azure subscription and the Speech resource. If you add users to an Azure subscription, they can access all the resources under the Azure subscription. But if you add users to a Speech resource only, they only have access to the Speech resource and not to other resources under this Azure subscription. Users with access to the Speech resource can use the Audio Content Creation tool. The users you grant access to need to set up a [Microsoft account](https://account.microsoft.com/account). If they don' have a Microsoft account, they can create one in just a few minutes. They can use their existing email and link it to a Microsoft account, or they can create and use an Outlook email address as a Microsoft account. To add users to a Speech resource so that they can use Audio Content Creation, d 1. On the **Members** tab, enter a user's email address and select the user's name in the directory. The email address must be linked to a Microsoft account that's trusted by Microsoft Entra ID. Users can easily sign up for a [Microsoft account](https://account.microsoft.com/account) by using their personal email address. 1. On the **Review + assign** tab, select **Review + assign** to assign the role. -Here is what happens next: +Here's what happens next: An email invitation is automatically sent to users. They can accept it by selecting **Accept invitation** > **Accept to join Azure** in their email. They're then redirected to the Azure portal. They don't need to take further action in the Azure portal. After a few moments, users are assigned the role at the Speech resource scope, which gives them access to this Speech resource. If users don't receive the invitation email, you can search for their account under **Role assignments** and go into their profile. Look for **Identity** > **Invitation accepted**, and select **(manage)** to resend the email invitation. You can also copy and send the invitation link to them. Users now visit or refresh the [Audio Content Creation](https://aka.ms/audiocont If they can't find the available Speech resource, they can check to ensure that they're in the right directory. To do so, they select the account profile at the upper right and then select **Switch** next to **Current directory**. If there's more than one directory available, it means they have access to multiple directories. They can switch to different directories and go to **Settings** to see whether the right Speech resource is available. -Users who are in the same Speech resource will see each other's work in the Audio Content Creation tool. If you want each individual user to have a unique and private workplace in Audio Content Creation, [create a new Speech resource](#step-2-create-a-speech-resource) for each user and give each user the unique access to the Speech resource. +Users who are in the same Speech resource see each other's work in the Audio Content Creation tool. If you want each individual user to have a unique and private workplace in Audio Content Creation, [create a new Speech resource](#step-2-create-a-speech-resource) for each user and give each user the unique access to the Speech resource. ### Remove users from a Speech resource |
| ai-services | How To Configure Azure Ad Auth | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-configure-azure-ad-auth.md | -# ms.devlang: cpp, csharp, java, python + # Microsoft Entra authentication with the Speech SDK When using the Speech SDK to access the Speech service, there are three authentication methods available: service keys, a key-based token, and Microsoft Entra ID. This article describes how to configure a Speech resource and create a Speech SDK configuration object to use Microsoft Entra ID for authentication. -This article shows how to use Microsoft Entra authentication with the Speech SDK. You'll learn how to: +This article shows how to use Microsoft Entra authentication with the Speech SDK. You learn how to: > [!div class="checklist"] > $resourceId = resource.Id With a Microsoft Entra access token, you can now create a Speech SDK configuration object. -The method of providing the token, and the method to construct the corresponding Speech SDK ```Config``` object varies by the object you'll be using. +The method of providing the token, and the method to construct the corresponding Speech SDK ```Config``` object varies by the object you're using. ### SpeechRecognizer, SpeechSynthesizer, IntentRecognizer, ConversationTranscriber |
| ai-services | How To Configure Openssl Linux | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-configure-openssl-linux.md | export SSL_CERT_FILE=/etc/pki/tls/certs/ca-bundle.crt When the Speech SDK connects to the Speech service, it checks the Transport Layer Security (TLS/SSL) certificate. The Speech SDK verifies that the certificate reported by the remote endpoint is trusted and hasn't been revoked. This verification provides a layer of protection against attacks involving spoofing and other related vectors. The check is accomplished by retrieving a certificate revocation list (CRL) from a certificate authority (CA) used by Azure. A list of Azure CA download locations for updated TLS CRLs can be found in [this document](../../security/fundamentals/tls-certificate-changes.md). -If a destination posing as the Speech service reports a certificate that's been revoked in a retrieved CRL, the SDK will terminate the connection and report an error via a `Canceled` event. The authenticity of a reported certificate can't be checked without an updated CRL. Therefore, the Speech SDK will also treat a failure to download a CRL from an Azure CA location as an error. +If a destination posing as the Speech service reports a certificate that's been revoked in a retrieved CRL, the SDK terminates the connection and reports an error via a `Canceled` event. The authenticity of a reported certificate can't be checked without an updated CRL. Therefore, the Speech SDK also treats a failure to download a CRL from an Azure CA location as an error. > [!WARNING] > If your solution uses proxy or firewall it should be configured to allow access to all certificate revocation list URLs used by Azure. Note that many of these URLs are outside of `microsoft.com` domain, so allowing access to `*.microsoft.com` is not enough. See [this document](../../security/fundamentals/tls-certificate-changes.md) for details. In exceptional cases you may ignore CRL failures (see [the correspondent section](#bypassing-or-ignoring-crl-failures)), but such configuration is strongly not recommended, especially for production scenarios. speechConfig.properties.SetPropertyByString("CONFIG_MAX_CRL_SIZE_KB", "15000") ### Bypassing or ignoring CRL failures -If an environment can't be configured to access an Azure CA location, the Speech SDK will never be able to retrieve an updated CRL. You can configure the SDK either to continue and log download failures or to bypass all CRL checks. +If an environment can't be configured to access an Azure CA location, the Speech SDK can't retrieve an updated CRL. You can configure the SDK either to continue and log download failures or to bypass all CRL checks. > [!WARNING] > CRL checks are a security measure and bypassing them increases susceptibility to attacks. They should not be bypassed without thorough consideration of the security implications and alternative mechanisms for protecting against the attack vectors that CRL checks mitigate. -To continue with the connection when a CRL can't be retrieved, set the property `"OPENSSL_CONTINUE_ON_CRL_DOWNLOAD_FAILURE"` to `"true"`. An attempt will still be made to retrieve a CRL and failures will still be emitted in logs, but connection attempts will be allowed to continue. +To continue with the connection when a CRL can't be retrieved, set the property `"OPENSSL_CONTINUE_ON_CRL_DOWNLOAD_FAILURE"` to `"true"`. An attempt is still made to retrieve a CRL and failures is still emitted in logs, but connection attempts are allowed to continue. ::: zone pivot="programming-language-csharp" speechConfig.properties.SetPropertyByString("OPENSSL_DISABLE_CRL_CHECK", "true") ### CRL caching and performance -By default, the Speech SDK will cache a successfully downloaded CRL on disk to improve the initial latency of future connections. When no cached CRL is present or when the cached CRL is expired, a new list will be downloaded. +By default, the Speech SDK will cache a successfully downloaded CRL on disk to improve the initial latency of future connections. When no cached CRL is present or when the cached CRL is expired, a new list is downloaded. -Some Linux distributions don't have a `TMP` or `TMPDIR` environment variable defined, so the Speech SDK won't cache downloaded CRLs. Without `TMP` or `TMPDIR` environment variable defined, the Speech SDK will download a new CRL for each connection. To improve initial connection performance in this situation, you can [create a `TMPDIR` environment variable and set it to the accessible path of a temporary directory.](https://help.ubuntu.com/community/EnvironmentVariables). +Some Linux distributions don't have a `TMP` or `TMPDIR` environment variable defined, so the Speech SDK doesn't cache downloaded CRLs. Without `TMP` or `TMPDIR` environment variable defined, the Speech SDK downloads a new CRL for each connection. To improve initial connection performance in this situation, you can [create a `TMPDIR` environment variable and set it to the accessible path of a temporary directory.](https://help.ubuntu.com/community/EnvironmentVariables). ## Next steps |
| ai-services | How To Configure Rhel Centos 7 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-configure-rhel-centos-7.md | make -j$(nproc) sudo make install-strip ``` -If the updated compiler and libraries need to be deployed on several machines, you can simply copy them from under `/usr/local` to other machines. If only the runtime libraries are needed then the files in `/usr/local/lib64` will be enough. +If the updated compiler and libraries need to be deployed on several machines, you can copy them from under `/usr/local` to other machines. If only the runtime libraries are needed, then the files in `/usr/local/lib64` are enough. ## Environment settings |
| ai-services | How To Control Connections | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-control-connections.md | -# ms.devlang: cpp, csharp, java # How to monitor and control service connections with the Speech SDK -`SpeechRecognizer` and other objects in the Speech SDK automatically connect to the Speech service when it's appropriate. Sometimes, you may either want extra control over when connections begin and end or want more information about when the Speech SDK establishes or loses its connection. The supporting `Connection` class provides this capability. +The `SpeechRecognizer` and other objects in the Speech SDK automatically connect to the Speech service when it's appropriate. Sometimes, you either want extra control over when connections begin and end or you want more information about when the Speech SDK establishes or loses its connection. The supporting `Connection` class provides this capability. ## Retrieve a Connection object connection.disconnected.addEventListener((s, connectionEventArgs) -> { ## Connect and disconnect -`Connection` has explicit methods to start or end a connection to the Speech service. Reasons you may want to control the connection include: +`Connection` has explicit methods to start or end a connection to the Speech service. Reasons you might want to control the connection include: - Preconnecting to the Speech service to allow the first interaction to start as quickly as possible - Establishing connection at a specific time in your application's logic to gracefully and predictably handle initial connection failures connection.disconnected.addEventListener((s, connectionEventArgs) -> { Some important notes on the behavior when manually modifying connection state: - Trying to connect when already connected will do nothing. It will not generate an error. Monitor the `Connected` and `Disconnected` events if you want to know the current state of the connection.-- A failure to connect that originates from a problem that has no involvement with the Speech service--such as attempting to do so from an invalid state--will throw or return an error as appropriate to the programming language. Failures that require network resolution--such as authentication failures--will not throw or return an error but instead generate a `Canceled` event on the top-level object the `Connection` was created from.+- A failure to connect that originates from a problem that has no involvement with the Speech service--such as attempting to do so from an invalid state--will throw or return an error as appropriate to the programming language. Failures that require network resolution--such as authentication failures--won't throw or return an error but instead generate a `Canceled` event on the top-level object the `Connection` was created from. - Manually disconnecting from the Speech service during an ongoing interaction results in a connection error and loss of data for that interaction. Connection errors are surfaced on the appropriate top-level object's `Canceled` event. ::: zone pivot="programming-language-csharp" |
| ai-services | How To Custom Commands Debug Build Time | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-debug-build-time.md | This article describes how to debug when you see errors while building Custom Co ## Errors when creating an application Custom Commands also creates an application in [LUIS](https://www.luis.ai/) when creating a Custom Commands application. -[LUIS limits 500 applications per authoring resource](../luis/luis-limits.md). Creation of LUIS application could fail if you are using an authoring resource that already has 500 applications. +[LUIS limits 500 applications per authoring resource](../luis/luis-limits.md). Creation of LUIS application could fail if you're using an authoring resource that already has 500 applications. -Make sure the selected LUIS authoring resource has less than 500 applications. If not, you can create new LUIS authoring resource, switch to another one, or try to clean up your LUIS applications. +Make sure the selected LUIS authoring resource has fewer than 500 applications. If not, you can create new LUIS authoring resource, switch to another one, or try to clean up your LUIS applications. ## Errors when deleting an application ### Can't delete LUIS application-When deleting a Custom Commands application, Custom Commands may also try to delete the LUIS application associated with the Custom Commands application. +When you delete a Custom Commands application, Custom Commands might also try to delete the LUIS application associated with the Custom Commands application. If the deletion of LUIS application failed, go to your [LUIS](https://www.luis.ai/) account to delete them manually. Refresh your page and try to delete fewer applications. ## Errors when modifying an application ### Can't delete a parameter or a Web Endpoint-You are not allowed to delete a parameter when it is being used. +You aren't allowed to delete a parameter when it's being used. Remove any reference of the parameter in any speech responses, sample sentences, conditions, actions, and try again. ### Can't delete a Web Endpoint-You are not allowed to delete a Web Endpoint when it is being used. +You aren't allowed to delete a Web Endpoint when it's being used. Remove any **Call Web Endpoint** action that uses this Web Endpoint before removing a Web Endpoint. ## Errors when training an application LUIS has built-in Yes/No intents. Having sample sentences with only "yes", "no" | No | Nope, Not | ### Common sample sentences-Custom Commands does not allow common sample sentences shared among different commands. The training of an application could fail if some sample sentences in one command are already defined in another command. +Custom Commands doesn't allow common sample sentences shared among different commands. The training of an application could fail if some sample sentences in one command are already defined in another command. Make sure you don't have common sample sentences shared among different commands. For best practice of LUIS training, refer [LUIS best practice](../luis/faq.md). ## Can't update LUIS key ### Reassign to E0 authoring resource-LUIS does not support reassigning LUIS application to E0 authoring resource. +LUIS doesn't support reassigning LUIS application to E0 authoring resource. If you need to change your authoring resource from F0 to E0, or change to a different E0 resource, recreate the application. |
| ai-services | How To Custom Commands Debug Runtime | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-debug-runtime.md | This article describes how to debug when you see errors while running Custom Com ## Connection failed -If your run Custom Commands application from [client application (with Speech SDK)](./how-to-custom-commands-setup-speech-sdk.md) or [Windows Voice Assistant Client](./how-to-custom-commands-developer-flow-test.md), you may experience connection errors as listed below: +If your run Custom Commands application from [client application (with Speech SDK)](./how-to-custom-commands-setup-speech-sdk.md) or [Windows Voice Assistant Client](./how-to-custom-commands-developer-flow-test.md), you might experience connection errors as listed below: | Error code | Details | | - | -- | The CancelledDialog event consists of cancellation code and description, as list The dialog is canceled when a required slot isn't successfully updated after certain number of turns. The build-in max number is 3. ### Recognizer usage quota exceeded-Language Understanding (LUIS) has limits on resource usage. Usually "Recognizer usage quota exceeded error" can be caused by: +Language Understanding (LUIS) has limits on resource usage. Usually "Recognizer usage quota exceeded error" is caused by: - Your LUIS authoring exceeds the limit Add a prediction resource to your Custom Commands application: Usually it means transient connection failure to Language Understanding (LUIS) r Your subscription isn't authorized to access the LUIS application. ### Input exceeds the maximum supported length-Your input has exceeded 500 characters. We only allow at most 500 characters for input utterance. +Your input exceeded 500 characters. We only allow at most 500 characters for input utterance. ### Invalid query for the recognizer-Your input has exceeded 500 characters. We only allow at most 500 characters for input utterance. +Your input exceeded 500 characters. We only allow at most 500 characters for input utterance. ### Recognizer return an error The LUIS recognizer returned an error when trying to recognize your input. Can't find the recognizer type specified in your custom commands dialog model. C ## Other common errors ### Unexpected response-Unexpected responses may be caused multiple things. +Unexpected responses result from many different reasons. A few checks to start with: - Yes/No Intents in example sentences A few checks to start with: - Similar intents and examples sentences among commands - The LUIS recognition accuracy may get affected when two commands share similar intents and examples sentences. You can try to make commands functionality and example sentences as distinct as possible. + The LUIS recognition accuracy might get affected when two commands share similar intents and examples sentences. You can try to make commands functionality and example sentences as distinct as possible. For best practice of improving recognition accuracy, refer [LUIS best practice](../luis/faq.md). |
| ai-services | How To Custom Commands Deploy Cicd | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-deploy-cicd.md | Title: 'Continuous Deployment with Azure DevOps (Preview)' + Title: 'Continuous Deployment with Azure DevOps' description: In this article, you learn how to set up continuous deployment for your Custom Commands applications. You create the scripts to support the continuous deployment workflows. Previously updated : 06/18/2020 Last updated : 1/18/2024 The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com ### Set up a pipeline -1. Go to **Azure DevOps - Pipelines** and click "New Pipeline" +1. Go to **Azure DevOps - Pipelines** and select "New Pipeline" 1. In **Connect** section, select the location of your repository where these scripts are located 1. In **Select** section, select your repository 1. In **Configure** section, select "Starter pipeline"-1. Next you'll get an editor with a YAML file, replace the "steps" section with this script. +1. Next you get an editor with a YAML file, replace the "steps" section with this script. ```yaml steps: The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com failOnStderr: true ``` -1. Note that these scripts assume that you are using the region `westus2`, if that's not the case update the arguments of the tasks accordingly +1. These scripts assume that you're using the region `westus2`, if that's not the case update the arguments of the tasks accordingly > [!div class="mx-imgBorder"] >  -1. In the "Save and run" button, open the dropdown and click "Save" +1. In the "Save and run" button, open the dropdown and select "Save" ### Hook up the pipeline with your application The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com ## Deploy from source code -In case you want to keep the definition of your application in a repository, we provide the scripts for deployments from source code. Since the scripts are in bash, If you are using Windows you'll need to install the [Linux subsystem](/windows/wsl/install-win10). +In case you want to keep the definition of your application in a repository, we provide the scripts for deployments from source code. Since the scripts are in bash, If you're using Windows you need to install the [Linux subsystem](/windows/wsl/install-win10). The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/tree/master/custom-commands). Clone the scripts in the bash directory to your repository. Make sure you maintain the same path. ### Prepare your repository 1. Create a directory for your application, in our example create one called "apps".-1. Update the arguments of the bash script below, and run. It will import the dialog model of your application to the file myapp.json +1. Update the arguments of the bash script below, and run. It imports the dialog model of your application to the file myapp.json ```BASH bash/export.sh -r <region> -s <subscriptionkey> -c en-us -a <appid> -f apps/myapp.json ``` The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com ### Set up a pipeline -1. Go to **Azure DevOps - Pipelines** and click "New Pipeline" +1. Go to **Azure DevOps - Pipelines** and select "New Pipeline" 1. In **Connect** section, select the location of your repository where these scripts are located 1. In **Select** section, select your repository 1. In **Configure** section, select "Starter pipeline"-1. Next you'll get an editor with a YAML file, replace the "steps" section with this script. +1. Next you get an editor with a YAML file, replace the "steps" section with this script. ```yaml steps: The scripts are hosted at [Voice Assistant - Custom Commands](https://github.com > [!NOTE] > these scripts assume that you are using the region westus2, if that's not the case update the arguments of the tasks accordingly -1. In the "Save and run" button, open the dropdown and click "Save" +1. In the "Save and run" button, open the dropdown and select "Save" ### Hook up the pipeline with your target applications |
| ai-services | How To Custom Commands Developer Flow Test | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-developer-flow-test.md | In this article, you learn different approaches to testing a custom commands app ## Test in the portal -Test in the portal is the simplest and quickest way to check if your custom command application work as expected. After the app is successfully trained, click `Test` button to start testing. +Test in the portal is the simplest and quickest way to check if your custom command application work as expected. After the app is successfully trained, select `Test` button to start testing. > [!div class="mx-imgBorder"] >  |
| ai-services | How To Custom Commands Send Activity To Client | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-send-activity-to-client.md | using Windows.UI.Core; ### Handle the received payload -In `InitializeDialogServiceConnector`, replace the `ActivityReceived` event handler with following code. The modified `ActivityReceived` event handler will extract the payload from the activity and change the visual state of the tv or fan respectively. +In `InitializeDialogServiceConnector`, replace the `ActivityReceived` event handler with following code. The modified `ActivityReceived` event handler extracts the payload from the activity and change the visual state of the tv or fan respectively. ```C# connector.ActivityReceived += async (sender, activityReceivedEventArgs) => |
| ai-services | How To Custom Commands Setup Speech Sdk | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-setup-speech-sdk.md | In this article, you learn how to make requests to a published Custom Commands a ## Prerequisites -A Custom Commands application is required to complete this article. If you haven't created a Custom Commands application, you can do so following the quickstarts: +A Custom Commands application is required to complete this article. Try a quickstart to create a custom commands application: > [!div class = "checklist"] > * [Create a Custom Commands application](quickstart-custom-commands-application.md) -You'll also need: +You also need: > [!div class = "checklist"] > * [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) or higher. This guide is based on Visual Studio 2019. > * An Azure AI Speech resource key and region: Create a Speech resource on the [Azure portal](https://portal.azure.com). For more information, see [Create a multi-service resource](../multi-service-resource.md?pivots=azportal). You'll also need: ## Step 1: Publish Custom Commands application -1. Open your previously created Custom Commands application -1. Go to **Settings**, select **LUIS resource** -1. If **Prediction resource** is not assigned, select a query prediction key or create a new one +1. Open your previously created Custom Commands application. +1. Go to **Settings**, select **LUIS resource**. +1. If **Prediction resource** isn't assigned, select a query prediction key or create a new one. Query prediction key is always required before publishing an application. For more information about LUIS resources, reference [Create LUIS Resource](../luis/luis-how-to-azure-subscription.md) -1. Go back to editing Commands, Select **Publish** +1. Go back to editing Commands, Select **Publish**. > [!div class="mx-imgBorder"] >  -1. Copy the App ID from the publish notification for later use -1. Copy the Speech Resource Key for later use +1. Copy the App ID from the "publish" notification for later use. +1. Copy the Speech Resource Key for later use. ## Step 2: Create a Visual Studio project The Design view is updated to show the application's user interface. Add the code-behind source so that the application works as expected. The code-behind source includes: -- Required `using` statements for the `Speech` and `Speech.Dialog` namespaces-- A simple implementation to ensure microphone access, wired to a button handler-- Basic UI helpers to present messages and errors in the application-- A landing point for the initialization code path that will be populated later-- A helper to play back text to speech (without streaming support)-- An empty button handler to start listening that will be populated later+- Required `using` statements for the `Speech` and `Speech.Dialog` namespaces. +- A simple implementation to ensure microphone access, wired to a button handler. +- Basic UI helpers to present messages and errors in the application. +- A landing point for the initialization code path. +- A helper to play back text to speech (without streaming support). +- An empty button handler to start listening. Add the code-behind source as follows: |
| ai-services | How To Custom Commands Setup Web Endpoints | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-setup-web-endpoints.md | -In this article, you'll learn how to set up web endpoints in a Custom Commands application that allow you to make HTTP requests from a client application. You'll complete the following tasks: +In this article, you learn how to set up web endpoints in a Custom Commands application that allow you to make HTTP requests from a client application. You complete the following tasks: - Set up web endpoints in Custom Commands application - Call web endpoints in Custom Commands application In this article, you'll learn how to set up web endpoints in a Custom Commands a For this tutorial, you need an HTTP endpoint that maintains states for all the devices you set up in the **TurnOnOff** command of your Custom Commands application. -If you already have a web endpoint you want to call, skip to the [next section](#setup-web-endpoints-in-custom-commands). +If you already have a web endpoint you want to call, skip to the [next section](#set-up-web-endpoints-in-custom-commands). Alternatively, the next section provides details about a default hosted web endpoint you can use if you want to skip this section. ### Input format of Azure function -Next, you'll deploy an endpoint using [Azure Functions](../../azure-functions/index.yml). +Next, you deploy an endpoint using [Azure Functions](../../azure-functions/index.yml). The following is the format of a Custom Commands event that is passed to your Azure function. Use this information when you're writing your Azure Function app. ```json The following table describes the key attributes of this input: | **currentGlobalParameters** | A map like `parameters`, but used for global parameters. | -For the **DeviceState** Azure Function, an example Custom Commands event will look like following. This will act as an **input** to the function app. +For the **DeviceState** Azure Function, an example Custom Commands event looks like following. This acts as an **input** to the function app. ```json { For our **DeviceState** endpoint, output of your Azure function is consumed by a } ``` -This output should be written to an external storage, so that you can maintain the state of devices. The external storage state will be used in the [Integrate with client application](#integrate-with-client-application) section below. +This output should be written to an external storage, so that you can maintain the state of devices. The external storage state is used in the [Integrate with client application](#integrate-with-client-application) section below. ### Deploy Azure function This output should be written to an external storage, so that you can maintain t We provide a sample you can configure and deploy as an Azure Functions app. To create a storage account for our sample, follow these steps. 1. Create table storage to save device state. In the Azure portal, create a new resource of type **Storage account** by name **devicestate**.-1. Copy the **Connection string** value from **devicestate -> Access keys**. You'll need to add this string secret to the downloaded sample Function App code. +1. Copy the **Connection string** value from **devicestate -> Access keys**. You need to add this string secret to the downloaded sample Function App code. 1. Download sample [Function App code](https://github.com/Azure-Samples/Cognitive-Services-Voice-Assistant/tree/main/custom-commands/quick-start). 1. Open the downloaded solution in Visual Studio 2019. In **Connections.json**, replace **STORAGE_ACCOUNT_SECRET_CONNECTION_STRING** with the secret from Step 2. 1. Download the **DeviceStateAzureFunction** code. To deploy the sample app to Azure Functions, follow these steps. 1. Select **Functions** in the left pane, and then select **DeviceState**. 1. In the new window, select **Code + Test** and then select **Get function URL**. -## Setup web endpoints in Custom Commands +## Set up web endpoints in Custom Commands Let's hook up the Azure function with the existing Custom Commands application.-In this section, you'll use an existing default **DeviceState** endpoint. If you created your own web endpoint using Azure Function or otherwise, use that instead of the default `https://webendpointexample.azurewebsites.net/api/DeviceState`. +In this section, you use an existing default **DeviceState** endpoint. If you created your own web endpoint using Azure Function or otherwise, use that instead of the default `https://webendpointexample.azurewebsites.net/api/DeviceState`. 1. Open the Custom Commands application you previously created. 1. Go to **Web endpoints**, select **New web endpoint**. In this section, you'll use an existing default **DeviceState** endpoint. If you | Name | UpdateDeviceState | Name for the web endpoint. | | URL | ```https://webendpointexample.azurewebsites.net/api/DeviceState``` | The URL of the endpoint you wish your custom command app to talk to. | | Method | POST | The allowed interactions (such as GET, POST) with your endpoint.|- | Headers | Key: app, Value: take the first 8 digits of your applicationId | The header parameters to include in the request header.| + | Headers | Key: app, Value: take the first eight digits of your applicationId | The header parameters to include in the request header.| > [!NOTE] > - The example web endpoint created using [Azure Functions](../../azure-functions/index.yml), which hooks up with the database that saves the device state of the tv and fan. |
| ai-services | How To Custom Commands Update Command From Client | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-update-command-from-client.md | -In this article, you'll learn how to update an ongoing command from a client application. +In this article, you learn how to update an ongoing command from a client application. ## Prerequisites > [!div class = "checklist"] Note how the value for the parameter `"OnOff"` was set to `"on"` through an acti When you configure the list of valid options for a parameter, the values for the parameter are defined globally for the application. -In our example, the `SubjectDevice` parameter will have a fixed list of supported values regardless of the conversation. +In our example, the `SubjectDevice` parameter has a fixed list of supported values regardless of the conversation. If you want to add new entries to the parameter's catalog per conversation, you can send the following activity: Note a couple of things: ## Add more context from the client application -You can set additional context from the client application per conversation that can later be used in your Custom Commands application. +You can set more context from the client application per conversation that can later be used in your Custom Commands application. For example, think about the scenario where you want to send the ID and name of the device connected to the Custom Commands application. |
| ai-services | How To Custom Commands Update Command From Web Endpoint | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-services/speech-service/how-to-custom-commands-update-command-from-web-endpoint.md | -In this article, you'll learn how to update an ongoing command from a web endpoint. +In this article, you learn how to update an ongoing command from a web endpoint. ## Prerequisites > [!div class = "checklist"] In this article, you'll learn how to update an ongoing command from a web endpoi ## Create an Azure function -For this example, you'll need an HTTP-triggered [Azure function](../../azure-functions/index.yml) that supports the following input (or a subset of this input): +For this example, you need an HTTP-triggered [Azure function](../../azure-functions/index.yml) that supports the following input (or a subset of this input): ```JSON { Let's review the key attributes of this input: | Attribute | Explanation | | - | |-| **conversationId** | The unique identifier of the conversation. Note that this ID can be generated from the client app. | +| **conversationId** | The unique identifier of the conversation. This ID can be generated from the client app. | | **currentCommand** | The command that's currently active in the conversation. | | **name** | The name of the command. The `parameters` attribute is a map with the current values of the parameters. | | **currentGlobalParameters** | A map like `parameters`, but used for global parameters. | module.exports = async function (context, req) { } ``` -When you call this Azure function from Custom Commands, you'll send the current values of the conversation. You'll return the parameters that you want to update or if you want to cancel the current command. +When you call this Azure function from Custom Commands, you send the current values of the conversation. You return the parameters that you want to update or if you want to cancel the current command. ## Update the existing Custom Commands app |
| ai-studio | Index Lookup Tool | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/ai-studio/how-to/prompt-flow-tools/index-lookup-tool.md | + + Title: Index lookup tool for flows in Azure AI Studio ++description: This article introduces the Index Lookup tool for flows in Azure AI Studio. ++++ Last updated : 01/18/2024++++# Index Lookup tool for Azure AI Studio +++The prompt flow *Index Lookup* tool enables the usage of common vector indices (such as Azure AI Search, FAISS, and Pinecone) for retrieval augmented generation (RAG) in prompt flow. The tool automatically detects the indices in the workspace and allows the selection of the index to be used in the flow. ++## Build with the Index Lookup tool ++1. Create or open a flow in Azure AI Studio. For more information, see [Create a flow](../flow-develop.md). +1. Select **+ More tools** > **Index Lookup** to add the Index Lookup tool to your flow. ++ :::image type="content" source="../../media/prompt-flow/index-lookup-tool.png" alt-text="Screenshot of the Index Lookup tool added to a flow in Azure AI Studio." lightbox="../../media/prompt-flow/index-lookup-tool.png"::: ++1. Enter values for the Index Lookup tool [input parameters](#inputs). The [LLM tool](llm-tool.md) can generate the vector input. +1. Add more tools to your flow as needed, or select **Run** to run the flow. +1. To learn more about the returned output, see [outputs](#outputs). +++## Inputs ++The following are available input parameters: ++| Name | Type | Description | Required | +| - | - | -- | -- | +| mlindex_content | string | Type of Index to be used. Input depends on Index type. Example of an Azure Cog Search Index JSON can be seen below the table* | Yes | +| queries | string, Union[string, List[String]] | The text to be queried.| Yes | +|query_type | string | The type of query to be performed. Options include Keyword, Semantic, Hybrid, etc. | Yes | +| top_k | integer | The count of top-scored entities to return. Default value is 3. | No | ++\**ACS JSON Example:* +```json +embeddings: + api_base: <api_base> + api_type: azure + api_version: 2023-07-01-preview + batch_size: '1' + connection: + id: /subscriptions/<subscription>/resourceGroups/<resource_group>/providers/Microsoft.MachineLearningServices/workspaces/<workspace> /connections/<AOAI_connection> + connection_type: workspace_connection + deployment: <embedding_deployment> + dimension: <embedding_model_dimension> + kind: open_ai + model: <embedding_model> + schema_version: <version> +index: + api_version: 2023-07-01-Preview + connection: + id: /subscriptions/<subscription>/resourceGroups/<resource_group>/providers/Microsoft.MachineLearningServices/workspaces/<workspace> /connections/<cogsearch_connection> + connection_type: workspace_connection + endpoint: <cogsearch_endpoint> + engine: azure-sdk + field_mapping: + content: id + embedding: content_vector_open_ai + metadata: id + index: <index_name> + kind: acs + semantic_configuration_name: azureml-default ++++``` ++## Outputs ++The following JSON format response is an example returned by the tool that includes the top-k scored entities. The entity follows a generic schema of vector search result provided by promptflow-vectordb SDK. For the Vector Index Search, the following fields are populated: ++| Field Name | Type | Description | +| - | - | -- | +| metadata | dict | Customized key-value pairs provided by user when creating the index | +| page_content | string | Content of the vector chunk being used in the lookup | +| score | float | Depends on index type defined in Vector Index. If index type is Faiss, score is L2 distance. If index type is Azure AI Search, score is cosine similarity. | +++ +```json +[ + { + "metadata":{ + "answers":{}, + "captions":{ + "highlights":"sample_highlight1", + "text":"sample_text1" + }, + "page_number":44, + "source":{ + "filename":"sample_file1.pdf", + "mtime":1686329994, + "stats":{ + "chars":4385, + "lines":41, + "tiktokens":891 + }, + "url":"sample_url1.pdf" + }, + "stats":{ + "chars":4385,"lines":41,"tiktokens":891 + } + }, + "page_content":"vector chunk", + "score":0.021349556744098663 + }, ++ { + "metadata":{ + "answers":{}, + "captions":{ + "highlights":"sample_highlight2", + "text":"sample_text2" + }, + "page_number":44, + "source":{ + "filename":"sample_file2.pdf", + "mtime":1686329994, + "stats":{ + "chars":4385, + "lines":41, + "tiktokens":891 + }, + "url":"sample_url2.pdf" + }, + "stats":{ + "chars":4385,"lines":41,"tiktokens":891 + } + }, + "page_content":"vector chunk", + "score":0.021349556744098663 + }, + +] ++``` ++## Next steps ++- [Learn more about how to create a flow](../flow-develop.md) |
| aks | Azure Csi Blob Storage Provision | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/azure-csi-blob-storage-provision.md | For more information on Kubernetes volumes, see [Storage options for application ## Before you begin -- If you don't have a storage account that supports the NFS v3 protocol, review [NFS v3 support with Azure Blob storage][azure-blob-storage-nfs-support].- - [Enable the Blob storage CSI driver][enable-blob-csi-driver] on your AKS cluster. - To support an [Azure DataLake Gen2 storage account][azure-datalake-storage-account] when using blobfuse mount, you'll need to do the following: For more information on Kubernetes volumes, see [Storage options for application - To create an ADLS account using the driver in dynamic provisioning, specify `isHnsEnabled: "true"` in the storage class parameters. - To enable blobfuse access to an ADLS account in static provisioning, specify the mount option `--use-adls=true` in the persistent volume. - If you are going to enable a storage account with Hierarchical Namespace, existing persistent volumes should be remounted with `--use-adls=true` mount option.+ +- About blobfuse cache + - By default, the blobfuse cache is located in the `/mnt` directory. If the VM SKU provides a temporary disk, the `/mnt` directory is mounted on the temporary disk. However, if the VM SKU does not provide a temporary disk, the `/mnt` directory is mounted on the OS disk, you could set `--tmp-path=` mount option to specify a different cache directory ## Dynamically provision a volume |
| aks | Cluster Configuration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/cluster-configuration.md | The following deployment uses the ARM template `azurelinuxaksarm.json`. "count": "[parameters('agentCount')]", "vmSize": "[parameters('agentVMSize')]", "osType": "[parameters('osType')]",- "osSKU": "[parameters('osSKU')]", - "storageProfile": "ManagedDisks" + "osSKU": "[parameters('osSKU')]" } ], "linuxProfile": { |
| aks | Concepts Clusters Workloads | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/concepts-clusters-workloads.md | Title: Azure Kubernetes Services (AKS) Core Basic Concepts description: Learn about the core components that make up workloads and clusters in Kubernetes and their counterparts on Azure Kubernetes Services (AKS). Previously updated : 12/13/2023 Last updated : 01/16/2024 # Core Kubernetes concepts for Azure Kubernetes Service If you need advanced configuration and control on your Kubernetes node container AKS uses node resources to help the node function as part of your cluster. This usage can create a discrepancy between your node's total resources and the allocatable resources in AKS. Remember this information when setting requests and limits for user deployed pods. To find a node's allocatable resources, run:+ ```kubectl kubectl describe node [NODE_NAME] ``` To maintain node performance and functionality, AKS reserves resources on each node. As a node grows larger in resources, the resource reservation grows due to a higher need for management of user-deployed pods. ->[!NOTE] +> [!NOTE] > Using AKS add-ons such as Container Insights (OMS) will consume additional node resources. Two types of resources are reserved: Two types of resources are reserved: Reserved CPU is dependent on node type and cluster configuration, which may cause less allocatable CPU due to running additional features. -| CPU cores on host | 1 | 2 | 4 | 8 | 16 | 32|64| -||||||||| -|Kube-reserved (millicores)|60|100|140|180|260|420|740| +| CPU cores on host | 1 | 2 | 4 | 8 | 16 | 32 | 64 | +|-|-|--|--|--|--|--|--| +| Kube-reserved (millicores) | 60 | 100 | 140 | 180 | 260 | 420 | 740 | #### Memory A pod is a logical resource, but application workloads run on the containers. Po A *deployment* represents identical pods managed by the Kubernetes Deployment Controller. A deployment defines the number of pod *replicas* to create. The Kubernetes Scheduler ensures that additional pods are scheduled on healthy nodes if pods or nodes encounter problems. You can update deployments to change the configuration of pods, container image used, or attached storage. The Deployment Controller:+ * Drains and terminates a given number of replicas. * Creates replicas from the new deployment definition. * Continues the process until all replicas in the deployment are updated. |
| aks | Deploy Confidential Containers Default Policy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/deploy-confidential-containers-default-policy.md | Use the following command to enable Confidential Containers (preview) by creatin * **--cluster-name**: Enter a unique name for the AKS cluster, such as *myAKSCluster*. * **--name**: Enter a unique name for your clusters node pool, such as *nodepool2*. * **--workload-runtime**: Specify *KataCcIsolation* to enable the feature on the node pool. Along with the `--workload-runtime` parameter, these other parameters shall satisfy the following requirements. Otherwise, the command fails and reports an issue with the corresponding parameter(s).- * **--os-sku**: **AzureLinux*. Only the Azure Linux os-sku supports this feature in this preview release. + * **--os-sku**: *AzureLinux*. Only the Azure Linux os-sku supports this feature in this preview release. * **--node-vm-size**: Any Azure VM size that is a generation 2 VM and supports nested virtualization works. For example, [Standard_DC8as_cc_v5][DC8as-series] VMs. The following example adds a user node pool to *myAKSCluster* with two nodes in *nodepool2* in the *myResourceGroup*: For this preview release, we recommend for test and evaluation purposes to eithe 1. Grant the managed identity you created earlier, and your account, access to the key vault. [Assign][assign-key-vault-access-cli] both identities the **Key Vault Crypto Officer** and **Key Vault Crypto User** Azure RBAC roles. >[!NOTE]- >The managed identity is the value you assigned to the `USER_ASSIGNED_IDENTITY_NAME` variable. + >The managed identity is the value you assign to the `USER_ASSIGNED_IDENTITY_NAME` variable. >[!NOTE] >To add role assignments, you must have `Microsoft.Authorization/roleAssignments/write` and `Microsoft.Authorization/roleAssignments/delete` permissions, such as [Key Vault Data Access Administrator][key-vault-data-access-admin-rbac], [User Access Administrator][user-access-admin-rbac], or [Owner][owner-rbac]. For this preview release, we recommend for test and evaluation purposes to eithe ``` -1. Prepare the RSA Encryption/Decryption key by the [bash script](https://github.com/microsoft/confidential-container-demos/raw/main/kafka/setup-key.sh) for the workload from GitHub. Save the file as `setup-key.sh`. +1. Prepare the RSA Encryption/Decryption key using the [bash script](https://github.com/microsoft/confidential-container-demos/raw/main/kafka/setup-key.sh) for the workload from GitHub. Save the file as `setup-key.sh`. 1. Set the `MAA_ENDPOINT` environmental variable to match the value for the `SkrClientMAAEndpoint` from the `consumer.yaml` manifest file by running the following command. For this preview release, we recommend for test and evaluation purposes to eithe 1. Copy and paste the external IP address of the consumer service into your browser and observe the decrypted message. - The following resembles the output of the command: + The following example resembles the output of the command: ```output Welcome to Confidential Containers on AKS! |
| aks | Keda Deploy Add On Arm | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/keda-deploy-add-on-arm.md | The following snippet is a sample deployment that creates a cluster with KEDA en "enableAutoScaling": false, "vmSize": "Standard_D2S_v5", "osType": "Linux",- "storageProfile": "ManagedDisks", "type": "VirtualMachineScaleSets", "mode": "System", "maxPods": 110, To learn more, view the [upstream KEDA docs][keda]. [kubectl]: https://kubernetes.io/docs/reference/kubectl/ [keda-scalers]: https://keda.sh/docs/scalers/ [keda-sample]: https://github.com/kedacore/sample-dotnet-worker-servicebus-queue-[keda]: https://keda.sh/docs/2.12/ +[keda]: https://keda.sh/docs/2.12/ |
| aks | Manage Node Pools | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/manage-node-pools.md | When you use an Azure Resource Manager template to create and manage resources, "count": "[variables('agentPoolProfiles').agentCount]", "vmSize": "[variables('agentPoolProfiles').agentVmSize]", "osType": "[variables('agentPoolProfiles').osType]",- "storageProfile": "ManagedDisks", "type": "VirtualMachineScaleSets", "vnetSubnetID": "[variables('agentPoolProfiles').vnetSubnetId]", "orchestratorVersion": "1.15.7" |
| aks | Node Autoprovision | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/node-autoprovision.md | Title: Node autoprovisioning (Preview) -description: Learn about Azure Kubernetes Service (AKS) Node autoprovisioning + Title: Node autoprovisioning (preview) +description: Learn about Azure Kubernetes Service (AKS) node autoprovisioning (preview). Previously updated : 10/19/2023 Last updated : 01/18/2024 #Customer intent: As a cluster operator or developer, how to scale my cluster based on workload requirements and right size my nodes automatically -# Node autoprovision -When deploying workloads onto AKS, you need to make a decision about the node pool configuration regarding the VM size needed. As your workloads become more complex, and require different CPU, Memory and capabilities to run, the overhead of having to design your VM configuration for numerous resource requests becomes difficult. +# Node autoprovisioning (preview) -Node autoprovision (NAP) decides based on pending pod resource requirements the optimal VM configuration to run those workloads in the most efficient and cost effective manner. +When you deploy workloads onto AKS, you need to make a decision about the node pool configuration regarding the VM size needed. As your workloads become more complex, and require different CPU, memory, and capabilities to run, the overhead of having to design your VM configuration for numerous resource requests becomes difficult. ++Node autoprovisioning (NAP) (preview) decides based on pending pod resource requirements the optimal VM configuration to run those workloads in the most efficient and cost effective manner. NAP is based on the Open Source [Karpenter](https://karpenter.sh) project, and the [AKS provider](https://github.com/Azure/karpenter) is also Open Source. NAP automatically deploys and configures and manages Karpenter on your AKS clusters. +> [!IMPORTANT] +> Node autoprovisioning (NAP) for AKS is currently in PREVIEW. +> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. ## Before you begin NAP is based on the Open Source [Karpenter](https://karpenter.sh) project, and t ``` ## Limitations-* Windows and Azure Linux node pools aren't supported yet -* Kubelet configuration through Node pool configuration is not supported -* NAP can only be enabled on new clusters currently ++- Windows and Azure Linux node pools aren't supported yet +- Kubelet configuration through Node pool configuration is not supported +- NAP can only be enabled on new clusters currently ## Enable node autoprovisioning-To enable node autoprovisioning, create a new cluster using the az aks create command and set --node-provisioning-mode to "Auto". You'll also need to use overlay networking and the cilium network policy. +To enable node autoprovisioning, create a new cluster using the az aks create command and set --node-provisioning-mode to "Auto". You'll also need to use overlay networking and the cilium network policy. ### [Azure CLI](#tab/azure-cli) az aks create --name karpuktest --resource-group karpuk --node-provisioning-mode ``` ### [Azure ARM](#tab/azure-arm)+ ```azurecli-interactive az deployment group create --resource-group napcluster --template-file ./nap.json ``` az deployment group create --resource-group napcluster --template-file ./nap.jso ] } ```+ + ## Node pools-Node autoprovision uses a list of VM SKUs as a starting point to decide which is best suited for the workloads that are in a pending state. Having control over what SKU you want in the initial pool allows you to specify specific SKU families, or VM types and the maximum amount of resources a provisioner uses. +Node autoprovision uses a list of VM SKUs as a starting point to decide which is best suited for the workloads that are in a pending state. Having control over what SKU you want in the initial pool allows you to specify specific SKU families, or VM types and the maximum amount of resources a provisioner uses. If you have specific VM SKUs that are reserved instances, for example, you may wish to only use those VMs as the starting pool. You can have multiple node pool definitions in a cluster, but AKS deploys a default node pool definition that you can modify: - ```yaml apiVersion: karpenter.sh/v1beta1 kind: NodePool spec: - D ``` -### Supported node provisioner requirements +### Supported node provisioner requirements -#### SKU selectors with well known labels +#### SKU selectors with well known labels -| Selector | Description | Example | -||| -| karpenter.azure.com/sku-family | VM SKU Family | D, F, L etc. | -| karpenter.azure.com/sku-name | Explicit SKU name | Standard_A1_v2 | -| karpenter.azure.com/sku-version | SKU version (without "v", can use 1) | 1 , 2 | +| Selector | Description | Example | +|--|--|--| +| karpenter.azure.com/sku-family | VM SKU Family | D, F, L etc. | +| karpenter.azure.com/sku-name | Explicit SKU name | Standard_A1_v2 | +| karpenter.azure.com/sku-version | SKU version (without "v", can use 1) | 1 , 2 | | karpenter.sh/capacity-type | VM allocation type (Spot / On Demand) | spot or on-demand | | karpenter.azure.com/sku-cpu | Number of CPUs in VM | 16 |-| karpenter.azure.com/sku-memory | Memory in VM in MiB | 131072 | -| karpenter.azure.com/sku-gpu-name | GPU name | A100 | -| karpenter.azure.com/sku-gpu-manufacturer | GPU manufacturer | nvidia | +| karpenter.azure.com/sku-memory | Memory in VM in MiB | 131072 | +| karpenter.azure.com/sku-gpu-name | GPU name | A100 | +| karpenter.azure.com/sku-gpu-manufacturer | GPU manufacturer | nvidia | | karpenter.azure.com/sku-gpu-count | GPU count per VM | 2 | | karpenter.azure.com/sku-networking-accelerated | Whether the VM has accelerated networking | [true, false] | | karpenter.azure.com/sku-storage-premium-capable | Whether the VM supports Premium IO storage | [true, false] | | karpenter.azure.com/sku-storage-ephemeralos-maxsize | Size limit for the Ephemeral OS disk in Gb | 92 |-| topology.kubernetes.io/zone | The Availability Zone(s) | [uksouth-1,uksouth-2,uksouth-3] | -| kubernetes.io/os | Operating System (Linux only during preview) | linux | -| kubernetes.io/arch | CPU architecture (AMD64 or ARM64) | [amd64, arm64] | - -+| topology.kubernetes.io/zone | The Availability Zone(s) | [uksouth-1,uksouth-2,uksouth-3] | +| kubernetes.io/os | Operating System (Linux only during preview) | linux | +| kubernetes.io/arch | CPU architecture (AMD64 or ARM64) | [amd64, arm64] | To list the VM SKU capabilities and allowed values, use the `vm list-skus` command from the Azure CLI. az vm list-skus --resource-type virtualMachines --location <location> --query '[ ``` ## Node pool limits-By default, NAP attempts to schedule your workloads within the Azure quota you have available. You can also specify the upper limit of resources that is used by a Nodepool, specifying limits within the Node pool spec. ++By default, NAP attempts to schedule your workloads within the Azure quota you have available. You can also specify the upper limit of resources that is used by a node pool, specifying limits within the node pool spec. ``` # Resource limits constrain the total size of the cluster. By default, NAP attempts to schedule your workloads within the Azure quota you h memory: 1000Gi ``` - ## Node pool weights-When you have multiple Nodepools defined, it's possible to set a preference of where a workload should be scheduled. Define the relative weight on your Node pool definitions. ++When you have multiple node pools defined, it's possible to set a preference of where a workload should be scheduled. Define the relative weight on your Node pool definitions. ``` # Priority given to the node pool when the scheduler considers which to select. Higher weights indicate higher priority when comparing node pools. When you have multiple Nodepools defined, it's possible to set a preference of w weight: 10 ``` -## Kubernetes and node image updates +## Kubernetes and node image updates + AKS with NAP manages the Kubernetes version upgrades and VM OS disk updates for you by default. ### Kubernetes upgrades+ Kubernetes upgrades for NAP node pools follows the Control Plane Kubernetes version. If you perform a cluster upgrade, your NAP nodes are updated automatically to follow the same versioning. ### Node image updates+ By default NAP node pool virtual machines are automatically updated when a new image is available. If you wish to pin a node pool at a certain node image version, you can set the imageVersion on the node class: ```kubectl spec: Removing the imageVersion spec would revert the node pool to be updated to the latest node image version. - ## Node disruption When the workloads on your nodes scale down, NAP uses disruption rules on the Node pool specification to decide when and how to remove those nodes and potentially reschedule your workloads to be more efficient. You can remove a node manually using `kubectl delete node`, but NAP can also control when it should optimize your nodes. - ```yaml disruption: # Describes which types of Nodes NAP should consider for consolidation You can remove a node manually using `kubectl delete node`, but NAP can also con consolidateAfter: 30s ``` -## Monitoring selection events +## Monitoring selection events + Node autoprovision produces cluster events that can be used to monitor deployment and scheduling decisions being made. You can view events through the Kubernetes events stream. ``` kubectl get events -A --field-selector source=karpenter -w [az-extension-add]: /cli/azure/extension#az-extension-add [az-extension-update]: /cli/azure/extension#az-extension-update-[az-feature-register]: /cli/azure/feature#az-feature-register |
| aks | Scale Cluster | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/scale-cluster.md | Review the [AKS service quotas and limits][service-quotas] to ensure your cluste "name": "nodepool1", "osDiskSizeGb": 30, "osType": "Linux",- "storageProfile": "ManagedDisks", "vmSize": "Standard_DS2_v2" } ] Review the [AKS service quotas and limits][service-quotas] to ensure your cluste "name": "nodepool1", "osDiskSizeGb": 30, "osType": "Linux",- "storageProfile": "ManagedDisks", "vmSize": "Standard_DS2_v2", "vnetSubnetId": null } |
| aks | Supported Kubernetes Versions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/supported-kubernetes-versions.md | New Supported Version List ## Platform support policy -Platform support policy is a reduced support plan for certain unsupported kubernetes versions. During platform support, customers only receive support from Microsoft for AKS/Azure platform related issues. Any issues related to Kubernetes functionality and components aren't supported. +Platform support policy is a reduced support plan for certain unsupported Kubernetes versions. During platform support, customers only receive support from Microsoft for AKS/Azure platform related issues. Any issues related to Kubernetes functionality and components aren't supported. -Platform support policy applies to clusters in an n-3 version (where n is the latest supported AKS GA minor version), before the cluster drops to n-4. For example, kubernetes v1.25 is considered platform support when v1.28 is the latest GA version. However, during the v1.29 GA release, v1.25 will then auto-upgrade to v1.26. If you are a running an n-2 version, the moment it becomes n-3 it also becomes deprecated, and you enter into the platform support policy. +Platform support policy applies to clusters in an n-3 version (where n is the latest supported AKS GA minor version), before the cluster drops to n-4. For example, Kubernetes v1.25 is considered platform support when v1.28 is the latest GA version. However, during the v1.29 GA release, v1.25 will then auto-upgrade to v1.26. If you are a running an n-2 version, the moment it becomes n-3 it also becomes deprecated, and you enter into the platform support policy. -AKS relies on the releases and patches from [kubernetes](https://kubernetes.io/releases/), which is an Open Source project that only supports a sliding window of three minor versions. AKS can only guarantee [full support](#kubernetes-version-support-policy) while those versions are being serviced upstream. Since there's no more patches being produced upstream, AKS can either leave those versions unpatched or fork. Due to this limitation, platform support doesn't support anything from relying on kubernetes upstream. +AKS relies on the releases and patches from [Kubernetes](https://kubernetes.io/releases/), which is an Open Source project that only supports a sliding window of three minor versions. AKS can only guarantee [full support](#kubernetes-version-support-policy) while those versions are being serviced upstream. Since there's no more patches being produced upstream, AKS can either leave those versions unpatched or fork. Due to this limitation, platform support doesn't support anything from relying on Kubernetes upstream. This table outlines support guidelines for Community Support compared to Platform support. |
| aks | Tutorial Kubernetes Scale | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/tutorial-kubernetes-scale.md | The following example increases the number of nodes to three in the Kubernetes c "osDiskSizeGb": null, "osType": "Linux", "ports": null,- "storageProfile": "ManagedDisks", "vmSize": "Standard_D2_v2", "vnetSubnetId": null } |
| aks | Tutorial Kubernetes Upgrade Cluster | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/aks/tutorial-kubernetes-upgrade-cluster.md | You can either [manually upgrade your cluster](#manually-upgrade-cluster) or [co "maxPods": 110, "name": "nodepool1", "osType": "Linux",- "storageProfile": "ManagedDisks", "vmSize": "Standard_DS1_v2", } ], |
| api-center | Add Metadata Properties | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/add-metadata-properties.md | |
| api-center | Configure Environments Deployments | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/configure-environments-deployments.md | |
| api-center | Key Concepts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/key-concepts.md | Title: Azure API Center (preview) - Key concepts description: Key concepts of Azure API Center. API Center enables tracking APIs in a centralized location for discovery, reuse, and governance. - Last updated 11/08/2023 - # Azure API Center - key concepts |
| api-center | Manage Apis Azure Cli | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/manage-apis-azure-cli.md | |
| api-center | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/overview.md | Title: Azure API Center (preview) - Overview description: Introduction to key scenarios and capabilities of Azure API Center. API Center inventories an organization's APIs for discovery, reuse, and governance at scale. |
| api-center | Register Apis | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/register-apis.md | |
| api-center | Set Up Api Center | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-center/set-up-api-center.md | |
| api-management | Add Api Manually | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/add-api-manually.md | Title: Add an API manually using the Azure portal | Microsoft Docs description: This tutorial shows you how to use API Management to add an API manually. |
| api-management | Api Management Api Import Restrictions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-api-import-restrictions.md | Title: Restrictions and details of API formats support description: Details of known issues and restrictions on OpenAPI, WSDL, and WADL formats support in Azure API Management. |
| api-management | Api Management Capacity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-capacity.md | Title: Capacity of an Azure API Management instance | Microsoft Docs description: This article explains what the capacity metric is and how to make informed decisions whether to scale an Azure API Management instance. |
| api-management | Api Management Debug Policies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-debug-policies.md | Title: Debug Azure API Management policies in Visual Studio Code | Microsoft Docs description: Learn how to debug Azure API Management Policies using the Azure API Management Visual Studio Code extension - - - Last updated 09/22/2020 |
| api-management | Api Management Error Handling Policies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-error-handling-policies.md | Title: Error handling in Azure API Management policies | Microsoft Docs description: Learn how to respond to error conditions that may occur during the processing of requests in Azure API Management.- - ms.assetid: 3c777964-02b2-4f55-8731-8c3bd3c0ae27 Last updated 01/10/2020 |
| api-management | Api Management Features | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-features.md | Title: Feature-based comparison of the Azure API Management tiers | Microsoft Docs description: Compare API Management tiers based on the features they offer. See a table that summarizes the key features available in each pricing tier. |
| api-management | Api Management Gateways Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-gateways-overview.md | Title: API gateway overview | Azure API Management description: Learn more about the features of the API gateway component of Azure API Management. API Management offers both Azure-managed and self-hosted gateways. |
| api-management | Api Management Get Started Revise Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-get-started-revise-api.md | Title: Tutorial - Use revisions in API Management to make non-breaking API chang description: Follow the steps of this tutorial to learn how to make non-breaking changes using revisions in API Management. |
| api-management | Api Management Howto Api Inspector | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-api-inspector.md | Title: Tutorial - Debug APIs in Azure API Management using request tracing description: Follow the steps of this tutorial to enable tracing and inspect request processing steps in Azure API Management. Last updated 08/08/2022 |
| api-management | Api Management Howto Autoscale | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-autoscale.md | Title: Configure autoscale of an Azure API Management instance | Microsoft Docs description: This article describes how to set up autoscale behavior for an Azure API Management instance. |
| api-management | Api Management Howto Ca Certificates | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-ca-certificates.md | Title: Add a custom CA certificate - Azure API Management | Microsoft Docs description: Learn how to add a custom CA certificate in Azure API Management. You can also see instructions to delete a certificate. |
| api-management | Api Management Howto Cache External | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-cache-external.md | Title: Use an external cache in Azure API Management | Microsoft Docs description: Learn how to configure and use an external Redis-compatible cache in Azure API Management. Using an external cache gives you more control and flexibility than the built-in cache. |
| api-management | Api Management Howto Cache | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-cache.md | Title: Add caching to improve performance in Azure API Management | Microsoft Docs description: Learn how to improve the latency, bandwidth consumption, and web service load for API Management service calls.- - ms.assetid: 740f6a27-8323-474d-ade2-828ae0c75e7a Last updated 11/13/2020 |
| api-management | Api Management Howto Configure Custom Domain Gateway | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-configure-custom-domain-gateway.md | Title: Configure a custom domain name for your self-hosted Azure API Management gateway | Microsoft Docs description: This topic describes the steps for configuring a custom domain name for self-hosted Azure API Management gateway. |
| api-management | Api Management Howto Create Or Invite Developers | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-create-or-invite-developers.md | Title: How to manage user accounts in Azure API Management | Microsoft Docs description: Learn how to create or invite users in Azure API Management. View additional resources to use after creating a developer account. - Last updated 02/13/2018 |
| api-management | Api Management Howto Create Subscriptions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-create-subscriptions.md | Title: Create subscriptions in Azure API Management | Microsoft Docs description: Learn how to create subscriptions in Azure API Management. A subscription is necessary to get subscription keys that allow access to APIs. Last updated 08/03/2022 |
| api-management | Api Management Howto Integrate Internal Vnet Appgateway | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-integrate-internal-vnet-appgateway.md | Title: Use API Management in a virtual network with Azure Application Gateway description: Set up and configure Azure API Management in an internal virtual network with Azure Application Gateway (Web Application Firewall) as a front end. |
| api-management | Api Management Howto Ip Addresses | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-ip-addresses.md | Title: IP addresses of Azure API Management service | Microsoft Docs description: Learn how to retrieve the IP addresses of an Azure API Management service and when they change. |
| api-management | Api Management Howto Mutual Certificates For Clients | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-mutual-certificates-for-clients.md | Title: Secure APIs using client certificate authentication in API Management description: Learn how to secure access to APIs by using client certificates. You can use policy expressions to validate incoming certificates. |
| api-management | Api Management Howto Mutual Certificates | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-mutual-certificates.md | Title: Secure API Management backend using client certificate authentication description: Learn how to manage client certificates and secure backend services using client certificate authentication in Azure API Management. |
| api-management | Api Management Howto Oauth2 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-oauth2.md | Title: Authorize test console of API Management developer portal using OAuth 2.0 description: Set up OAuth 2.0 user authorization for the test console in the Azure API Management developer portal. This example uses Microsoft Entra ID as an OAuth 2.0 provider. |
| api-management | Api Management Howto Policies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-policies.md | Title: Policies in Azure API Management description: Introduction to API Management policies, which change API behavior through configuration. Policy statements run sequentially on an API request or response. |
| api-management | Api Management Howto Provision Self Hosted Gateway | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-provision-self-hosted-gateway.md | Title: Provision a self-hosted gateway in Azure API Management | Microsoft Docs description: Learn how to provision a self-hosted gateway in Azure API Management. - Last updated 03/31/2020 |
| api-management | Api Management Howto Use Managed Service Identity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-howto-use-managed-service-identity.md | Title: Use managed identities in Azure API Management | Microsoft Docs description: Learn how to create system-assigned and user-assigned identities in API Management by using the Azure portal, PowerShell, and a Resource Manager template. Learn about supported scenarios with managed identities. |
| api-management | Api Management In Workspace | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-in-workspace.md | |
| api-management | Api Management Key Concepts Experiment | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-key-concepts-experiment.md | Title: Azure API Management - Overview and key concepts | Microsoft Docs description: Introduction to key scenarios, capabilities, and concepts of the Azure API Management service. API Management supports the full API lifecycle. |
| api-management | Api Management Key Concepts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-key-concepts.md | Title: Azure API Management - Overview and key concepts description: Introduction to key scenarios, capabilities, and concepts of the Azure API Management service. API Management supports the full API lifecycle. |
| api-management | Api Management Kubernetes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-kubernetes.md | Title: Use Azure API Management with Microservices Deployed in Azure Kubernetes Service | Microsoft Docs description: This article describes the options of deploying API Management with AKS Last updated 12/14/2019 |
| api-management | Api Management Log To Eventhub Sample | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-log-to-eventhub-sample.md | Title: Monitor APIs with Azure API Management, Event Hubs, and Moesif description: Sample application demonstrating the log-to-eventhub policy by connecting Azure API Management, Azure Event Hubs and Moesif for HTTP logging and monitoring - ms.assetid: c528cf6f-5f16-4a06-beea-fa1207541a47 ms.devlang: csharp |
| api-management | Api Management Policy Expressions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-policy-expressions.md | Title: Azure API Management policy expressions | Microsoft Docs description: Learn about policy expressions in Azure API Management. See examples and view other available resources. |
| api-management | Api Management Revisions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-revisions.md | Title: Revisions in Azure API Management | Microsoft Docs description: Learn about the concept of revisions in Azure API Management. |
| api-management | Api Management Role Based Access Control | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-role-based-access-control.md | Title: How to use Role-Based Access Control in Azure API Management | Microsoft Docs description: Learn how to use the built-in roles and create custom roles in Azure API Management |
| api-management | Api Management Sample Cache By Key | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-sample-cache-by-key.md | Title: Custom caching in Azure API Management description: Learn how to cache items by key in Azure API Management. You can modify the key by using request headers. Last updated 05/19/2022 |
| api-management | Api Management Sample Flexible Throttling | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-sample-flexible-throttling.md | Title: Advanced request throttling with Azure API Management description: Learn how to create and apply flexible quota and rate limiting policies with Azure API Management. - ms.assetid: fc813a65-7793-4c17-8bb9-e387838193ae - Last updated 02/03/2018 |
| api-management | Api Management Sample Send Request | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-sample-send-request.md | Title: Using API Management service to generate HTTP requests description: Learn to use request and response policies in API Management to call external services from your API - ms.assetid: 4539c0fa-21ef-4b1c-a1d4-d89a38c242fa - Last updated 04/14/2022 |
| api-management | Api Management Subscriptions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-subscriptions.md | Title: Subscriptions in Azure API Management | Microsoft Docs description: Learn about the concept of subscriptions in Azure API Management. Consumers commonly get access to APIs by using subscriptions in Azure API Management. |
| api-management | Api Management Terminology | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-terminology.md | Title: Azure API Management terminology | Microsoft Docs description: This article gives definitions for the terms that are specific to API Management. - |
| api-management | Api Management Troubleshoot Cannot Add Custom Domain | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-troubleshoot-cannot-add-custom-domain.md | Title: Cannot add custom domain by using Key Vault certificate description: Learn how to troubleshoot the issue in which you can't add a custom domain in Azure API Management by using a key vault certificate. - Last updated 07/19/2019 |
| api-management | Api Management Versions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/api-management-versions.md | Title: Versions in Azure API Management | Microsoft Docs description: Learn about the concept of versions in Azure API Management. |
| api-management | Automation Manage Api Management | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/automation-manage-api-management.md | Title: Manage Azure API Management using Azure Automation description: Learn about how the Azure Automation service can be used to manage Azure API Management. - ms.assetid: 2e53c9af-f738-47f8-b1b6-593050a7c51b Last updated 02/13/2018 |
| api-management | Backends | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/backends.md | Title: Azure API Management backends | Microsoft Docs description: Learn about custom backends in Azure API Management - Last updated 01/09/2024 resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-previ description: 'Load balancer for multiple backends' type: 'Pool' protocol: 'http'- url: 'http://unused' + url: 'http://google.com' pool: { { Include a JSON snippet similar to the following in your ARM template for a backe "description": "Load balancer for multiple backends", "type": "Pool", "protocol": "http",- "url": "http://unused", + "url": "http://google.com", "pool": { "services": [ { |
| api-management | Api Version Retirement Sep 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/api-version-retirement-sep-2023.md | Title: Azure API Management - API version retirements (September 2023) | Microsoft Docs description: The Azure API Management service is retiring all API versions prior to 2021-08-01. If you use one of these API versions, you must update your tools, scripts, or programs to use the latest versions. |
| api-management | Captcha Endpoint Change Sep 2025 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/captcha-endpoint-change-sep-2025.md | Title: Azure API Management CAPTCHA endpoint change (September 2025) | Microsoft Docs description: Azure API Management is updating the CAPTCHA endpoint. If your service is hosted in an Azure virtual network, you may need to update network settings to continue using the developer portal. |
| api-management | Identity Provider Adal Retirement Sep 2025 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/identity-provider-adal-retirement-sep-2025.md | Title: Azure API Management identity providers configuration change (September 2025) | Microsoft Docs description: Azure API Management is updating the library used for user authentication in the developer portal. If you use Microsoft Entra ID or Azure AD B2C identity providers, you need to update application settings and identity provider configuration to use the Microsoft Authentication Library (MSAL). |
| api-management | Legacy Portal Retirement Oct 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/legacy-portal-retirement-oct-2023.md | Title: Azure API Management - Legacy developer portal retirement (October 2023) description: Azure API Management is retiring the legacy developer portal effective 31 October 2023. If you use the legacy portal, migrate to the new developer portal. |
| api-management | Metrics Retirement Aug 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/metrics-retirement-aug-2023.md | Title: Azure API Management - Metrics retirement (August 2023) description: Azure API Management is retiring five legacy metrics as of August 2023. If you monitor your API Management instance using these metrics, you must update your monitoring settings and alert rules to use the Requests metric. |
| api-management | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/overview.md | Title: Upcoming Breaking Changes in Azure API Management | Microsoft Docs description: A list of all the upcoming breaking changes for Azure API Management |
| api-management | Rp Source Ip Address Change Mar 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/rp-source-ip-address-change-mar-2023.md | Title: Azure API Management IP address change (March 2023) | Microsoft Docs description: Azure API Management is updating the source IP address of the resource provider in certain regions. If your service is hosted in a Microsoft Azure Virtual Network, you may need to update network settings to continue managing your service. |
| api-management | Rp Source Ip Address Change Sep 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/rp-source-ip-address-change-sep-2023.md | Title: Azure API Management IP address change (September 2023) | Microsoft Docs description: Azure API Management is updating the source IP address of the resource provider in Switzerland North. If your service is hosted in a Microsoft Azure virtual network, you may need to update network settings to continue managing your service. |
| api-management | Self Hosted Gateway V0 V1 Retirement Oct 2023 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/self-hosted-gateway-v0-v1-retirement-oct-2023.md | Title: Azure API Management - Self-hosted gateway v0/v1 retirement (October 2023) | Microsoft Docs description: Azure API Management is retiring the v0 and v1 versions of the self-hosted gateway container image, effective 1 October 2023. If you've deployed one of these versions, you must migrate to the v2 version of the self-hosted gateway. |
| api-management | Stv1 Platform Retirement August 2024 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/breaking-changes/stv1-platform-retirement-august-2024.md | Title: Azure API Management - stv1 platform retirement (August 2024) | Microsoft Docs description: Azure API Management will retire the stv1 compute platform effective 31 August 2024. Instances hosted on the stv1 platform must be migrated to the stv2 platform. |
| api-management | Configure Custom Domain | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/configure-custom-domain.md | Title: Configure custom domain name for Azure API Management instance description: How to configure a custom domain name and choose certificates for the endpoints of your Azure API Management instance. |
| api-management | Credentials Process Flow | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/credentials-process-flow.md | |
| api-management | Edit Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/edit-api.md | Title: Edit an API with the Azure portal | Microsoft Docs description: Learn how to use API Management to edit an API. Add, delete, or rename operations in the APIM instance, or edit the API's swagger. - Last updated 01/19/2022 |
| api-management | How To Configure Cloud Metrics Logs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/how-to-configure-cloud-metrics-logs.md | Title: Configure cloud metrics and logs for Azure API Management self-hosted gateway | Microsoft Docs description: Learn how to configure cloud metrics and logs for Azure API Management self-hosted gateway - Last updated 04/30/2020 |
| api-management | How To Configure Local Metrics Logs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/how-to-configure-local-metrics-logs.md | Title: Configure local metrics and logs for Azure API Management self-hosted gateway | Microsoft Docs description: Learn how to configure local metrics and logs for Azure API Management self-hosted gateway on a Kubernetes cluster - Last updated 05/11/2021 |
| api-management | Howto Protect Backend Frontend Azure Ad B2c | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/howto-protect-backend-frontend-azure-ad-b2c.md | Title: Protect APIs in Azure API Management with Active Directory B2C description: Protect a serverless API with OAuth 2.0 by using Azure Active Directory B2C, Azure API Management, and Easy Auth to be called from a JavaScript SPA using the PKCE enabled SPA Auth Flow. - Last updated 02/18/2021 |
| api-management | Import Api From Odata | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/import-api-from-odata.md | |
| api-management | Import App Service As Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/import-app-service-as-api.md | Title: Import Azure Web App to Azure API Management | Microsoft Docs description: This article shows you how to use Azure API Management to import a web API hosted in Azure App Service. |
| api-management | Import Container App With Oas | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/import-container-app-with-oas.md | Title: Import Azure Container App to Azure API Management | Microsoft Docs description: This article shows you how to use Azure API Management to import a web API hosted in Azure Container Apps. |
| api-management | Import Function App As Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/import-function-app-as-api.md | Title: Import an Azure Function App as an API in API Management description: This article shows you how to import an Azure Function App into Azure API Management as an API. - Last updated 04/16/2021 |
| api-management | Import Logic App As Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/import-logic-app-as-api.md | Title: Import a Logic App as an API with the Azure portal | Microsoft Docs description: This article shows you how to use API Management to import a Logic App (Consumption) resource as an API. - Last updated 04/16/2021 |
| api-management | Observability | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/observability.md | Title: Observability in Azure API Management | Microsoft Docs description: Overview of all API observability and monitoring options in Azure API Management. Last updated 06/01/2020 |
| api-management | Policy Fragments | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/policy-fragments.md | Title: Reuse policy configurations in Azure API Management | Microsoft Docs description: Learn how to create and manage reusable policy fragments in Azure API Management. Policy fragments are XML elements containing policy configurations that can be included in any policy definition. |
| api-management | Sap Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/sap-api.md | |
| api-management | Self Hosted Gateway Migration Guide | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/self-hosted-gateway-migration-guide.md | Title: Self-hosted gateway migration guide - Azure API Management description: Learn how to migrate the Azure API Management self-hosted gateway to v2. |
| api-management | Self Hosted Gateway Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/self-hosted-gateway-overview.md | Title: Self-hosted gateway overview | Azure API Management description: Learn how self-hosted gateway feature of Azure API Management helps organizations manage APIs in hybrid and multicloud environments. |
| api-management | Set Edit Policies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/set-edit-policies.md | Title: How to set or edit Azure API Management policies | Microsoft Docs description: Configure policies at different scopes in an Azure API Management instance using the policy editor in the Azure portal. |
| api-management | V2 Service Tiers Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/v2-service-tiers-overview.md | Title: Azure API Management - v2 tiers (preview) description: Introduction to key scenarios, capabilities, and concepts of the v2 tiers (SKUs) of the Azure API Management service. The v2 tiers are in preview. |
| api-management | Validate Azure Ad Token Policy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/validate-azure-ad-token-policy.md | Title: Azure API Management policy reference - validate-azure-ad-token | Microsoft Docs description: Reference for the validate-azure-ad-token policy available for use in Azure API Management. Provides policy usage, settings, and examples. |
| api-management | Validate Jwt Policy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/validate-jwt-policy.md | Title: Azure API Management policy reference - validate-jwt | Microsoft Docs description: Reference for the validate-jwt policy available for use in Azure API Management. Provides policy usage, settings, and examples. |
| api-management | Virtual Network Concepts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/virtual-network-concepts.md | |
| api-management | Visualize Using Managed Grafana Dashboard | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/visualize-using-managed-grafana-dashboard.md | |
| api-management | Workspaces Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/api-management/workspaces-overview.md | Title: Workspaces in Azure API Management | Microsoft Docs description: Learn about workspaces (preview) in Azure API Management. Workspaces allow decentralized API development teams to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. |
| app-service | Overview App Gateway Integration | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/app-service/overview-app-gateway-integration.md | Title: Application Gateway integration - Azure App Service | Microsoft Learn description: Learn how Application Gateway integrates with Azure App Service. - ms.assetid: 073eb49c-efa1-4760-9f0c-1fecd5c251cc Last updated 09/29/2023 |
| application-gateway | Create Gateway Internal Load Balancer App Service Environment | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/application-gateway/create-gateway-internal-load-balancer-app-service-environment.md | Title: Troubleshoot an Application Gateway in Azure ΓÇô ILB ASE | Microsoft Docs description: Learn how to troubleshoot an application gateway by using an Internal Load Balancer with an App Service Environment in Azure -tags: '' - Last updated 06/10/2022 |
| azure-app-configuration | Concept Geo Replication | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/concept-geo-replication.md | description: Details of the geo-replication feature in Azure App Configuration. - Last updated 08/01/2022 |
| azure-app-configuration | Enable Dynamic Configuration Azure Functions Csharp | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/enable-dynamic-configuration-azure-functions-csharp.md | Title: Tutorial for using Azure App Configuration dynamic configuration in an Azure Functions app description: In this tutorial, you learn how to dynamically update the configuration data for Azure Functions apps - - ms.devlang: csharp Last updated 09/14/2022 |
| azure-app-configuration | Enable Dynamic Configuration Dotnet Core Push Refresh | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/enable-dynamic-configuration-dotnet-core-push-refresh.md | Title: "Tutorial: Use dynamic configuration using push refresh in a .NET Core ap description: In this tutorial, you learn how to dynamically update the configuration data for .NET Core apps using push refresh - - ms.devlang: csharp |
| azure-app-configuration | Enable Dynamic Configuration Dotnet Core | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/enable-dynamic-configuration-dotnet-core.md | Title: "Tutorial: Use dynamic configuration in a .NET app" description: In this tutorial, you learn how to dynamically update the configuration data for .NET apps - - ms.devlang: csharp |
| azure-app-configuration | Enable Dynamic Configuration Java Spring Push Refresh | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/enable-dynamic-configuration-java-spring-push-refresh.md | Title: "Tutorial: Use dynamic configuration using push refresh in a single insta description: In this tutorial, you learn how to dynamically update the configuration data for a Java Spring app using push refresh - - ms.devlang: java |
| azure-app-configuration | Howto App Configuration Event | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/howto-app-configuration-event.md | Title: Use Event Grid for App Configuration data change notifications description: Learn how to use Azure App Configuration event subscriptions to send key-value modification events to a web endpoint ms.devlang: csharp |
| azure-app-configuration | Howto Best Practices | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/howto-best-practices.md | Title: Azure App Configuration best practices | Microsoft Docs description: Learn best practices while using Azure App Configuration. Topics covered include key groupings, key-value compositions, App Configuration bootstrap, and more. - Last updated 12/21/2023 |
| azure-app-configuration | Howto Leverage Json Content Type | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/howto-leverage-json-content-type.md | |
| azure-app-configuration | Manage Feature Flags | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/manage-feature-flags.md | Title: "Tutorial: Use Azure App Configuration to manage feature flags" description: In this tutorial, you learn how to manage feature flags separately from your application by using Azure App Configuration. |
| azure-app-configuration | Quickstart Dotnet App | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/quickstart-dotnet-app.md | Title: Quickstart for Azure App Configuration with .NET Framework | Microsoft Docs description: In this article, create a .NET Framework app with Azure App Configuration to centralize storage and management of application settings separate from your code. ms.devlang: csharp |
| azure-app-configuration | Quickstart Feature Flag Dotnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/quickstart-feature-flag-dotnet.md | Title: Quickstart for adding feature flags to .NET Framework apps | Microsoft Docs | Microsoft Docs description: A quickstart for adding feature flags to .NET Framework apps and managing them in Azure App Configuration ms.devlang: csharp .NET- Last updated 3/20/2023 #Customer intent: As a .NET Framework developer, I want to use feature flags to control feature availability quickly and confidently. |
| azure-app-configuration | Reload Key Vault Secrets Dotnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/reload-key-vault-secrets-dotnet.md | |
| azure-app-configuration | Use Feature Flags Dotnet Core | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/use-feature-flags-dotnet-core.md | Title: Tutorial for using feature flags in a .NET app | Microsoft Docs description: In this tutorial, you learn how to implement feature flags in .NET Core apps. - - ms.devlang: csharp Last updated 07/11/2023 |
| azure-app-configuration | Use Feature Flags Spring Boot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/use-feature-flags-spring-boot.md | Title: Tutorial for using feature flags in a Spring Boot app - Azure App Configuration | Microsoft Docs description: In this tutorial, you learn how to implement feature flags in Spring Boot apps. - - ms.devlang: java Last updated 09/27/2023 |
| azure-app-configuration | Use Key Vault References Dotnet Core | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/use-key-vault-references-dotnet-core.md | Title: Tutorial for using Azure App Configuration Key Vault references in an ASP.NET Core app | Microsoft Docs description: In this tutorial, you learn how to use Azure App Configuration's Key Vault references from an ASP.NET Core app - ms.devlang: csharp Last updated 07/11/2023 |
| azure-app-configuration | Use Key Vault References Spring Boot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-app-configuration/use-key-vault-references-spring-boot.md | Title: Tutorial for using Azure App Configuration Key Vault references in a Java Spring Boot app | Microsoft Docs description: In this tutorial, you learn how to use Azure App Configuration's Key Vault references from a Java Spring Boot app - - ms.devlang: java Last updated 05/02/2022 |
| azure-arc | Agent Release Notes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/agent-release-notes.md | Download for [Windows](https://download.microsoft.com/download/f/6/4/f64c574f-d3 - Agent installation and upgrades apply more restrictive permissions to the agent's data directories on Windows - Improved reliability when detecting Azure Stack HCI as a cloud provider - Removed the log zipping feature introduced in version 1.37 for extension manager and machine configuration agent logs. Log files will still be rotated automatically.+- Removed the scheduled tasks for automatic agent upgrades (introduced in agent version 1.30). We will reintroduce this functionality when the automatic upgrade mechanism is available. - Resolved [Azure Connected Machine Agent Elevation of Privilege Vulnerability](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2023-35624) ## Version 1.36 - November 2023 |
| azure-arc | Deliver Extended Security Updates | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/deliver-extended-security-updates.md | You have 8 Windows Server 2012 R2 Standard instances, each with 8 physical cores > You needed a regular production license to start with, and you'll be billed only for the production cores. You did not and should not provision non-production cores in your license. > +## Upgrading from Windows Server 2012/2012 R2 ++When upgrading a Windows Server 2012/2012R machine to Windows Server 2016 or above, it's not necessary to remove the Connected Machine agent from the machine. The new operating system will be visible for the machine in Azure within a few minutes of upgrade completion. Upgraded machines no longer require ESUs and are no longer eligible for them. Any ESU license associated with the machine is not automatically unlinked from the machine. See [Unlink a license](api-extended-security-updates.md#unlink-a-license) for instructions on doing so manually. <!-- |
| azure-arc | Manage Agent | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/manage-agent.md | Actions of the [zypper](https://en.opensuse.org/Portal:Zypper) command, such as ### Automatic agent upgrades -The Azure Connected Machine agent will support automatic and manual upgrades of the agent, initiated by Azure, in an upcoming release. To facilitate this capability, the agent enables a scheduled task on Windows or cron job on Linux that runs daily to see if the agent should be upgraded. The scheduler job will be installed when you install agent versions 1.30 or higher. While the scheduler job is currently enabled, the complete automatic upgrade experience is not yet available, so no changes will be made to your system even if a newer version of the Azure Connected Machine agent is available. --To view these scheduler jobs in Windows through PowerShell, run the following command: --```powershell -schtasks /query /TN azcmagent -``` --To view these scheduler jobs in Windows through Task Scheduler: ---To view these scheduler jobs in Linux, run the following command: --``` -cat /etc/cron.d/azcmagent_autoupgrade -``` --To opt-out of any future automatic upgrades or the scheduler jobs, execute the following Azure CLI commands: --For Windows: --```powershell -az rest --method patch --url https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.HybridCompute/machines/<machineName>?api-version=2022-12-27-preview --resource https://management.azure.com/ --headers Content-Type=application/json --body '{\"properties\": {\"agentUpgrade\": {\"enableAutomaticUpgrade\": false}}}' -``` --For Linux: --```bash -az rest --method patch --url https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.HybridCompute/machines/<machineName>?api-version=2022-12-27-preview --resource https://management.azure.com/ --headers Content-Type=application/json --body '{"properties": {"agentUpgrade": {"enableAutomaticUpgrade": false}}}' -``` +The Azure Connected Machine agent doesn't automatically upgrade itself when a new version is released. You should include the latest version of the agent with your scheduled patch cycles. ## Renaming an Azure Arc-enabled server resource |
| azure-arc | Plan Evaluate On Azure Virtual Machine | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/plan-evaluate-on-azure-virtual-machine.md | When Azure Arc-enabled servers is configured on the VM, you see two representati If your Azure VM is running CentOS, Red Hat, or SUSE Linux Enterprise Server (SLES), perform the following steps to configure firewalld: ```bash- sudo firewall-cmd --permanent --direct --add-rule ipv4 filter OUTPUT 1 -p tcp -d 169.254.169.254 -j DROP + sudo firewall-cmd --permanent --direct --add-rule ipv4 filter OUTPUT 1 -p tcp -d 169.254.169.254 -j REJECT sudo firewall-cmd --reload ``` For other distributions, consult your firewall docs or configure a generic iptables rule with the following command: ```bash- sudo iptables -A OUTPUT -d 169.254.169.254 -j DROP + sudo iptables -A OUTPUT -d 169.254.169.254 -j REJECT ``` > [!NOTE] |
| azure-arc | Run Command | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/run-command.md | Run Command on Azure Arc-enabled servers supports the following operations: ## Example scenarios -Suppose you have an Azure Arc-enabled server called ΓÇ£2012DatacenterServer1ΓÇ¥ in resource group ΓÇ£ContosoRGΓÇ¥ with Subscription ID ΓÇ£aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaaΓÇ¥. Consider a scenario where you need to provide remote access to an endpoint for Windows Server 2012 / R2 servers. Access to Extended Security Updates enabled by Azure Arc requires access to the endpoint `microsoft.com/pkiops/certs`. You need to remotely configure a firewall rule that allows access to this endpoint. Use Run Command in order to allow connectivity to this endpoint. +Suppose you have an Azure Arc-enabled server called ΓÇ£2012DatacenterServer1ΓÇ¥ in resource group ΓÇ£ContosoRGΓÇ¥ with Subscription ID ΓÇ£aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaaΓÇ¥. Consider a scenario where you need to provide remote access to an endpoint for Windows Server 2012 / R2 servers. Access to Extended Security Updates enabled by Azure Arc requires access to the endpoint `www.microsoft.com/pkiops/certs`. You need to remotely configure a firewall rule that allows access to this endpoint. Use Run Command in order to allow connectivity to this endpoint. ### Example 1: Endpoint access with Run Command -Start off by creating a Run Command script to provide endpoint access to the `microsoft.com/pkiops/certs` endpoint on your target Arc-enabled server using the PUT operation. +Start off by creating a Run Command script to provide endpoint access to the `www.microsoft.com/pkiops/certs` endpoint on your target Arc-enabled server using the PUT operation. To directly provide the script in line, use the following operation: PUT https://management.azure.com/subscriptions/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaa "parameters": [ { "name": "ruleName",- "value": " Allow access to microsoft.com/pkiops/certs" + "value": " Allow access to www.microsoft.com/pkiops/certs" }, { "name": "endpoint",- "value": ""microsoft.com/pkiops/certs" + "value": "www.microsoft.com/pkiops/certs" }, { "name": "port", PUT https://management.azure.com/subscriptions/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaa "parameters": [ { "name": "ruleName",- "value": " Allow access to microsoft.com/pkiops/certs" + "value": " Allow access to www.microsoft.com/pkiops/certs" }, { "name": "endpoint",- "value": ""microsoft.com/pkiops/certs" + "value": "www.microsoft.com/pkiops/certs" }, { "name": "port", |
| azure-arc | Troubleshoot Extended Security Updates | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/servers/troubleshoot-extended-security-updates.md | Title: How to troubleshoot delivery of Extended Security Updates for Windows Server 2012 through Azure Arc description: Learn how to troubleshoot delivery of Extended Security Updates for Windows Server 2012 through Azure Arc. Previously updated : 01/02/2024 Last updated : 01/19/2024 If you're unable to enable this service offering, review the resource providers - **Microsoft.GuestConfiguration:** Enables Guest Configuration policies, which are used to assess and enforce configurations on your Arc-enabled servers for compliance and security. -- **Microsoft.UpdateManagement:** This resource provider is required for Azure Update Management, which is used to manage updates and patches on your on-premises servers, including ESU updates.+- **Microsoft.Compute:** This resource provider is required for Azure Update Management, which is used to manage updates and patches on your on-premises servers, including ESU updates. - **Microsoft.Security:** Enabling this resource provider is crucial for implementing security-related features and configurations for both Azure Arc and on-premises servers. If you're unable to enable this service offering, review the resource providers Ensure that both the licensing package and servicing stack update (SSU) are downloaded for the Azure Arc-enabled server as documented at [KB5031043: Procedure to continue receiving security updates after extended support has ended on October 10, 2023](https://support.microsoft.com/topic/kb5031043-procedure-to-continue-receiving-security-updates-after-extended-support-has-ended-on-october-10-2023-c1a20132-e34c-402d-96ca-1e785ed51d45). Ensure you are following all of the networking prerequisites as recorded at [Prepare to deliver Extended Security Updates for Windows Server 2012](prepare-extended-security-updates.md?tabs=azure-cloud#networking). --### Error: Trying to check IMDS again (HRESULT 12002) +### Error: Trying to check IMDS again (HRESULT 12002 or 12029) If installing the Extended Security Update enabled by Azure Arc fails with errors such as "ESU: Trying to Check IMDS Again LastError=HRESULT_FROM_WIN32(12029)" or "ESU: Trying to Check IMDS Again LastError=HRESULT_FROM_WIN32(12002)", you may need to update the intermediate certificate authorities trusted by your computer using one of the following two methods: -1. Configure your network firewall and/or proxy server to allow access from the Windows Server 2012 (R2) machines to `https://microsoft.com/pkiops/certs`. This will allow the machine to automatically retrieve updated intermediate certificates as required and is Microsoft's preferred approach. -1. Download all intermediate CAs from a machine with internet access, copy them to each Windows Server 2012 (R2) machine, and import them to the machine's intermediate certificate authority store: - 1. Download the 4 intermediate CA certificates: - 1. [Microsoft Azure TLS Issuing CA 01](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2001%20-%20xsign.crt) - 1. [Microsoft Azure TLS Issuing CA 02](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2002%20-%20xsign.crt) - 1. [Microsoft Azure TLS Issuing CA 05](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2005%20-%20xsign.crt) - 1. [Microsoft Azure TLS Issuing CA 06](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2006%20-%20xsign.crt) - 1. Copy the certificate files to your Windows Server 2012 (R2) machine. - 1. Run the following commands in an elevated command prompt or PowerShell session to add the certificates to the "Intermediate Certificate Authorities" store for the local computer. The command should be run from the same directory as the certificate files. The commands are idempotent and won't make any changes if you've already imported the certificate: -- ```powershell - certstore -addstore CA "Microsoft Azure TLS Issuing CA 01 - xsign.crt" - certstore -addstore CA "Microsoft Azure TLS Issuing CA 02 - xsign.crt" - certstore -addstore CA "Microsoft Azure TLS Issuing CA 05 - xsign.crt" - certstore -addstore CA "Microsoft Azure TLS Issuing CA 06 - xsign.crt" - ``` --After allowing the servers to reach the PKI URL or manually importing the intermediate certificates, try installing the Extended Security Updates again using Windows Update or your preferred patch management software. You may need to reboot your computer for the changes to take effect. +#### Option 1: Allow access to the PKI URL ++Configure your network firewall and/or proxy server to allow access from the Windows Server 2012 (R2) machines to `http://www.microsoft.com/pkiops/certs` and `https://www.microsoft.com/pkiops/certs` (both TCP 80 and 443). This will enable the machines to automatically retrieve any missing intermediate CA certificates from Microsoft. ++Once the network changes are made to allow access to the PKI URL, try installing the Windows updates again. You may need to reboot your computer for the automatic installation of certificates and validation of the license to take effect. ++#### Option 2: Manually download and install the intermediate CA certificates ++If you're unable to allow access to the PKI URL from your servers, you can manually download and install the certificates on each machine. ++1. On any computer with internet access, download these intermediate CA certificates: + 1. [Microsoft Azure TLS Issuing CA 01](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2001%20-%20xsign.crt) + 1. [Microsoft Azure TLS Issuing CA 02](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2002%20-%20xsign.crt) + 1. [Microsoft Azure TLS Issuing CA 05](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2005%20-%20xsign.crt) + 1. [Microsoft Azure TLS Issuing CA 06](https://www.microsoft.com/pkiops/certs/Microsoft%20Azure%20TLS%20Issuing%20CA%2006%20-%20xsign.crt) +1. Copy the certificate files to your Windows Server 2012 (R2) machines. +1. Run any one set of the following commands in an elevated command prompt or PowerShell session to add the certificates to the "Intermediate Certificate Authorities" store for the local computer. The command should be run from the same directory as the certificate files. The commands are idempotent and won't make any changes if you've already imported the certificate: ++ ``` + certutil -addstore CA "Microsoft Azure TLS Issuing CA 01 - xsign.crt" + certutil -addstore CA "Microsoft Azure TLS Issuing CA 02 - xsign.crt" + certutil -addstore CA "Microsoft Azure TLS Issuing CA 05 - xsign.crt" + certutil -addstore CA "Microsoft Azure TLS Issuing CA 06 - xsign.crt" + ``` ++1. Try installing the Windows updates again. You may need to reboot your computer for the validation logic to recognize the newly imported intermediate CA certificates. ### Error: Not eligible (HRESULT 1633) If you encounter the error "ESU: not eligible HRESULT_FROM_WIN32(1633)", follow these steps: -`Remove-Item ΓÇ£$env:ProgramData\AzureConnectedMachineAgent\Certs\license.jsonΓÇ¥ -Force` --`Restart-Service himds` +```powershell +Remove-Item "$env:ProgramData\AzureConnectedMachineAgent\Certs\license.json" -Force +Restart-Service himds +``` If you have other issues receiving ESUs after successfully enrolling the server through Arc-enabled servers, or you need additional information related to issues affecting ESU deployment, see [Troubleshoot issues in ESU](/troubleshoot/windows-client/windows-7-eos-faq/troubleshoot-extended-security-updates-issues). |
| azure-arc | Enable Virtual Hardware Scvmm | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/system-center-virtual-machine-manager/enable-virtual-hardware-scvmm.md | |
| azure-arc | Enable Virtual Hardware | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-arc/vmware-vsphere/enable-virtual-hardware.md | |
| azure-functions | Configure Networking How To | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/configure-networking-how-to.md | To secure the storage for an existing function app: | Setting name | Value | Comment | |-|-|-| | `AzureWebJobsStorage`| Storage connection string | This is the connection string for a secured storage account. |- | `WEBSITE_CONTENTAZUREFILECONNECTIONSTRING` | Storage connection string | This is the connection string for a secured storage account. This setting is required for Consumption and Premium plan apps on both Windows and Linux. It's not required for Dedicated plan apps, which aren't dynamically scaled by Functions. | - | `WEBSITE_CONTENTSHARE` | File share | The name of the file share created in the secured storage account where the project deployment files reside. This setting is required for Consumption and Premium plan apps on both Windows and Linux. It's not required for Dedicated plan apps, which aren't dynamically scaled by Functions. | + | `WEBSITE_CONTENTAZUREFILECONNECTIONSTRING` | Storage connection string | This is the connection string for a secured storage account. This setting is required for Consumption and Elastic Premium plan apps on both Windows and Linux. It's not required for Dedicated plan apps, which aren't dynamically scaled by Functions. | + | `WEBSITE_CONTENTSHARE` | File share | The name of the file share created in the secured storage account where the project deployment files reside. This setting is required for Consumption and Elastic Premium plan apps on both Windows and Linux. It's not required for Dedicated plan apps, which aren't dynamically scaled by Functions. | | `WEBSITE_CONTENTOVERVNET` | 1 | A value of 1 enables your function app to scale when you have your storage account restricted to a virtual network. You should enable this setting when restricting your storage account to a virtual network. | 1. Select **Save** to save the application settings. Changing app settings causes the app to restart. |
| azure-functions | Quickstart Python Vscode | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/durable/quickstart-python-vscode.md | def hello_orchestrator(context): # Activity @myApp.activity_trigger(input_name="city") def hello(city: str):- return "Hello " + city + return f"Hello {city}" ``` Review the table below for an explanation of each function and its purpose in the sample. |
| azure-functions | Functions App Settings | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/functions-app-settings.md | Azure Files doesn't support using managed identity when accessing the file share ## WEBSITE\_CONTENTOVERVNET -A value of `1` enables your function app to scale when you have your storage account restricted to a virtual network. You should enable this setting when restricting your storage account to a virtual network. To learn more, see [Restrict your storage account to a virtual network](configure-networking-how-to.md#restrict-your-storage-account-to-a-virtual-network). +A value of `1` enables your function app to scale when you have your storage account restricted to a virtual network. You should enable this setting when restricting your storage account to a virtual network. Only required when using `WEBSITE_CONTENTAZUREFILECONNECTIONSTRING`. To learn more, see [Restrict your storage account to a virtual network](configure-networking-how-to.md#restrict-your-storage-account-to-a-virtual-network). |Key|Sample value| ||| |
| azure-functions | Functions Bindings Rabbitmq Output | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/functions-bindings-rabbitmq-output.md | Title: RabbitMQ output bindings for Azure Functions description: Learn to send RabbitMQ messages from Azure Functions. Last updated 01/21/2022 |
| azure-functions | Functions Bindings Rabbitmq Trigger | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/functions-bindings-rabbitmq-trigger.md | Title: RabbitMQ trigger for Azure Functions description: Learn how to run an Azure Function when a RabbitMQ message is created. Last updated 01/21/2022 |
| azure-functions | Functions Bindings Rabbitmq | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/functions-bindings-rabbitmq.md | Title: Azure RabbitMQ bindings for Azure Functions description: Learn to send Azure RabbitMQ triggers and bindings in Azure Functions. Last updated 11/15/2021 |
| azure-functions | Functions Recover Storage Account | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/functions-recover-storage-account.md | In the preceding step, if you can't find a storage account connection string, it * Required: * [`AzureWebJobsStorage`](./functions-app-settings.md#azurewebjobsstorage)-* Required for Premium plan functions: +* Required for Elastic Premium and Consumption plan functions: * [`WEBSITE_CONTENTAZUREFILECONNECTIONSTRING`](./functions-app-settings.md) * [`WEBSITE_CONTENTSHARE`](./functions-app-settings.md) |
| azure-functions | Migrate Dotnet To Isolated Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-functions/migrate-dotnet-to-isolated-model.md | var host = new HostBuilder() host.Run(); ``` +This examples supports [ASP.NET Core integration] to use normal .NET 8 types. To use the built-in Functions HTTP types instead, replace the call to `ConfigureFunctionsWebApplication` with a call to `ConfigureFunctionsWorkerDefaults`. + # [.NET Framework 4.8](#tab/netframework48) ```csharp |
| azure-functions | Migrate Dotnet To Isolated Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-glossary-cloud-terminology.md | Title: Azure glossary - Azure dictionary description: Use the Azure glossary to understand cloud terminology on the Azure platform. This short Azure dictionary provides definitions for common cloud terms for Azure. keywords: Azure dictionary, cloud terminology, Azure glossary, terminology definitions, cloud terms - ms.assetid: d7ac12f7-24b5-4bcd-9e4d-3d76fbd8d297 |
| azure-government | Documentation Accelerate Compliance | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/compliance/documentation-accelerate-compliance.md | description: Provides an overview of resources for Development, Automation, and cloud: gov Last updated 05/30/2023 |
| azure-government | Documentation Government Cognitiveservices | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-cognitiveservices.md | Title: Azure AI services on Azure Government description: Guidance for developing Azure AI services applications for Azure Government cloud: gov Last updated 08/30/2021 |
| azure-government | Documentation Government Connect Vs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-connect-vs.md | Title: Connect to Azure Government with Visual Studio description: This quickstart shows how to connect to Azure Government with Visual Studio cloud: gov Last updated 03/09/2021 |
| azure-government | Documentation Government Csp Application | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-csp-application.md | description: Provides an overview of the process to become an Azure Government C cloud: gov Last updated 05/30/2023 |
| azure-government | Documentation Government Extension | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-extension.md | cloud: gov Last updated 08/31/2021 |
| azure-government | Documentation Government Get Started Connect With Cli | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-get-started-connect-with-cli.md | Title: Connect to Azure Government with Azure CLI description: This quickstart shows you how to connect to Azure Government and create a web app in Azure Government with Azure CLI cloud: gov Last updated 03/09/2021 |
| azure-government | Documentation Government How To Access Enterprise Agreement Billing Account | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-how-to-access-enterprise-agreement-billing-account.md | Title: Access your EA billing account in the Azure Government portal | Microsoft description: This article describes how to Access your EA billing account in the Azure Government portal. cloud: gov Last updated 11/08/2023 |
| azure-government | Documentation Government Howto Deploy Webandmobile | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-howto-deploy-webandmobile.md | Title: Deploy an Azure App Services app| Microsoft Docs description: This tutorial describes how to deploy a Web App, API App, or Mobile App to Azure Government using Visual Studio and Azure SDK. cloud: gov Last updated 08/10/2018 |
| azure-government | Documentation Government Image Gallery | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-image-gallery.md | cloud: gov Last updated 08/31/2021 |
| azure-government | Documentation Government Manage Marketplace Partners | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-manage-marketplace-partners.md | Title: Publishing to Azure Government Marketplace description: This article provides guidance on publishing solutions to Azure Government Marketplace. cloud: gov Last updated 08/31/2021 |
| azure-government | Documentation Government Manage Oms | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-manage-oms.md | Title: Azure Government Azure Monitor logs | Microsoft Docs description: This article describes how Azure Monitor logs is applicable to US Government agencies and solution providers cloud: gov Last updated 12/05/2016 |
| azure-government | Documentation Government Quickstarts Vm | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-government/documentation-government-quickstarts-vm.md | Title: Create Virtual Machines in Azure Government | Microsoft Docs description: This tutorial shows steps for creating Virtual Machines with Azure Government cloud: gov Last updated 08/10/2018 |
| azure-maps | Migrate From Bing Maps Web Services | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/migrate-from-bing-maps-web-services.md | Last updated 10/28/2021 - # Tutorial: Migrate web service from Bing Maps |
| azure-maps | Migrate From Bing Maps | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/migrate-from-bing-maps.md | Last updated 12/1/2021 - # Tutorial: Migrate from Bing Maps to Azure Maps |
| azure-maps | Migrate From Google Maps Web Services | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/migrate-from-google-maps-web-services.md | Last updated 09/28/2023 - # Tutorial: Migrate web service from Google Maps |
| azure-maps | Migrate From Google Maps | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/migrate-from-google-maps.md | Last updated 09/23/2020 - # Tutorial: Migrate from Google Maps to Azure Maps |
| azure-maps | Open Source Projects | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/open-source-projects.md | Last updated 12/07/2020 - # Azure Maps community - Open-source projects |
| azure-maps | Traffic Coverage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-maps/traffic-coverage.md | The following tables provide information about what kind of traffic information | Country/Region | Incidents | Flow | ||::|:-:|-| Belarus | Γ£ô | Γ£ô | | Belgium | Γ£ô | Γ£ô | | Bosnia and Herzegovina | Γ£ô | Γ£ô | | Bulgaria | Γ£ô | Γ£ô | The following tables provide information about what kind of traffic information | Poland | Γ£ô | Γ£ô | | Portugal | Γ£ô | Γ£ô | | Romania | Γ£ô | Γ£ô |-| Russian Federation | Γ£ô | Γ£ô | | San Marino | Γ£ô | Γ£ô | | Serbia | Γ£ô | Γ£ô | | Slovakia | Γ£ô | Γ£ô | The following tables provide information about what kind of traffic information | Sweden | Γ£ô | Γ£ô | | Switzerland | Γ£ô | Γ£ô | | T├╝rkiye | Γ£ô | Γ£ô |-| Ukraine | Γ£ô | Γ£ô | | United Kingdom | Γ£ô | Γ£ô | ## Middle East & Africa The following tables provide information about what kind of traffic information |-|::|:-:| | Bahrain | Γ£ô | Γ£ô | | Egypt | Γ£ô | Γ£ô |-| Israel | Γ£ô | Γ£ô | | Kenya | Γ£ô | Γ£ô | | Kuwait | Γ£ô | Γ£ô | | Lesotho | Γ£ô | Γ£ô | |
| azure-monitor | Azure Monitor Agent Extension Versions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/agents/azure-monitor-agent-extension-versions.md | We strongly recommended to always update to the latest version, or opt in to the ## Version details | Release Date | Release notes | Windows | Linux | |:|:|:|:|-| December 2023 |**Windows** <ul><li>Support new settings that control agent disk size</li><li>Prevent CPU spikes by not using bookmark when resetting an Event Log subscription</li><li>Added missing fluentbit exe to AMA client setup for Custom Log support</li><li>Updated to latest AzureCredentialsManagementService and DsmsCredentialsManagement package</li><li>Update ME to v2.2023.1027.1417</li></ul>**Linux**<ul><li>Support for TLS V1.3</li><li>Support for nopri in Syslog</li><li>Ability to set disk quota from DCR Agent Settings</li><li>Add ARM64 Ubuntu 22 support</li><li>**Fixes**<ul><li>SysLog</li><ul><li>Parse syslog Palo Alto CEF with multiple space characters following the hostname</li><li>Fix an issue with incorrectly parsing messages containing two '\n' chars in a row</li><li>Improved support for non-RFC compliant devices</li><li>Support infoblox device messages containing both hostname and IP headers</li></ul><li>Fix AMA crash in RHEL 7.2</li><li>Remove dependency on "which" command</li><li>Fix port conflicts due to AMA using 13000 </li><li>Reliability and Performance improvements</li></ul></li></ul>| 1.22.0 | 1.29.4| +| December 2023 |**Windows** <ul><li>Prevent CPU spikes by not using bookmark when resetting an Event Log subscription</li><li>Added missing fluentbit exe to AMA client setup for Custom Log support</li><li>Updated to latest AzureCredentialsManagementService and DsmsCredentialsManagement package</li><li>Update ME to v2.2023.1027.1417</li></ul>**Linux**<ul><li>Support for TLS V1.3</li><li>Support for nopri in Syslog</li><li>Ability to set disk quota from DCR Agent Settings</li><li>Add ARM64 Ubuntu 22 support</li><li>**Fixes**<ul><li>SysLog</li><ul><li>Parse syslog Palo Alto CEF with multiple space characters following the hostname</li><li>Fix an issue with incorrectly parsing messages containing two '\n' chars in a row</li><li>Improved support for non-RFC compliant devices</li><li>Support infoblox device messages containing both hostname and IP headers</li></ul><li>Fix AMA crash in RHEL 7.2</li><li>Remove dependency on "which" command</li><li>Fix port conflicts due to AMA using 13000 </li><li>Reliability and Performance improvements</li></ul></li></ul>| 1.22.0 | 1.29.4| | October 2023| **Windows** <ul><li>Minimize CPU spikes when resetting an Event Log subscription</li><li>Enable multiple IIS subscriptions to use same filter</li><li>Cleanup files and folders for inactive tenants in multi-tenant mode</li><li>AMA installer will not install unnecessary certs</li><li>AMA emits Telemetry table locally</li><li>Update Metric Extension to v2.2023.721.1630</li><li>Update AzureSecurityPack to v4.29.0.4</li><li>Update AzureWatson to v1.0.99</li></ul>**Linux**<ul><li> Add support for Process metrics counters for Log Analytics upload and Azure Monitor Metrics</li><li>Use rsyslog omfwd TCP for improved syslog reliability</li><li>Support Palo Alto CEF logs where hostname is followed by 2 spaces</li><li>Bug and reliability improvements</li></ul> |1.21.0|1.28.11| | September 2023| **Windows** <ul><li>Fix issue with high CPU usage due to excessive Windows Event Logs subscription reset</li><li>Reduce fluentbit resource usage by limiting tracked files older than 3 days and limiting logging to errors only</li><li>Fix race-condition where resource_id is unavailable when agent is restarted</li><li>Fix race-condition when vm-extension provision agent (aka GuestAgent) is issuing a disable-vm-extension command to AMA.</li><li>Update MetricExtension version to 2.2023.721.1630</li><li>Update Troubleshooter to v1.5.14 </li></ul>|1.20.0| None | | August 2023| **Windows** <ul><li>AMA: Allow prefixes in the tag names to handle regression</li><li>Updating package version for AzSecPack 4.28 release</li></ui>|1.19.0| None | |
| azure-monitor | Data Model Complete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/app/data-model-complete.md | Title: Application Insights telemetry data model description: This article describes the Application Insights telemetry data model including request, dependency, exception, trace, event, metric, PageView, and context. documentationcenter: .net-- ibiza Last updated 09/25/2023 |
| azure-monitor | Opentelemetry Add Modify | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/app/opentelemetry-add-modify.md | Telemetry emitted by Azure SDKS is automatically [collected](https://github.com/ > The Azure Monitor OpenTelemetry Distros include custom mapping and logic to automatically emit [Application Insights standard metrics](standard-metrics.md). > [!TIP]-> The OpenTelemetry-based offerings currently emit all OpenTelemetry metrics as [Custom Metrics](opentelemetry-add-modify.md#add-custom-metrics) and [Performance Counters](standard-metrics.md#performance-counters) in Metrics Explorer. For .NET, Node.js, and Python, whatever you set as the meter name becomes the metrics namespace. +> All OpenTelemetry metrics whether automatically collected from instrumentation libraries or manual collected from custom coding are currently considered Application Insights "custom metrics" for billing purposes. [Learn More](pre-aggregated-metrics-log-metrics.md#custom-metrics-dimensions-and-pre-aggregation). ### Add a community instrumentation library The following table represents the currently supported custom telemetry types: ### Add custom metrics -> [!NOTE] -> Custom Metrics are under preview in Azure Monitor Application Insights. Custom metrics without dimensions are available by default. To view and alert on dimensions, you need to [opt-in](pre-aggregated-metrics-log-metrics.md#custom-metrics-dimensions-and-pre-aggregation). +In this context, custom metrics refers to manually instrumenting your code to collect additional metrics beyond what the OpenTelemetry Instrumentation Libraries automatically collect. The OpenTelemetry API offers six metric "instruments" to cover various metric scenarios and you need to pick the correct "Aggregation Type" when visualizing metrics in Metrics Explorer. This requirement is true when using the OpenTelemetry Metric API to send metrics and when using an instrumentation library. |
| azure-monitor | Pre Aggregated Metrics Log Metrics | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/app/pre-aggregated-metrics-log-metrics.md | There are several [ways of sending custom metrics from the Application Insights ## Custom metrics dimensions and pre-aggregation -All metrics that you send by using [trackMetric](./api-custom-events-metrics.md#trackmetric) or [GetMetric and TrackValue](./api-custom-events-metrics.md#getmetric) API calls are automatically stored in both logs and metrics stores. Although the log-based version of your custom metric always retains all dimensions, the pre-aggregated version of the metric is stored by default with no dimensions. You can turn on collection of dimensions of custom metrics on the [usage and estimated cost](../cost-usage.md#usage-and-estimated-costs) tab by selecting the **Enable alerting on custom metric dimensions** checkbox. +All metrics that you send using [OpenTelemetry](opentelemetry-add-modify.md), [trackMetric](./api-custom-events-metrics.md#trackmetric) or [GetMetric and TrackValue](./api-custom-events-metrics.md#getmetric) API calls are automatically stored in both logs and metrics stores. These metrics can be found in the customMetrics table in Application Insights and in Metrics Explorer under the Custom Metric Namespace called "azure.applicationinsights". Although the log-based version of your custom metric always retains all dimensions, the pre-aggregated version of the metric is stored by default with no dimensions. Retaining dimensions of custom metrics is a Preview feature that can be turned on via the [usage and estimated cost](../cost-usage.md#usage-and-estimated-costs) tab and selecting the **Enable alerting on custom metric dimensions** checkbox. :::image type="content" source="./media/pre-aggregated-metrics-log-metrics/001-cost.png" lightbox="./media/pre-aggregated-metrics-log-metrics/001-cost.png" alt-text="Screenshot that shows usage and estimated costs."::: |
| azure-monitor | Autoscale Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/autoscale/autoscale-overview.md | |
| azure-monitor | Data Platform | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/data-platform.md | Title: Azure Monitor data platform description: Overview of the Azure Monitor data platform and collection of observability data. Last updated 08/09/2023 |
| azure-monitor | Data Platform Metrics | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/essentials/data-platform-metrics.md | Title: Metrics in Azure Monitor | Microsoft Docs description: Learn about metrics in Azure Monitor, which are lightweight monitoring data capable of supporting near real-time scenarios. - Last updated 04/25/2023 |
| azure-monitor | Data Platform Logs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/logs/data-platform-logs.md | Title: Azure Monitor Logs description: Learn the basics of Azure Monitor Logs, which is used for advanced analysis of monitoring data. Last updated 09/14/2023 |
| azure-monitor | Log Analytics Workspace Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/logs/log-analytics-workspace-overview.md | Title: Log Analytics workspace overview description: Overview of Log Analytics workspace, which stores data for Azure Monitor Logs. Last updated 10/24/2023 |
| azure-monitor | Tables Feature Support | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/logs/tables-feature-support.md | description: Reference for tables that support ingestion-time transformations in Last updated 07/10/2022 |
| azure-monitor | Overview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/overview.md | Title: Azure Monitor overview description: Overview of Microsoft services and functionalities that contribute to a complete monitoring strategy for your Azure services and applications. - Last updated 12/07/2023 |
| azure-monitor | Workbook Templates Move Region | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbook-templates-move-region.md | Title: Move and Azure Workbook template to another region description: How to move a workbook template to a different region - ibiza |
| azure-monitor | Workbooks Access Troubleshooting Guide | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-access-troubleshooting-guide.md | Title: Access Troubleshooting Guides in Azure Workbooks description: Learn how to access the deprecated troubleshooting guides in Azure Workbooks. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Automate | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-automate.md | Title: Azure Monitor workbooks and Azure Resource Manager templates description: Simplify complex reporting with prebuilt and custom parameterized Azure Monitor workbooks deployed via Azure Resource Manager templates. - ibiza |
| azure-monitor | Workbooks Bring Your Own Storage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-bring-your-own-storage.md | Title: Azure Monitor workbooks bring your own storage description: Learn how to secure your workbook by saving the workbook content to your storage. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Chart Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-chart-visualizations.md | Title: Azure Monitor workbook chart visualizations description: Learn about all the Azure Monitor workbook chart visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Composite Bar | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-composite-bar.md | Title: Azure Workbooks composite bar renderer description: Learn about all the Azure Workbooks composite bar renderer visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Dropdowns | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-dropdowns.md | Title: Azure Monitor workbook dropdown parameters description: Use dropdown parameters to simplify complex reporting with prebuilt and custom parameterized workbooks. -- ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Graph Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-graph-visualizations.md | Title: Azure Workbooks graph visualizations description: Learn about all the Azure Workbooks graph visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Honey Comb | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-honey-comb.md | Title: Azure Workbooks honeycomb visualizations description: Learn about Azure Workbooks honeycomb visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Jsonpath | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-jsonpath.md | Title: Azure Monitor workbooks - Transform JSON data with JSONPath description: Use JSONPath in Azure Monitor workbooks to transform the JSON data results to a different data format. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Map Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-map-visualizations.md | Title: Azure Workbooks map visualizations description: Learn about Azure Workbooks map visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Move Region | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-move-region.md | Title: Azure Monitor Workbooks - Move Regions description: How to move a workbook to a different region - ibiza |
| azure-monitor | Workbooks Parameters | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-parameters.md | Title: Create workbook parameters description: Learn how to add parameters to your workbook to collect input from the consumers and reference it in other parts of the workbook. -- ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Text Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-text-visualizations.md | Title: Azure Monitor workbook text visualizations description: Learn about all the Azure Monitor workbook text visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Text | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-text.md | Title: Azure Monitor workbook text parameters description: Simplify complex reporting with prebuilt and custom parameterized workbooks. Learn more about workbook text parameters. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Tile Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-tile-visualizations.md | Title: Azure Monitor workbook tile visualizations description: Learn about all the Azure Monitor workbook tile visualizations. - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Time | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-time.md | Title: Azure Monitor workbook time parameters description: Learn how to set time parameters to allow users to set the time context of analysis. The time parameters are used by almost all reports. - - ibiza Last updated 06/21/2023 |
| azure-monitor | Workbooks Tree Visualizations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-monitor/visualize/workbooks-tree-visualizations.md | Title: Azure Monitor workbook tree visualizations description: Learn about all the Azure Monitor workbook tree visualizations. - ibiza Last updated 06/21/2023 |
| azure-netapp-files | Application Volume Group Add Hosts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-add-hosts.md | Title: Add hosts to a multiple-host SAP HANA system using Azure NetApp Files application volume group for SAP HANA | Microsoft Docs description: Describes how to add additional HANA hosts after you have created the first host in an SAP HANA multiple-host setup. -- Last updated 11/19/2021 |
| azure-netapp-files | Application Volume Group Add Volume Secondary | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-add-volume-secondary.md | Title: Add volumes for an SAP HANA system as a secondary database in HSR using Azure NetApp Files | Microsoft Docs description: Describes using application volume group to add volumes for an SAP HANA system as a secondary database in HANA System Replication (HSR). -- Last updated 11/19/2021 |
| azure-netapp-files | Application Volume Group Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-considerations.md | Title: Requirements and considerations for Azure NetApp Files application volume group for SAP HANA | Microsoft Docs description: Describes the requirements and considerations you need to be aware of before using Azure NetApp Files application volume group for SAP HANA. -- Last updated 11/08/2023 |
| azure-netapp-files | Application Volume Group Delete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-delete.md | Title: Delete an application volume group in Azure NetApp Files | Microsoft Docs description: Describes how to delete an application volume group. -- Last updated 11/19/2021 |
| azure-netapp-files | Application Volume Group Deploy First Host | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-deploy-first-host.md | Title: Deploy the first SAP HANA host using Azure NetApp Files application volume group for SAP HANA | Microsoft Docs description: Describes how to deploy the first SAP HANA host using Azure NetApp Files application volume group for SAP HANA. -- Last updated 10/13/2022 |
| azure-netapp-files | Application Volume Group Disaster Recovery | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-disaster-recovery.md | Title: Add volumes for an SAP HANA system as a DR system using Azure NetApp Files cross-region replication | Microsoft Docs description: Describes using an application volume group to add volumes for an SAP HANA system as a disaster recovery (DR) system. -- Last updated 08/22/2022 |
| azure-netapp-files | Application Volume Group Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-introduction.md | Title: Understand Azure NetApp Files application volume group for SAP HANA | Microsoft Docs description: Describes the use cases and key features of Azure NetApp Files application volume group for SAP HANA. -- Last updated 02/24/2023 |
| azure-netapp-files | Application Volume Group Manage Volumes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/application-volume-group-manage-volumes.md | Title: Manage volumes in Azure NetApp Files application volume group | Microsoft Docs description: Describes how to manage a volume from its application volume group, including resizing, deleting, or changing throughput for the volume. -- Last updated 11/19/2021 |
| azure-netapp-files | Auxiliary Groups | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/auxiliary-groups.md | Title: Understand auxiliary/supplemental groups with NFS in Azure NetApp Files description: Learn about auxiliary/supplemental groups with NFS in Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Azacsnap Cmd Ref Backup | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-backup.md | Title: Back up using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for running the backup command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 07/29/2022 |
| azure-netapp-files | Azacsnap Cmd Ref Configure | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-configure.md | Title: Configure the Azure Application Consistent Snapshot tool for Azure NetApp Files description: Learn how to run the configure command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 08/21/2023 |
| azure-netapp-files | Azacsnap Cmd Ref Delete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-delete.md | Title: Delete using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for running the delete command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 01/18/2023 |
| azure-netapp-files | Azacsnap Cmd Ref Details | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-details.md | Title: Obtain details using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for running the details command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 04/21/2021 |
| azure-netapp-files | Azacsnap Cmd Ref Restore | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-restore.md | Title: Restore using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for running the restore command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 05/04/2023 |
| azure-netapp-files | Azacsnap Cmd Ref Runbefore Runafter | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-runbefore-runafter.md | Title: RunBefore and RunAfter using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for using the runbefore and runafter options of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 07/29/2022 |
| azure-netapp-files | Azacsnap Cmd Ref Test | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-cmd-ref-test.md | Title: Test Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Explains how to run the test command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 08/04/2021 |
| azure-netapp-files | Azacsnap Disaster Recovery | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-disaster-recovery.md | Title: Disaster recovery using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Explains how to perform disaster recovery when using the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 04/21/2021 |
| azure-netapp-files | Azacsnap Get Started | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-get-started.md | Title: Get started with Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides a guide for installing the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 03/03/2022 |
| azure-netapp-files | Azacsnap Installation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-installation.md | Title: Install the Azure Application Consistent Snapshot tool for Azure NetApp Files description: Learn how to install the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 08/21/2023 |
| azure-netapp-files | Azacsnap Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-introduction.md | Title: What is the Azure Application Consistent Snapshot tool for Azure NetApp Files description: Get basic information about the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 08/21/2023 |
| azure-netapp-files | Azacsnap Preview | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-preview.md | |
| azure-netapp-files | Azacsnap Release Notes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-release-notes.md | Title: Release Notes for Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides release notes for the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 08/21/2023 |
| azure-netapp-files | Azacsnap Tips | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-tips.md | Title: Tips and tricks for using Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs description: Provides tips and tricks for using the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. -- Last updated 09/20/2023 |
| azure-netapp-files | Azacsnap Troubleshoot | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azacsnap-troubleshoot.md | Title: Troubleshoot Azure Application Consistent Snapshot tool - Azure NetApp Files description: Troubleshoot communication issues, test failures, and other SAP HANA issues when using the Azure Application Consistent Snapshot (AzAcSnap) tool. -- Last updated 01/16/2023 |
| azure-netapp-files | Azure Government | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-government.md | Title: Azure NetApp Files for Azure Government | Microsoft Docs description: Learn how to connect to Azure Government to use Azure NetApp Files and the Azure NetApp Files feature availability in Azure Government. -- Last updated 11/02/2023 |
| azure-netapp-files | Azure Netapp Files Configure Nfsv41 Domain | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-configure-nfsv41-domain.md | Title: Configure NFSv4.1 ID domain for Azure NetApp Files | Microsoft Docs description: Learn how to configure NFSv4.1 ID domain for using NFSv4.1 with Azure NetApp Files. -- Last updated 07/12/2023 |
| azure-netapp-files | Azure Netapp Files Cost Model | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-cost-model.md | Title: Cost model for Azure NetApp Files | Microsoft Docs description: Describes the cost model for Azure NetApp Files for managing expenses from the service. -- Last updated 11/08/2021 |
| azure-netapp-files | Azure Netapp Files Create Netapp Account | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-create-netapp-account.md | Title: Create a NetApp account to access Azure NetApp Files | Microsoft Docs description: Learn how to access Azure NetApp Files and create a NetApp account so that you can set up a capacity pool and create a volume. -- Last updated 10/04/2021 |
| azure-netapp-files | Azure Netapp Files Create Volumes Smb | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-create-volumes-smb.md | Title: Create an SMB volume for Azure NetApp Files | Microsoft Docs description: This article shows you how to create an SMB3 volume in Azure NetApp Files. Learn about requirements for Active Directory connections and Domain Services. -- Last updated 05/31/2023 |
| azure-netapp-files | Azure Netapp Files Create Volumes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-create-volumes.md | Title: Create an NFS volume for Azure NetApp Files | Microsoft Docs description: This article shows you how to create an NFS volume in Azure NetApp Files. Learn about considerations, like which version to use, and best practices. -- Last updated 05/28/2023 |
| azure-netapp-files | Azure Netapp Files Delegate Subnet | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-delegate-subnet.md | Title: Delegate a subnet to Azure NetApp Files | Microsoft Docs description: Learn how to delegate a subnet to Azure NetApp Files. Specify the delegated subnet when you create a volume. -- Last updated 09/28/2023 |
| azure-netapp-files | Azure Netapp Files Develop With Rest Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-develop-with-rest-api.md | Title: Develop for Azure NetApp Files with REST API | Microsoft Docs description: The REST API for the Azure NetApp Files service defines HTTP operations for resources such as the NetApp account, the capacity pool, the volumes, and snapshots. -- Last updated 09/30/2022 |
| azure-netapp-files | Azure Netapp Files Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-introduction.md | Title: What is Azure NetApp Files | Microsoft Docs description: Learn about Azure NetApp Files, an Azure native, first-party, enterprise-class, high-performance file storage service. -- Last updated 01/11/2024 |
| azure-netapp-files | Azure Netapp Files Manage Snapshots | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-manage-snapshots.md | Title: Create an on-demand snapshot using Azure NetApp Files | Microsoft Docs description: Describes how to create on-demand snapshots with Azure NetApp Files. -- Last updated 10/25/2021 |
| azure-netapp-files | Azure Netapp Files Metrics | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-metrics.md | Title: Metrics for Azure NetApp Files | Microsoft Docs description: Azure NetApp Files provides metrics on allocated storage, actual storage usage, volume IOPS, and latency. Use these metrics to understand usage and performance. -- Last updated 07/19/2023 |
| azure-netapp-files | Azure Netapp Files Network Topologies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-network-topologies.md | Title: Guidelines for Azure NetApp Files network planning | Microsoft Docs description: Describes guidelines that can help you design an effective network architecture by using Azure NetApp Files. -- Last updated 08/10/2023 |
| azure-netapp-files | Azure Netapp Files Performance Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-performance-considerations.md | Title: Performance considerations for Azure NetApp Files | Microsoft Docs description: Learn about performance for Azure NetApp Files, including the relationship of quota and throughput limit and how to dynamically increase/decrease volume quota. -- Last updated 08/31/2023 |
| azure-netapp-files | Azure Netapp Files Register | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-register.md | Title: Register for NetApp Resource Provider to use with Azure NetApp Files | Microsoft Docs description: Learn how to register the NetApp Resource Provider for Azure NetApp Files. -- Last updated 01/21/2022 |
| azure-netapp-files | Azure Netapp Files Resize Capacity Pools Or Volumes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-resize-capacity-pools-or-volumes.md | Title: Resize the capacity pool or a volume for Azure NetApp Files | Microsoft Docs description: Learn how to change the size of a capacity pool or a volume. Resizing the capacity pool changes the purchased Azure NetApp Files capacity. -- Last updated 02/21/2023 |
| azure-netapp-files | Azure Netapp Files Resource Limits | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-resource-limits.md | Title: Resource limits for Azure NetApp Files | Microsoft Docs description: Describes limits for Azure NetApp Files resources and how to request resource limit increase. -- Last updated 09/29/2023 |
| azure-netapp-files | Azure Netapp Files Sdk Cli | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-sdk-cli.md | Title: Azure NetApp Files SDKs and CLI tools | Microsoft Docs description: "Learn about supported SDKs for Azure NetApp Files and their published locations in GitHub, and about supported command-line tools: Azure CLI and PowerShell." -- Last updated 09/30/2022 |
| azure-netapp-files | Azure Netapp Files Service Levels | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-service-levels.md | Title: Service levels for Azure NetApp Files | Microsoft Docs description: Describes throughput performance for the service levels of Azure NetApp Files. -- Last updated 08/02/2022 |
| azure-netapp-files | Azure Netapp Files Set Up Capacity Pool | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-set-up-capacity-pool.md | Title: Create a capacity pool for Azure NetApp Files | Microsoft Docs description: Describes how to create a capacity pool so that you can create volumes within it. -- Last updated 10/23/2023 |
| azure-netapp-files | Azure Netapp Files Smb Performance | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-smb-performance.md | Title: SMB performance best practices for Azure NetApp Files| Microsoft Docs description: Helps you understand SMB performance and best practices for Azure NetApp Files. -- Last updated 02/07/2022 |
| azure-netapp-files | Azure Netapp Files Solution Architectures | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-solution-architectures.md | Title: Solution architectures using Azure NetApp Files | Microsoft Docs description: Provides references to best practices for solution architectures using Azure NetApp Files. -- Last updated 09/18/2023 |
| azure-netapp-files | Azure Netapp Files Troubleshoot Resource Provider Errors | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-troubleshoot-resource-provider-errors.md | Title: Troubleshoot Azure NetApp Files Resource Provider errors | Microsoft Docs description: Describes causes, solutions, and workarounds for common Azure NetApp Files Resource Provider errors. - -tags: - Last updated 02/09/2022 |
| azure-netapp-files | Azure Netapp Files Understand Storage Hierarchy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-understand-storage-hierarchy.md | Title: Storage hierarchy of Azure NetApp Files | Microsoft Docs description: Describes the storage hierarchy, including Azure NetApp Files accounts, capacity pools, and volumes. -- Last updated 07/27/2023 |
| azure-netapp-files | Azure Netapp Files Videos | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/azure-netapp-files-videos.md | Title: Azure NetApp Files videos | Microsoft Docs description: Provides references to videos that contain discussions about using Azure NetApp Files. -- Last updated 12/07/2023 |
| azure-netapp-files | Backup Configure Manual | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-configure-manual.md | Title: Configure manual backups for Azure NetApp Files | Microsoft Docs description: Describes how to configure manual backups for Azure NetApp Files volumes. -- Last updated 06/13/2023 |
| azure-netapp-files | Backup Configure Policy Based | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-configure-policy-based.md | Title: Configure policy-based backups for Azure NetApp Files | Microsoft Docs description: Describes how to configure policy-based (scheduled) backups for Azure NetApp Files volumes. -- Last updated 10/25/2023 |
| azure-netapp-files | Backup Delete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-delete.md | Title: Delete backups of an Azure NetApp Files volume | Microsoft Docs description: Describes how to delete individual backups that you no longer need to keep for a volume. -- Last updated 10/27/2022 |
| azure-netapp-files | Backup Disable | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-disable.md | Title: Disable backup functionality for an Azure NetApp Files volume | Microsoft Docs description: Describes how to disable the backup functionality for a volume that no longer needs backup protection. -- Last updated 10/27/2022 |
| azure-netapp-files | Backup Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-introduction.md | Title: Understand Azure NetApp Files backup | Microsoft Docs description: Describes what Azure NetApp Files backup does, supported regions, and the cost model. -- Last updated 09/29/2023 |
| azure-netapp-files | Backup Manage Policies | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-manage-policies.md | Title: Manage backup policies for Azure NetApp Files | Microsoft Docs description: Describes how to modify or suspend a backup policy for Azure NetApp Files volumes. -- Last updated 07/31/2023 |
| azure-netapp-files | Backup Requirements Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-requirements-considerations.md | Title: Requirements and considerations for Azure NetApp Files backup | Microsoft Docs description: Describes the requirements and considerations you need to be aware of before using Azure NetApp Files backup. -- Last updated 08/15/2023 |
| azure-netapp-files | Backup Restore New Volume | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-restore-new-volume.md | Title: Restore a backup to a new Azure NetApp Files volume | Microsoft Docs description: Describes how to restore a backup to a new volume. -- Last updated 10/17/2023 |
| azure-netapp-files | Backup Search | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-search.md | Title: Search backups of Azure NetApp Files volumes | Microsoft Docs description: Describes how to display and search backups of Azure NetApp Files volumes at the volume level and the NetApp account level. -- Last updated 09/27/2021 |
| azure-netapp-files | Backup Vault Manage | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/backup-vault-manage.md | Title: Manage backup vaults for Azure NetApp Files | Microsoft Docs description: Describes how to use backup vaults to manage backups in Azure NetApp Files. -- Last updated 10/27/2022 |
| azure-netapp-files | Configure Application Volume Group Sap Hana Api | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-application-volume-group-sap-hana-api.md | Title: Configure application volume groups for SAP HANA using REST API description: Setting up your application volume groups for the SAP HANA API requires special configurations. -- Last updated 04/09/2023 |
| azure-netapp-files | Configure Customer Managed Keys | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-customer-managed-keys.md | Title: Configure customer-managed keys for Azure NetApp Files volume encryption | Microsoft Docs description: Describes how to configure customer-managed keys for Azure NetApp Files volume encryption. -- Last updated 10/02/2023 |
| azure-netapp-files | Configure Kerberos Encryption | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-kerberos-encryption.md | Title: Configure NFSv4.1 Kerberos encryption for Azure NetApp Files | Microsoft Docs description: Describes how to configure NFSv4.1 Kerberos encryption for Azure NetApp Files and the performance impact. -- Last updated 01/10/2022 |
| azure-netapp-files | Configure Ldap Extended Groups | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-ldap-extended-groups.md | Title: Enable Active Directory Domain Services (AD DS) LDAP authentication for NFS volumes | Microsoft Docs description: Describes the considerations and steps for enabling LDAP with extended groups when you create an NFS volume by using Azure NetApp Files. -- Last updated 03/17/2023 |
| azure-netapp-files | Configure Ldap Over Tls | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-ldap-over-tls.md | Title: Configure AD DS LDAP over TLS for Azure NetApp Files | Microsoft Docs description: Describes how to configure AD DS LDAP over TLS for Azure NetApp Files, including root CA certificate management. -- Last updated 02/23/2023 |
| azure-netapp-files | Configure Network Features | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-network-features.md | Title: Configure network features for an Azure NetApp Files volume | Microsoft Docs description: Describes the options for network features and how to configure the Network Features option for a volume. -- Last updated 11/07/2023 See [regions supported for this feature](azure-netapp-files-network-topologies.m This feature currently doesn't support SDK. > [!NOTE]-> The option to edit network features is currently in preview. You need to submit a waitlist request for accessing the feature through the **[Azure NetApp Files standard networking features (edit volumes) Public Preview Request Form](https://aka.ms/anfeditnetworkfeaturespreview)**. This feature is expected to be enabled within a week after you submit the waitlist request. You can check the status of feature registration by using the following command: +> The option to edit network features is currently in preview. You need to submit a waitlist request for accessing the feature through the **[Azure NetApp Files standard networking features (edit volumes) Public Preview Request Form](https://aka.ms/anfeditnetworkfeaturespreview)**. The feature can take approximately one week to be enabled after you submit the waitlist request. You can check the status of feature registration by using the following command: > > ```azurepowershell-interactive > Get-AzProviderFeature -ProviderNamespace Microsoft.NetApp -FeatureName ANFBasicToStdNetworkFeaturesUpgrade This feature currently doesn't support SDK. > ``` > [!NOTE]-> You can also revert the option from *Standard* back to *Basic* network features. However, before performing the revert operation, you need to submit a waitlist request through the **[Azure NetApp Files standard networking features (edit volumes) Public Preview Request Form](https://aka.ms/anfeditnetworkfeaturespreview)**. The revert capability is expected to be enabled within a week after you submit the waitlist request. You can check the status of the registration by using the following command: +> You can also revert the option from *Standard* back to *Basic* network features. However, before performing the revert operation, you need to submit a waitlist request through the **[Azure NetApp Files standard networking features (edit volumes) Public Preview Request Form](https://aka.ms/anfeditnetworkfeaturespreview)**. The revert capability can take approximately one week to be enabled after you submit the waitlist request. You can check the status of the registration by using the following command: > > ```azurepowershell-interactive > Get-AzProviderFeature -ProviderNamespace Microsoft.NetApp -FeatureName ANFStdToBasicNetworkFeaturesRevert |
| azure-netapp-files | Configure Nfs Clients | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-nfs-clients.md | Title: Configure an NFS client for Azure NetApp Files | Microsoft Docs description: Describes how to configure NFS clients to use with Azure NetApp Files. -- Last updated 05/27/2022 |
| azure-netapp-files | Configure Unix Permissions Change Ownership Mode | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/configure-unix-permissions-change-ownership-mode.md | Title: Configure Unix permissions and change ownership mode for Azure NetApp Files NFS and dual-protocol volumes | Microsoft Docs description: Describes how to set the Unix permissions and the change ownership mode options for Azure NetApp Files NFS and dual-protocol volumes. -- Last updated 02/28/2023 |
| azure-netapp-files | Convert Nfsv3 Nfsv41 | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/convert-nfsv3-nfsv41.md | Title: Convert an NFS volume between NFSv3 and NFSv4.1 with Azure NetApp Files | Microsoft Docs description: Describes how to convert an NFS volume between NFSv3 and NFSv4.1. -- Last updated 11/08/2022 |
| azure-netapp-files | Cool Access Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cool-access-introduction.md | Title: Standard storage with cool access in Azure NetApp Files description: Explains how to use standard storage with cool access to configure inactive data to move from Azure NetApp Files Standard service-level storage (the hot tier) to an Azure storage account (the cool tier). -- Last updated 11/01/2023 |
| azure-netapp-files | Create Active Directory Connections | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/create-active-directory-connections.md | Several features of Azure NetApp Files require that you have an Active Directory > [!IMPORTANT] > You must follow guidelines described in [Understand guidelines for Active Directory Domain Services site design and planning for Azure NetApp Files](understand-guidelines-active-directory-domain-service-site.md) for Active Directory Domain Services (AD DS) or Microsoft Entra Domain Services used with Azure NetApp Files. -> In addition, before creating the AD connection, review [Modify Active Directory connections for Azure NetApp Files](modify-active-directory-connections.md) to understand the impact of making changes to the AD connection configuration options after the AD connection has been created. Changes to the AD connection configuration options are disruptive to client access and some options cannot be changed at all. +> +> Before creating the AD connection, review [Modify Active Directory connections for Azure NetApp Files](modify-active-directory-connections.md) to understand the impact of making changes to the AD connection configuration options after the AD connection has been created. Changes to the AD connection configuration options are disruptive to client access and some options cannot be changed at all. * An Azure NetApp Files account must be created in the region where the Azure NetApp Files volumes are deployed. |
| azure-netapp-files | Create Cross Zone Replication | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/create-cross-zone-replication.md | Title: Create cross-zone replication relationships for Azure NetApp Files | Microsoft Docs description: This article shows you how to create and manage cross-zone replication relationships for Azure NetApp Files. -- Last updated 01/04/2023 |
| azure-netapp-files | Create Volumes Dual Protocol | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/create-volumes-dual-protocol.md | Title: Create a dual-protocol volume for Azure NetApp Files | Microsoft Docs description: Describes how to create a volume that uses the dual protocol (NFSv3 and SMB, or NFSv4.1 and SMB) with support for LDAP user mapping. -- Last updated 06/22/2023 |
| azure-netapp-files | Cross Region Replication Create Peering | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-create-peering.md | Title: Create volume replication for Azure NetApp Files | Microsoft Docs description: Describes how to create volume replication peering for Azure NetApp Files to set up cross-region replication. -- Last updated 02/23/2023 |
| azure-netapp-files | Cross Region Replication Delete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-delete.md | Title: Delete volume replications or volumes for Azure NetApp Files cross-region replication | Microsoft Docs description: Describes how to delete a replication connection that is no longer needed between the source and the destination volumes. -- Last updated 03/22/2023 |
| azure-netapp-files | Cross Region Replication Display Health Status | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-display-health-status.md | Title: Display health status of Azure NetApp Files replication relationship | Microsoft Docs description: Describes how to view replication status on the source volume or the destination volume of Azure NetApp Files. -- Last updated 05/16/2022 |
| azure-netapp-files | Cross Region Replication Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-introduction.md | Title: Cross-region replication of Azure NetApp Files volumes | Microsoft Docs description: Describes what Azure NetApp Files cross-region replication does, supported region pairs, service-level objectives, data durability, and cost model. -- Last updated 05/08/2023 |
| azure-netapp-files | Cross Region Replication Manage Disaster Recovery | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-manage-disaster-recovery.md | Title: Manage disaster recovery using Azure NetApp Files cross-region replication | Microsoft Docs description: Describes how to manage disaster recovery by using Azure NetApp Files cross-region replication. -- Last updated 11/09/2022 |
| azure-netapp-files | Cross Region Replication Requirements Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-region-replication-requirements-considerations.md | Title: Requirements and considerations for Azure NetApp Files cross-region replication | Microsoft Docs description: Describes the requirements and considerations for using the volume cross-region replication functionality of Azure NetApp Files. -- Last updated 02/28/2023 |
| azure-netapp-files | Cross Zone Replication Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-zone-replication-introduction.md | Title: Cross-zone replication of Azure NetApp Files volumes | Microsoft Docs description: Describes what Azure NetApp Files cross-zone replication does. -- Last updated 02/17/2023 |
| azure-netapp-files | Cross Zone Replication Requirements Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/cross-zone-replication-requirements-considerations.md | Title: Requirements and considerations for Azure NetApp Files cross-zone replication | Microsoft Docs description: Describes the requirements and considerations for using the volume cross-zone replication functionality of Azure NetApp Files. -- Last updated 08/18/2023 |
| azure-netapp-files | Data Protection Disaster Recovery Options | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/data-protection-disaster-recovery-options.md | Title: Understand data protection and disaster recovery options in Azure NetApp Files description: Learn about data protection and disaster recovery options available in Azure NetApp Files, including snapshots, backups, cross-zone replication, and cross-region replication. -- Last updated 07/11/2023 |
| azure-netapp-files | Default Individual User Group Quotas Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/default-individual-user-group-quotas-introduction.md | Title: Understand default and individual user and group quotas for Azure NetApp Files volumes | Microsoft Docs description: Helps you understand the use cases of managing default and individual user and group quotas for Azure NetApp Files volumes. -- Last updated 02/23/2023 |
| azure-netapp-files | Develop Rest Api Powershell | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/develop-rest-api-powershell.md | Title: Develop for Azure NetApp Files with REST API using PowerShell | Microsoft Docs description: Describes how to get started with the Azure NetApp Files REST API using PowerShell. -- Last updated 09/30/2022 |
| azure-netapp-files | Disable Showmount | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/disable-showmount.md | Title: Disable showmount in Azure NetApp Files | Microsoft Docs description: Showmount on NFS clients has historically been how users can see exported file systems on an NFS server. You can disable the showmount if it presents a security concern for your needs. -- Last updated 03/16/2023 |
| azure-netapp-files | Double Encryption At Rest | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/double-encryption-at-rest.md | Title: Azure NetApp Files double encryption at rest | Microsoft Docs description: Explains Azure NetApp Files double encryption at rest to help you use this feature. -- Last updated 08/28/2023 |
| azure-netapp-files | Dual Protocol Permission Behaviors | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/dual-protocol-permission-behaviors.md | Title: Understand dual-protocol security style and permission behaviors in Azure NetApp Files | Microsoft Docs description: This article helps you understand dual-protocol security style and permission when you use Azure NetApp Files. -- Last updated 08/02/2023 |
| azure-netapp-files | Dynamic Change Volume Service Level | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/dynamic-change-volume-service-level.md | Title: Dynamically change the service level of a volume for Azure NetApp Files | Microsoft Docs description: Describes how to dynamically change the service level of a volume. -- Last updated 05/11/2023 |
| azure-netapp-files | Enable Continuous Availability Existing SMB | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/enable-continuous-availability-existing-SMB.md | Title: Enable Continuous Availability on existing Azure NetApp Files SMB volumes | Microsoft Docs description: Describes how to enable SMB Continuous Availability on existing Azure NetApp Files SMB volume. -- Last updated 05/31/2023 |
| azure-netapp-files | Join Active Directory Domain | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/join-active-directory-domain.md | Title: Join a Linux VM to a Microsoft Entra Domain | Microsoft Docs description: Describes how to join a Linux VM to a Microsoft Entra Domain -- Last updated 12/20/2022 |
| azure-netapp-files | Large Volumes Requirements Considerations | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/large-volumes-requirements-considerations.md | Title: Requirements and considerations for large volumes | Microsoft Docs description: Describes the requirements and considerations you need to be aware of before using large volumes. -- Last updated 11/02/2023 |
| azure-netapp-files | Lightweight Directory Access Protocol | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/lightweight-directory-access-protocol.md | Title: Understand the use of LDAP with Azure NetApp Files | Microsoft Learn description: This article helps you understand how Azure NetApp Files uses lightweight directory access protocol (LDAP). -- Last updated 08/05/2023 |
| azure-netapp-files | Manage Availability Zone Volume Placement | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/manage-availability-zone-volume-placement.md | Title: Manage availability zone volume placement for Azure NetApp Files | Microsoft Docs description: Describes how to create a volume with an availability zone by using Azure NetApp Files. -- Last updated 01/13/2023 |
| azure-netapp-files | Manage Billing Tags | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/manage-billing-tags.md | Title: Manage Azure NetApp Files billing by using tags | Microsoft Docs description: Describes how to manage Azure NetApp Files billing by using tags. -- Last updated 05/06/2021 |
| azure-netapp-files | Manage Cool Access | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/manage-cool-access.md | Title: Manage Azure NetApp Files standard storage with cool access description: Learn how to free up storage by configuring inactive data to move from Azure NetApp Files Standard service-level storage (the hot tier) to an Azure storage account (the cool tier). -- Last updated 10/20/2023 |
| azure-netapp-files | Manage Manual Qos Capacity Pool | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/manage-manual-qos-capacity-pool.md | Title: Manage a manual QoS capacity pool for Azure NetApp Files | Microsoft Docs description: Describes how to manage a capacity pool that uses the manual QoS type, including setting up a manual QoS capacity pool and changing a capacity pool to use manual QoS. -- Last updated 06/14/2021 |
| azure-netapp-files | Modify Active Directory Connections | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/modify-active-directory-connections.md | +For more information, see [Understand guidelines for Active Directory Domain Services site design and planning for Azure NetApp Files](understand-guidelines-active-directory-domain-service-site.md). + ## Modify Active Directory connections 1. Select **Active Directory connections**. Then, select **Edit** to edit an existing AD connection. |
| azure-netapp-files | Monitor Azure Netapp Files | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/monitor-azure-netapp-files.md | Title: Ways to monitor Azure NetApp Files | Microsoft Docs description: Describes ways to monitor Azure NetApp Files, including the Activity log, metrics, and capacity utilization monitoring. -- Last updated 01/24/2022 |
| azure-netapp-files | Monitor Volume Capacity | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/monitor-volume-capacity.md | Title: Monitor the capacity of an Azure NetApp Files volume | Microsoft Docs description: Describes ways to monitor the capacity utilization of an Azure NetApp Files volume. -- Last updated 09/30/2022 |
| azure-netapp-files | Network Attached File Permissions Nfs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-file-permissions-nfs.md | Title: Understand NFS file permissions in Azure NetApp Files description: Learn about mode bits in NFS workloads on Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Network Attached File Permissions Smb | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-file-permissions-smb.md | Title: Understand SMB file permissions in Azure NetApp Files description: Learn about SMB file permissions options in Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Network Attached File Permissions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-file-permissions.md | Title: Understand NAS file permissions in Azure NetApp Files description: Learn about NAS file permissions options in Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Network Attached Storage Concept | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-storage-concept.md | Title: Understand NAS concepts in Azure NetApp Files | Microsoft Docs description: This article covers important information about NAS volumes when using Azure NetApp Files. -- Last updated 06/26/2023 |
| azure-netapp-files | Network Attached Storage Permissions | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-storage-permissions.md | Title: Understand NAS share permissions in Azure NetApp Files description: Learn about NAS share permissions options in Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Network Attached Storage Protocols | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-attached-storage-protocols.md | Title: Understand NAS protocols in Azure NetApp Files | Microsoft Learn description: Learn how SMB, NFS, and dual protocols operate in Azure NetApp Files. -- Last updated 08/02/2023 |
| azure-netapp-files | Network File System Group Memberships | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/network-file-system-group-memberships.md | Title: Understand NFS group memberships and supplemental groups for Azure NetApp Files | Microsoft Learn description: This article helps you understand NFS group memberships and supplemental groups as they apply to Azure NetApp Files. -- Last updated 08/02/2023 |
| azure-netapp-files | Nfs Access Control Lists | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/nfs-access-control-lists.md | Title: Understand NFSv4.x access control lists in Azure NetApp Files description: Learn about using NFSv4.x access control lists in Azure NetApp Files. -- Last updated 11/13/2023 |
| azure-netapp-files | Performance Azure Vmware Solution Datastore | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-azure-vmware-solution-datastore.md | Title: Azure VMware Solution datastore performance considerations for Azure NetApp Files | Microsoft Docs description: Describes considerations for Azure VMware Solution (AVS) datastore design and sizing when used with Azure NetApp Files. -- Last updated 11/12/2023 |
| azure-netapp-files | Performance Benchmarks Azure Vmware Solution | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-benchmarks-azure-vmware-solution.md | Title: Azure NetApp Files datastore performance benchmarks for Azure VMware Solution | Microsoft Docs description: Describes performance benchmarks that Azure NetApp Files datastores deliver for virtual machines on Azure VMware Solution. -- Last updated 03/15/2023 |
| azure-netapp-files | Performance Benchmarks Linux | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-benchmarks-linux.md | Title: Azure NetApp Files performance benchmarks for Linux | Microsoft Docs description: Describes performance benchmarks Azure NetApp Files delivers for Linux. -- Last updated 09/29/2021 |
| azure-netapp-files | Performance Impact Kerberos | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-impact-kerberos.md | Title: Performance impact of Kerberos on Azure NetApp Files NFSv4.1 volumes | Microsoft Docs description: Describes the available security options, the tested performance vectors, and the expected performance impact of kerberos on Azure NetApp Files NFSv4.1 volumes. -- Last updated 08/22/2022 |
| azure-netapp-files | Performance Linux Concurrency Session Slots | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-linux-concurrency-session-slots.md | Title: Linux concurrency best practices for Azure NetApp Files - Session slots and slot table entries | Microsoft Docs description: Describes best practices about session slots and slot table entries for Azure NetApp Files NFS protocol. -- Last updated 08/02/2021 |
| azure-netapp-files | Performance Linux Direct Io | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-linux-direct-io.md | Title: Linux direct I/O best practices for Azure NetApp Files | Microsoft Docs description: Describes Linux direct I/O and the best practices to follow for Azure NetApp Files. -- Last updated 07/02/2021 |
| azure-netapp-files | Performance Linux Filesystem Cache | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-linux-filesystem-cache.md | Title: Linux filesystem cache best practices for Azure NetApp Files | Microsoft Docs description: Describes Linux filesystem cache best practices to follow for Azure NetApp Files. -- Last updated 07/02/2021 |
| azure-netapp-files | Performance Linux Mount Options | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-linux-mount-options.md | Title: Linux NFS mount options best practices for Azure NetApp Files | Microsoft Docs description: Describes mount options and the best practices about using them with Azure NetApp Files. -- Last updated 12/07/2022 |
| azure-netapp-files | Performance Linux Nfs Read Ahead | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-linux-nfs-read-ahead.md | Title: Linux NFS read-ahead best practices for Azure NetApp Files - Session slots and slot table entries | Microsoft Docs description: Describes filesystem cache and Linux NFS read-ahead best practices for Azure NetApp Files. -- Last updated 09/29/2022 |
| azure-netapp-files | Performance Oracle Multiple Volumes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-oracle-multiple-volumes.md | Title: Oracle database performance on Azure NetApp Files multiple volumes | Microsoft Docs description: Migrating highly performant Exadata grade databases to the cloud is increasingly becoming an imperative for Microsoft customers. -- Last updated 05/04/2023 |
| azure-netapp-files | Performance Oracle Single Volumes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-oracle-single-volumes.md | Title: Oracle database performance on Azure NetApp Files single volume | Microsoft Docs description: Describes performance test results of a Azure NetApp Files single volume on Oracle database. -- Last updated 08/04/2022 |
| azure-netapp-files | Performance Virtual Machine Sku | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/performance-virtual-machine-sku.md | Title: Azure virtual machine SKUs best practices for Azure NetApp Files | Microsoft Docs description: Describes Azure NetApp Files best practices about Azure virtual machine SKUs, including differences within and between SKUs. -- Last updated 07/02/2021 |
| azure-netapp-files | Regional Capacity Quota | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/regional-capacity-quota.md | Title: Regional capacity quota for Azure NetApp Files | Microsoft Docs description: Explains regional capacity quota of Azure NetApp Files. -- Last updated 10/11/2021 |
| azure-netapp-files | Request Region Access | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/request-region-access.md | Title: Request region access for Azure NetApp Files | Microsoft Docs description: Describes how to request access to a region for using Azure NetApp Files. -- Last updated 11/15/2021 |
| azure-netapp-files | Snapshots Delete | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-delete.md | Title: Delete snapshots using Azure NetApp Files | Microsoft Docs description: Describes how to delete snapshots by using Azure NetApp Files. -- Last updated 09/16/2021 |
| azure-netapp-files | Snapshots Edit Hide Path | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-edit-hide-path.md | Title: Edit the Hide Snapshot Path option of Azure NetApp Files | Microsoft Docs description: Describes how to control the visibility of a snapshot volume with Azure NetApp Files. -- Last updated 09/16/2021 |
| azure-netapp-files | Snapshots Introduction | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-introduction.md | Title: How Azure NetApp Files snapshots work | Microsoft Docs description: Explains how Azure NetApp Files snapshots work, including ways to create snapshots, ways to restore snapshots, how to use snapshots in cross-region replication settings. -- Last updated 11/22/2022 |
| azure-netapp-files | Snapshots Manage Policy | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-manage-policy.md | Title: Manage snapshot policies in Azure NetApp Files | Microsoft Docs description: Describes how to create, manage, modify, and delete snapshot policies by using Azure NetApp Files. -- Last updated 05/18/2023 |
| azure-netapp-files | Snapshots Restore File Client | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-restore-file-client.md | Title: Restore a file from a snapshot using a client with Azure NetApp Files | Microsoft Docs description: Describes how to restore a file from a snapshot using a client with the volume mounted using Azure NetApp Files. -- Last updated 09/16/2021 |
| azure-netapp-files | Snapshots Restore File Single | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-restore-file-single.md | Title: Restore individual files in Azure NetApp Files using single-file snapshot restore | Microsoft Docs description: Describes how to recover individual files directly within a volume from a snapshot. -- Last updated 05/04/2023 |
| azure-netapp-files | Snapshots Restore New Volume | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-restore-new-volume.md | Title: Restore a snapshot to a new volume using Azure NetApp Files | Microsoft Docs description: Describes how to create a new volume from a snapshot by using Azure NetApp Files. -- Last updated 02/22/2023 |
| azure-netapp-files | Snapshots Revert Volume | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/snapshots-revert-volume.md | Title: Revert a volume using snapshot revert with Azure NetApp Files | Microsoft Docs description: Describes how to revert a volume to an earlier state using Azure NetApp Files. -- Last updated 02/28/2023 |
| azure-netapp-files | Solutions Benefits Azure Netapp Files Electronic Design Automation | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/solutions-benefits-azure-netapp-files-electronic-design-automation.md | Title: Benefits of using Azure NetApp Files for electronic design automation | Microsoft Docs description: Explains the solution Azure NetApp Files provides for meeting the needs of the semiconductor and chip design industry. Presents test scenarios running a standard industry benchmark for electronic design automation (EDA) using Azure NetApp Files. -- Last updated 04/24/2020 |
| azure-netapp-files | Solutions Benefits Azure Netapp Files Oracle Database | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/solutions-benefits-azure-netapp-files-oracle-database.md | Title: Benefits of using Azure NetApp Files with Oracle Database | Microsoft Docs description: Describes the technology and provides a performance comparison between Oracle Direct NFS (dNFS) and the traditional NFS client. Shows the advantages of using dNFS with Azure NetApp Files. -- Last updated 08/04/2022 |
| azure-netapp-files | Solutions Benefits Azure Netapp Files Sql Server | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/solutions-benefits-azure-netapp-files-sql-server.md | Title: Benefits of using Azure NetApp Files for SQL Server deployment | Microsoft Docs description: Shows a detailed cost analysis performance benefits about using Azure NetApp Files for SQL Server deployment. -- Last updated 05/19/2021 |
| azure-netapp-files | Understand Guidelines Active Directory Domain Service Site | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-netapp-files/understand-guidelines-active-directory-domain-service-site.md | Azure NetApp Files supports identity-based authentication over SMB through the f * **Microsoft Entra Kerberos for hybrid identities**: Using Microsoft Entra ID for authenticating [hybrid user identities](../active-directory/hybrid/whatis-hybrid-identity.md) allows Microsoft Entra users to access Azure NetApp Files file shares using Kerberos authentication. This means your end users can access Azure NetApp Files file shares without requiring a line-of-sight to domain controllers from Microsoft Entra hybrid joined and Microsoft Entra joined Windows or Linux virtual machines. *Cloud-only identities aren't currently supported.* * **AD Kerberos authentication for Linux clients**: Linux clients can use Kerberos authentication over SMB for Azure NetApp Files using AD DS. - ### <a name="network-requirements"></a>Network requirements Azure NetApp Files SMB, dual-protocol, and Kerberos NFSv4.1 volumes require reliable and low-latency network connectivity (less than 10 ms RTT) to AD DS domain controllers. Poor network connectivity or high network latency between Azure NetApp Files and AD DS domain controllers can cause client access interruptions or client timeouts. |
| azure-relay | Relay Migrate Acs Sas | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-relay/relay-migrate-acs-sas.md | - Title: Azure Relay - Migrate to Shared Access Signature authorization -description: Describes how to migrate Azure Relay applications from using Microsoft Entra ID Access Control Service to Shared Access Signature authorization. - Previously updated : 08/10/2023---# Azure Relay - Migrate from Microsoft Entra ID Access Control Service to Shared Access Signature authorization --Azure Relay applications historically had a choice of using two different authorization models: the [Shared Access Signature (SAS)](../service-bus-messaging/service-bus-sas.md) token model provided directly by the Relay service, and a federated model where the management of authorization rules is managed inside by the [Microsoft Entra ID](../active-directory/index.yml) Access Control Service (ACS), and tokens obtained from ACS are passed to Relay for authorizing access to the desired features. --The ACS authorization model has long been superseded by [SAS authorization](../service-bus-messaging/service-bus-authentication-and-authorization.md) as the preferred model, and all documentation, guidance, and samples exclusively use SAS today. Moreover, it's no longer possible to create new Relay namespaces that are paired with ACS. --SAS has the advantage in that it isn't immediately dependent on another service, but can be used directly from a client without any intermediaries by giving the client access to the SAS rule name and rule key. SAS can also be easily integrated with an approach in which a client has to first pass an authorization check with another service and then is issued a token. The latter approach is similar to the ACS usage pattern, but enables issuing access tokens based on application-specific conditions that are difficult to express in ACS. --For all existing applications that are dependent on ACS, we urge customers to migrate their applications to rely on SAS instead. --## Migration scenarios --ACS and Relay are integrated through the shared knowledge of a *signing key*. The signing key is used by an ACS namespace to sign authorization tokens, and it's used by Azure Relay to verify that the token has been issued by the paired ACS namespace. The ACS namespace holds service identities and authorization rules. The authorization rules define which service identity or which token issued by an external identity provider gets which type of access to a part of the Relay namespace graph, in the form of a longest-prefix match. --For example, an ACS rule might grant the **Send** claim on the path prefix `/` to a service identity, which means that a token issued by ACS based on that rule grants the client rights to send to all entities in the namespace. If the path prefix is `/abc`, the identity is restricted to sending to entities named `abc` or organized beneath that prefix. It's assumed that readers of this migration guidance are already familiar with these concepts. --The migration scenarios fall into three broad categories: --1. **Unchanged defaults**. Some customers use a [SharedSecretTokenProvider](/dotnet/api/microsoft.servicebus.sharedsecrettokenprovider) object, passing the automatically generated **owner** service identity and its secret key for the ACS namespace, paired with the Relay namespace, and don't add new rules. --2. **Custom service identities with simple rules**. Some customers add new service identities and grant each new service identity **Send**, **Listen**, and **Manage** permissions for one specific entity. --3. **Custom service identities with complex rules**. Very few customers have complex rule sets in which externally issued tokens are mapped to rights on Relay, or where a single service identity is assigned differentiated rights on several namespace paths through multiple rules. --For assistance with the migration of complex rule sets, you can contact [Azure support](https://azure.microsoft.com/support/options/). The other two scenarios enable straightforward migration. --### Unchanged defaults --If your application hasn't changed ACS defaults, you can replace all [SharedSecretTokenProvider](/dotnet/api/microsoft.servicebus.sharedsecrettokenprovider) usage with a [SharedAccessSignatureTokenProvider](/dotnet/api/microsoft.servicebus.sharedaccesssignaturetokenprovider) object, and use the namespace preconfigured **RootManageSharedAccessKey** instead of the ACS **owner** account. Note that even with the ACS **owner** account, this configuration was (and still is) not generally recommended, because this account/rule provides full management authority over the namespace, including permission to delete any entities. --### Simple rules --If the application uses custom service identities with simple rules, the migration is straightforward in the case where an ACS service identity was created to provide access control on a specific relay. This scenario is often the case in SaaS-style solutions where each relay is used as a bridge to a tenant site or branch office, and the service identity is created for that particular site. In this case, the respective service identity can be migrated to a Shared Access Signature rule, directly on the relay. The service identity name can become the SAS rule name and the service identity key can become the SAS rule key. The rights of the SAS rule are then configured equivalent to the respectively applicable ACS rule for the entity. --You can make this new and additional configuration of SAS in-place on any existing namespace that is federated with ACS, and the migration away from ACS is subsequently performed by using [SharedAccessSignatureTokenProvider](/dotnet/api/microsoft.servicebus.sharedaccesssignaturetokenprovider) instead of [SharedSecretTokenProvider](/dotnet/api/microsoft.servicebus.sharedsecrettokenprovider). The namespace doesn't need to be unlinked from ACS. --### Complex rules --SAS rules aren't meant to be accounts, but are named signing keys associated with rights. As such, scenarios in which the application creates many service identities and grants them access rights for several entities or the whole namespace still require a token-issuing intermediary. You can obtain guidance for such an intermediary by [contacting support](https://azure.microsoft.com/support/options/). --## Next steps --To learn more about Azure Relay authentication, see the following articles: --* [Azure Relay authentication and authorization](relay-authentication-and-authorization.md) -* [Service Bus authentication with Shared Access Signatures](../service-bus-messaging/service-bus-sas.md) |
| azure-resource-manager | Bicep Functions Date | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-resource-manager/bicep/bicep-functions-date.md | Title: Bicep functions - date description: Describes the functions to use in a Bicep file to work with dates. Previously updated : 11/03/2023 Last updated : 01/17/2024 # Date functions for Bicep The datetime value that results from adding the duration value to the base value ### Remarks -The dateTimeAdd function takes into account leap years and the number of days in a month when performing date arithmetic. The following example adds one month to January 31: +The `dateTimeAdd` function doesn't take leap years into consideration, and _P1Y_ should be interpreted as _P365D_, while _P1M_ should be interpreted as _P30D_. The following Bicep file shows some examples: ```bicep-output add1MonthOutput string = dateTimeAdd('2023-01-31 00:00:00Z', 'P1M') //2023-03-02T00:00:00Z -output add1MonthLeapOutput string = dateTimeAdd('2024-01-31 00:00:00Z', 'P1M') //2024-03-01T00:00:00Z +output addOneYearNonLeap string = dateTimeAdd('2023-01-01 00:00:00Z', 'P1Y') //2024-01-01T00:00:00Z +output addOneYearLeap string = dateTimeAdd('2024-01-01 00:00:00Z', 'P1Y') //2024-12-31T00:00:00Z ++output addOneMonthNonLeap string = dateTimeAdd('2023-02-01 00:00:00Z', 'P1M') //2023-03-03T00:00:00Z +output addOneMonthLeap string = dateTimeAdd('2024-02-01 00:00:00Z', 'P1M') //2023-03-02T00:00:00Z ``` -In this example, `dateTimeAdd` returns `2023-03-02T00:00:00Z`, not `2023-02-28T00:00:00Z`. If the base is `2024-01-31 00:00:00Z`, it returns `2024-03-01T00:00:00Z` because 2024 is a leap year. +In the preceding example, considering 2023 as a non-leap year, the outcome of adding one year to the initial day of the year is _2024-01-01T00:00:00Z_. Conversely, adding one year to the starting day of 2024, a leap year, results in _2024-12-31T00:00:00Z_, not _2025-01-01T00:00:00Z_, given that a leap year comprises 366 days instead of 365 days. Furthermore, the distinction between leap and non-leap years becomes apparent when adding one month to the first day of February, leading to varying day-of-the-month results. ### Examples |
| azure-resource-manager | Resource Name Rules | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-resource-manager/management/resource-name-rules.md | description: Shows the rules and restrictions for naming Azure resources. - Previously updated : 01/04/2024 Last updated : 01/19/2024 # Naming rules and restrictions for Azure resources |
| azure-resource-manager | Template Functions Date | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/azure-resource-manager/templates/template-functions-date.md | Title: Template functions - date description: Describes the functions to use in an Azure Resource Manager template (ARM template) to work with dates. Previously updated : 10/12/2023 Last updated : 01/17/2024 # Date functions for ARM templates The datetime value that results from adding the duration value to the base value ### Remarks -The dateTimeAdd function takes into account leap years and the number of days in a month when performing date arithmetic. The following example adds one month to January 31: +The `dateTimeAdd` function doesn't take leap years into consideration, and _P1Y_ should be interpreted as _P365D_, while _P1M_ should be interpreted as _P30D_. The following json shows some examples: ```json-"outputs": { - "add10YearsOutput": { - "type": "string", - "value": "[dateTimeAdd('2023-01-31 00:00:00Z', 'P1M')]" //2023-03-02T00:00:00Z - }, - "add1MonthOutput": { - "type": "string", - "value": "[dateTimeAdd('2024-01-31 00:00:00Z', 'P1M')]" //2024-03-01T00:00:00Z +{ + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "resources": [], + "outputs": { + "addOneYearNonLeap": { + "type": "string", + "value": "[dateTimeAdd('2023-01-01 00:00:00Z', 'P1Y')]" //2024-01-01T00:00:00Z + }, + "addOneYearLeap": { + "type": "string", + "value": "[dateTimeAdd('2024-01-01 00:00:00Z', 'P1Y')]" //2024-12-31T00:00:00Z + }, + "addOneMonthNonLeap": { + "type": "string", + "value": "[dateTimeAdd('2023-02-01 00:00:00Z', 'P1M')]" //2023-03-03T00:00:00Z + }, + "addOneMonthLeap": { + "type": "string", + "value": "[dateTimeAdd('2024-02-01 00:00:00Z', 'P1M')]" //2024-03-02T00:00:00Z + } } } ``` -In this example, `dateTimeAdd` returns `2023-03-02T00:00:00Z`, not `2023-02-28T00:00:00Z`. If the base is `2024-01-31 00:00:00Z`, it returns `2024-03-01T00:00:00Z` because 2024 is a leap year. +In the preceding example, considering 2023 as a non-leap year, the outcome of adding one year to the initial day of the year is _2024-01-01T00:00:00Z_. Conversely, adding one year to the starting day of 2024, a leap year, results in _2024-12-31T00:00:00Z_, not _2025-01-01T00:00:00Z_, given that a leap year comprises 366 days instead of 365 days. Furthermore, the distinction between leap and non-leap years becomes apparent when adding one month to the first day of February, leading to varying day-of-the-month results. ### Examples |
| chaos-studio | Chaos Studio Private Networking | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/chaos-studio/chaos-studio-private-networking.md | Currently, you can only enable certain resource types for Chaos Studio virtual n To use Chaos Studio with virtual network injection, you must meet the following requirements. 1. The `Microsoft.ContainerInstance` and `Microsoft.Relay` resource providers must be registered with your subscription. 1. The virtual network where Chaos Studio resources will be injected must have two subnets: a container subnet and a relay subnet. A container subnet is used for the Chaos Studio containers that will be injected into your private network. A relay subnet is used to forward communication from Chaos Studio to the containers inside the private network.- 1. Both subnets need at least `/27` in the address space. An example is an address prefix of `10.0.0.0/28` or `10.0.0.0/24`. + 1. Both subnets need at least `/28` for the size of the address space (in this case `/27` is larger than `/28`, for example). An example is an address prefix of `10.0.0.0/28` or `10.0.0.0/24`. 1. The container subnet must be delegated to `Microsoft.ContainerInstance/containerGroups`. 1. The subnets can be arbitrarily named, but we recommend `ChaosStudioContainerSubnet` and `ChaosStudioRelaySubnet`. 1. When you enable the desired resource as a target so that you can use it in Chaos Studio experiments, the following properties must be set: |
| chaos-studio | Chaos Studio Private Networking | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/cloud-services-php-create-web-role.md | documentationcenter: php ms.assetid: 9f7ccda0-bd96-4f7b-a7af-fb279a9e975b - ms.devlang: php Last updated 04/11/2018 |
| communication-services | Classification Concepts | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/communication-services/concepts/router/classification-concepts.md | The process of classifying a Job involves optionally setting the following prope - Worker Selectors - Queue ID +## Fallback queue ++The fallback queue is used when queue selectors, resulting from queue selector attachments, are unable to select a queue _and_ the job does not have a `queueId`. In this case, if the fallback queue is defined, the job is assigned to it. + ## Prioritization rule The priority of a Job can be resolved during classification using one of many rule engines. |
| container-apps | Tutorial Ci Cd Runners Jobs | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/container-apps/tutorial-ci-cd-runners-jobs.md | You can now create a job that uses to use the container image. In this section, az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" \ --trigger-type Event \ --replica-timeout 1800 \- --replica-retry-limit 1 \ + --replica-retry-limit 0 \ --replica-completion-count 1 \ --parallelism 1 \ --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" \ You can now create a job that uses to use the container image. In this section, --polling-interval 30 \ --scale-rule-name "github-runner" \ --scale-rule-type "github-runner" \- --scale-rule-metadata "github-runner=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" \ + --scale-rule-metadata "githubAPIURL=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" \ --scale-rule-auth "personalAccessToken=personal-access-token" \ --cpu "2.0" \ --memory "4Gi" \ You can now create a job that uses to use the container image. In this section, --polling-interval 30 ` --scale-rule-name "github-runner" ` --scale-rule-type "github-runner" `- --scale-rule-metadata "github-runner=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" ` + --scale-rule-metadata "githubAPIURL=https://api.github.com" "owner=$REPO_OWNER" "runnerScope=repo" "repos=$REPO_NAME" "targetWorkflowQueueLength=1" ` --scale-rule-auth "personalAccessToken=personal-access-token" ` --cpu "2.0" ` --memory "4Gi" ` You can now create a job that uses to use the container image. In this section, | `--polling-interval` | The polling interval at which to evaluate the scale rule. | | `--scale-rule-name` | The name of the scale rule. | | `--scale-rule-type` | The type of scale rule to use. To learn more about the GitHub runner scaler, see the KEDA [documentation](https://keda.sh/docs/latest/scalers/github-runner/). |- | `--scale-rule-metadata` | The metadata for the scale rule. | + | `--scale-rule-metadata` | The metadata for the scale rule. If you're using GitHub Enterprise, update `githubAPIURL` with its API URL. | | `--scale-rule-auth` | The authentication for the scale rule. | | `--secrets` | The secrets to use for the job. | | `--env-vars` | The environment variables to use for the job. | You can run a manual job to register an offline placeholder agent. The job runs az containerapp job create -n "$PLACEHOLDER_JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" ` --trigger-type Manual ` --replica-timeout 300 `- --replica-retry-limit 1 ` + --replica-retry-limit 0 ` --replica-completion-count 1 ` --parallelism 1 ` --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" ` Now that you have a placeholder agent, you can create a self-hosted agent. In th az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" \ --trigger-type Event \ --replica-timeout 1800 \- --replica-retry-limit 1 \ + --replica-retry-limit 0 \ --replica-completion-count 1 \ --parallelism 1 \ --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" \ az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$E az containerapp job create -n "$JOB_NAME" -g "$RESOURCE_GROUP" --environment "$ENVIRONMENT" ` --trigger-type Event ` --replica-timeout 1800 `- --replica-retry-limit 1 ` + --replica-retry-limit 0 ` --replica-completion-count 1 ` --parallelism 1 ` --image "$CONTAINER_REGISTRY_NAME.azurecr.io/$CONTAINER_IMAGE_NAME" ` |
| cosmos-db | Network Bandwidth | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/cosmos-db/network-bandwidth.md | + + Title: Network bandwidth ++description: Review how Azure Cosmos DB ingress and egress operations influence Azure network bandwidth consumption. +++++ Last updated : 01/19/2024+++# Azure Cosmos DB network bandwidth ++Azure Cosmos DB is a globally distributed database system that allows you to read and write data from the local replicas of your database. Azure Cosmos DB transparently replicates the data to all the regions associated with your Azure Cosmos DB account. ++To move your database requests and responses between the Cosmos DB account and the application, which connects it requires Azure network bandwidth. Cosmos DB also uses Azure network bandwidth to replicate data between Cosmos DB regions when you select multiple regions for your Cosmos DB account. ++Azure Cosmos DB bills for data that leaves the Azure cloud to any destination on the internet or transits the Azure WAN between Azure regions. ++| Data Transfer In (Ingress) | All GB / Month | +| | | +| Data transfer into any region  | Not billed | +| Data transfer within any region | Not billed | +| Data transfer within an availability zone or between availability zones within any region | Not billed | ++| Data Transfer Out (Egress)  | First 5 GB / Month  | > 5 GB / Month  | +| | | | +| Data transfer from any region in Europe or North America to any other regions or any destination on the internet | Not billed | Billed  | +| Data transfer from any region in Asia or Oceania or Middle East and Africa to any other region or any destination on the internet (excluding China) | Not billed | Billed  | +| Data transfer from any region in South America to any other region within the same continent or across continents or any destination on the internet | Not billed | Billed  | +| Data transfer from any region in China to any other region within the same continent or across continents or any destination on the internet | Not billed | Billed  | ++## Billing meter details ++The following are the recently introduced Azure Cosmos DB Bandwidth billing meter details along with the previous meter identifiers from which Azure Cosmos DB Bandwidth moved. ++| New Meter Name  | New Meter Type  | New Meter ID | Previous Meter ID | +| | | | | +| Inter Region Data Transfer In | Data Transfer In (GB) | 415e7499-ea3b-5b45-8a9c-80a141aa262 | d8831a85-697a-4d43-acec-8e1599f58b5d  | +| Inter Region Data Transfer In | Data Transfer In (GB) | ffa692fd-9d68-5f7c-a4b3-2644fe8ddb4 | 3a9d164b-d3c1-4350-9945-fa8056700299  | +| Inter Region Data Transfer In | Data Transfer In (GB) | adae3632-6f0c-5bc0-b864-b6a7b437438 | 32c3ebec-1646-49e3-8127-2cafbd3a04d8  | +| Inter Region Data Transfer In | Data Transfer In (GB) | b25ed7ec-9731-59f1-a0fb-d3327646847 | 42bb05e1-6f42-4de1-a6ba-7ffb976cb56  | +| Inter Region Data Transfer In | Data Transfer In (GB) | 8f44fdc5-8992-5838-b309-8a101b97576 | e315c24e-2f54-4668-95ae-5aef18f93125  | +| Inter Region Data Transfer Out | Data Transfer Out (GB) | 475ec5dc-3ce0-526d-a38f-0868db1a8fb | 3730eb6d-75a1-4e4b-82a2-383264ebffd8  | +| Inter Region Data Transfer Out | Data Transfer Out (GB) | 08339433-af53-57f7-87ee-22a39c0f35c | 6c5c3140-e894-4ecf-aacc-60137b0bc93b  | +| Inter Region Data Transfer Out | Data Transfer Out (GB) | dffc0580-fe39-515f-86af-7a5cf75b74d | 9995d93a-7d35-4d3f-9c69-7a7fea447ef4  | +| Inter Region Data Transfer Out | Data Transfer Out (GB) | 722e5945-90e6-59b3-8ed2-412d73c3984 | fe167397-a38d-43c3-9bb3-8e2907e56a41  | +| Inter Region Data Transfer Out | Data Transfer Out (GB) | dc9930dd-f096-5af1-8467-ba15cf7232d | c089a13a-9dd0-44b5-aa9e-44a77bbd6788  | ++## Frequently asked questions ++Here's a list of commonly asked questions for this service. ++- **Will the change to new Meters cost me more for Azure Cosmos DB bandwidth?** ++ - No, whilst the new meters are no longer tiered, the new meter billing rate is equal to or lower than the least expensive tier of the previous meters. Most Cosmos DB accounts see a reduction in Azure Cosmos DB bandwidth costs.  ++- **Do I get any network bandwidth every month at no cost?** ++ - Yes, Azure Cosmos DB includes 5 GB of network bandwidth per month. ++- **Will I still see the previous meters on my bill after Azure Cosmos DB moves to the new meters?** ++ - It depends, you could continue to see previous meters on your Azure bill as they continue to be used by some other Azure Services. You could see Azure Cosmos DB bandwidth billing disabled for a short period during the transition. You aren't double charged during the transition. ++- **Will a region failover impact my egress data?** ++ - It can, when your Azure Cosmos DB account is failed over to new region all traffic is automatically redirected to this new region. If this region is now different from where your Azure Cosmos DB client is located it results in data egress between the regions. ++## Next step ++> [!div class="nextstepaction"] +> [If you have additional questions or feedback on Cosmos DB networking](mailto:CosmosDBNetworking@Microsoft.com)  |
| data-factory | Connector Mysql | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/data-factory/connector-mysql.md | When copying data from MySQL, the following mappings are used from MySQL data ty | `int unsigned` |`Int64`| | `integer` |`Int32` | | `integer unsigned` |`Int64` |+| `json` |`String` | | `long varbinary` |`Byte[]` | | `long varchar` |`String` | | `longblob` |`Byte[]` | |
| dev-box | Quickstart Create Dev Box | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/dev-box/quickstart-create-dev-box.md | To create a dev box in the Microsoft Dev Box developer portal: ||| | **Name** | Enter a name for your dev box. Dev box names must be unique within a project. | | **Project** | Select a project from the dropdown list. |- | **Dev box pool** | Select a pool from the dropdown list, which includes all the dev box pools for that project. | + | **Dev box pool** | Select a pool from the dropdown list, which includes all the dev box pools for that project. Choose a dev box pool near to you for least latency.| :::image type="content" source="./media/quickstart-create-dev-box/create-dev-box.png" alt-text="Screenshot of the dialog for adding a dev box."::: |
| dms | Known Issues Azure Sql Migration Azure Data Studio | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/dms/known-issues-azure-sql-migration-azure-data-studio.md | This article provides a list of known issues and troubleshooting steps associate - **Recommendation**: Make sure to change the target Azure SQL Database collation to the same as the source SQL Server database. Azure SQL Database uses `SQL_Latin1_General_CP1_CI_AS` collation by default, in case your source SQL Server database uses a different collation you might need to re-create or select a different target database whose collation matches. For more information, see [Collation and Unicode support](/sql/relational-databases/collations/collation-and-unicode-support) +- **Message**: `TableColumnCollationMismatch: Table <Tablename> with column <columnname> has collation <collationoptionsource> on source but has collation <collationoptiontarget> on target table.` ++- **Cause**: The source database table column's collation isn't the same as the target database table column's collation. ++- **Recommendation**: + 1) Make sure to migrate the Schema to target Azure SQL Database using Database Migration Service. Refer [blog](https://techcommunity.microsoft.com/t5/microsoft-data-migration-blog/public-preview-schema-migration-for-target-azure-sql-db/ba-p/3990463). + 2) Follow this [article](https://learn.microsoft.com/sql/relational-databases/collations/set-or-change-the-column-collation?) to manually change collation. + For more information, see [Collation and Unicode support](/sql/relational-databases/collations/collation-and-unicode-support) + - **Message**: `DatabaseSizeMoreThanMax: No tables were found in the target Azure SQL Database. Check if schema migration was completed beforehand.` - **Cause**: The selected tables for the migration don't exist in the target Azure SQL Database. |
| expressroute | Expressroute About Virtual Network Gateways | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/expressroute/expressroute-about-virtual-network-gateways.md | ErGwScale supports both zonal and zonal-redundant deployments in Azure availabil ErGwScale is available in preview in the following regions: * Australia East+* Canada Central +* East US +* East Asia * France Central+* Germany Central +* Germany West +* India Central * Italy North * North Europe * Norway East * Sweden Central * UAE North+* UK South * West US 3 ### Autoscaling vs. fixed scale unit |
| governance | First Query Go | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/governance/resource-graph/first-query-go.md | - Title: "Quickstart: Your first Go query" -description: In this quickstart, you follow the steps to enable the Resource Graph package for Go and run your first query. Previously updated : 07/09/2021----# Quickstart: Run your first Resource Graph query using Go --The first step to using Azure Resource Graph is to check that the required packages for Go are -installed. This quickstart walks you through the process of adding the packages to your Go -installation. --At the end of this process, you'll have added the packages to your Go installation and run your -first Resource Graph query. --## Prerequisites --If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/) account -before you begin. --## Add the Resource Graph package --To enable Go to query Azure Resource Graph, the package must be added. This package works wherever -Go can be used, including [bash on Windows 10](/windows/wsl/install-win10) or locally installed. --1. Check that the latest Go is installed (at least **1.14**). If it isn't yet installed, download it - at [Golang.org](https://go.dev/dl/). --1. Check that the latest Azure CLI is installed (at least **2.5.1**). If it isn't yet installed, see - [Install the Azure CLI](/cli/azure/install-azure-cli). -- > [!NOTE] - > Azure CLI is required to enable Go to use the `auth.NewAuthorizerFromCLI()` method in the - > following example. For information about other options, see - > [Azure SDK for Go - More authentication details](https://github.com/Azure/azure-sdk-for-go#more-authentication-details). --1. Authenticate through Azure CLI. -- ```azurecli - az login - ``` --1. In your Go environment of choice, install the required packages for Azure Resource Graph: -- ```bash - # Add the Resource Graph package for Go - go get -u github.com/Azure/azure-sdk-for-go/services/resourcegraph/mgmt/2021-03-01/resourcegraph -- # Add the Azure auth package for Go - go get -u github.com/Azure/go-autorest/autorest/azure/auth - ``` --## Run your first Resource Graph query --With the Go packages added to your environment of choice, it's time to try out a simple Resource -Graph query. The query returns the first five Azure resources with the **Name** and **Resource -Type** of each resource. --1. Create the Go application and save the following source as `argQuery.go`: -- ```go - package main -- import ( - "fmt" - "os" - "context" - "strconv" - arg "github.com/Azure/azure-sdk-for-go/services/resourcegraph/mgmt/2021-03-01/resourcegraph" - "github.com/Azure/go-autorest/autorest/azure/auth" - ) -- func main() { - // Get variables from command line arguments - var query = os.Args[1] - var subList = os.Args[2:] -- // Create and authorize a ResourceGraph client - argClient := arg.New() - authorizer, err := auth.NewAuthorizerFromCLI() - if err == nil { - argClient.Authorizer = authorizer - } else { - fmt.Printf(err.Error()) - } -- // Set options - RequestOptions := arg.QueryRequestOptions { - ResultFormat: "objectArray", - } -- // Create the query request - Request := arg.QueryRequest { - Subscriptions: &subList, - Query: &query, - Options: &RequestOptions, - } -- // Run the query and get the results - var results, queryErr = argClient.Resources(context.Background(), Request) - if queryErr == nil { - fmt.Printf("Resources found: " + strconv.FormatInt(*results.TotalRecords, 10) + "\n") - fmt.Printf("Results: " + fmt.Sprint(results.Data) + "\n") - } else { - fmt.Printf(queryErr.Error()) - } - } - ``` --1. Build the Go application: -- ```bash - go build argQuery.go - ``` --1. Run your first Azure Resource Graph query using the compiled Go application. Replace `<SubID>` - with your subscription ID: -- ```bash - argQuery "Resources | project name, type | limit 5" "<SubID>" - ``` -- > [!NOTE] - > As this query example does not provide a sort modifier such as `order by`, running this query - > multiple times is likely to yield a different set of resources per request. --1. Change the first parameter to `argQuery` and change the query to `order by` the **Name** - property. Replace `<SubID>` with your subscription ID: -- ```bash - argQuery "Resources | project name, type | limit 5 | order by name asc" "<SubID>" - ``` -- > [!NOTE] - > Just as with the first query, running this query multiple times is likely to yield a different - > set of resources per request. The order of the query commands is important. In this example, - > the `order by` comes after the `limit`. This command order first limits the query results and - > then orders them. --1. Change the first parameter to `argQuery` and change the query to first `order by` the **Name** - property and then `limit` to the top five results. Replace `<SubID>` with your subscription ID: -- ```bash - argQuery "Resources | project name, type | order by name asc | limit 5" "<SubID>" - ``` --When the final query is run several times, assuming that nothing in your environment is changing, -the results returned are consistent and ordered by the **Name** property, but still limited to the -top five results. --## Clean up resources --If you wish to remove the installed packages from your Go environment, you can do so by using -the following command: --```bash -# Remove the installed packages from the Go environment -go clean -i github.com/Azure/azure-sdk-for-go/services/resourcegraph/mgmt/2019-04-01/resourcegraph -go clean -i github.com/Azure/go-autorest/autorest/azure/auth -``` --## Next steps --In this quickstart, you've added the Resource Graph packages to your Go environment and run your -first query. To learn more about the Resource Graph language, continue to the query language details -page. --> [!div class="nextstepaction"] -> [Get more information about the query language](./concepts/query-language.md) |
| governance | First Query Java | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/governance/resource-graph/first-query-java.md | - Title: "Quickstart: Your first Java query" -description: In this quickstart, you follow the steps to enable the Resource Graph Maven packages for Java and run your first query. Previously updated : 07/09/2021----# Quickstart: Run your first Resource Graph query using Java --The first step to using Azure Resource Graph is to check that the required Maven packages for Java -are installed. This quickstart walks you through the process of adding the Maven packages to your -Java installation. --At the end of this process, you'll have added the Maven packages to your Java installation and run -your first Resource Graph query. --## Prerequisites --- An Azure subscription. If you don't have an Azure subscription, create a- [free](https://azure.microsoft.com/free/) account before you begin. --- Check that the latest Azure CLI is installed (at least **2.21.0**). If it isn't yet installed, see- [Install the Azure CLI](/cli/azure/install-azure-cli). -- > [!NOTE] - > Azure CLI is required to enable Azure SDK for Java to use the **CLI-based authentication** in - > the following examples. For information about other options, see - > [Azure Identity client library for Java](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/identity/azure-identity). --- The [Java Developer Kit](/azure/developer/java/fundamentals/java-support-on-azure), version- 8. --- [Apache Maven](https://maven.apache.org/), version 3.6 or above.--## Create the Resource Graph project --To enable Java to query Azure Resource Graph, create and configure a new application with Maven and -install the required Maven packages. --1. Initialize a new Java application named "argQuery" with a - [Maven archetype](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html): -- ```cmd - mvn -B archetype:generate -DarchetypeGroupId="org.apache.maven.archetypes" -DgroupId="com.Fabrikam" -DartifactId="argQuery" - ``` --1. Change directories into the new project folder `argQuery` and open `pom.xml` in your favorite - editor. Add the following `<dependency>` nodes under the existing `<dependencies>` node: -- ```xml - <dependency> - <groupId>com.azure</groupId> - <artifactId>azure-identity</artifactId> - <version>1.2.4</version> - </dependency> - <dependency> - <groupId>com.azure.resourcemanager</groupId> - <artifactId>azure-resourcemanager-resourcegraph</artifactId> - <version>1.0.0</version> - </dependency> - ``` --1. In the `pom.xml` file, add the following `<properties>` node under the base `<project>` node to - update the source and target versions: -- ```xml - <properties> - <maven.compiler.source>1.8</maven.compiler.source> - <maven.compiler.target>1.8</maven.compiler.target> - </properties> - ``` --1. In the `pom.xml` file, add the following `<build>` node under the base `<project>` node to - configure the goal and main class for the project to run. -- ```xml - <build> - <plugins> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>exec-maven-plugin</artifactId> - <version>1.2.1</version> - <executions> - <execution> - <goals> - <goal>java</goal> - </goals> - </execution> - </executions> - <configuration> - <mainClass>com.Fabrikam.App</mainClass> - </configuration> - </plugin> - </plugins> - </build> - ``` --1. Replace the default `App.java` in `\argQuery\src\main\java\com\Fabrikam` with the following code - and save the updated file: -- ```java - package com.Fabrikam; -- import java.util.Arrays; - import java.util.List; - import com.azure.core.management.AzureEnvironment; - import com.azure.core.management.profile.AzureProfile; - import com.azure.identity.DefaultAzureCredentialBuilder; - import com.azure.resourcemanager.resourcegraph.ResourceGraphManager; - import com.azure.resourcemanager.resourcegraph.models.QueryRequest; - import com.azure.resourcemanager.resourcegraph.models.QueryRequestOptions; - import com.azure.resourcemanager.resourcegraph.models.QueryResponse; - import com.azure.resourcemanager.resourcegraph.models.ResultFormat; -- public class App - { - public static void main( String[] args ) - { - List<String> listSubscriptionIds = Arrays.asList(args[0]); - String strQuery = args[1]; -- ResourceGraphManager manager = ResourceGraphManager.authenticate(new DefaultAzureCredentialBuilder().build(), new AzureProfile(AzureEnvironment.AZURE)); -- QueryRequest queryRequest = new QueryRequest() - .withSubscriptions(listSubscriptionIds) - .withQuery(strQuery); -- QueryResponse response = manager.resourceProviders().resources(queryRequest); -- System.out.println("Records: " + response.totalRecords()); - System.out.println("Data:\n" + response.data()); - } - } - ``` --1. Build the `argQuery` console application: -- ```bash - mvn package - ``` --## Run your first Resource Graph query --With the Java console application built, it's time to try out a simple Resource Graph query. The -query returns the first five Azure resources with the **Name** and **Resource Type** of each -resource. --In each call to `argQuery`, there are variables that are used that you need to replace with your own -values: --- `{subscriptionId}` - Replace with your subscription ID-- `{query}` - Replace with your Azure Resource Graph query--1. Use the Azure CLI to authenticate with `az login`. --1. Change directories to the `argQuery` project folder you created with the previous - `mvn -B archetype:generate` command. --1. Run your first Azure Resource Graph query using Maven to compile the console application and pass - the arguments. The `exec.args` property identifies arguments by spaces. To identify the query as - a single argument, we wrap it with single quotes (`'`). -- ```bash - mvn compile exec:java -Dexec.args "{subscriptionId} 'Resources | project name, type | limit 5'" - ``` -- > [!NOTE] - > As this query example doesn't provide a sort modifier such as `order by`, running this query - > multiple times is likely to yield a different set of resources per request. --1. Change the argument to `argQuery.exe` and change the query to `order by` the **Name** property: -- ```bash - mvn compile exec:java -Dexec.args "{subscriptionId} 'Resources | project name, type | limit 5 | order by name asc'" - ``` -- > [!NOTE] - > Just as with the first query, running this query multiple times is likely to yield a different - > set of resources per request. The order of the query commands is important. In this example, - > the `order by` comes after the `limit`. This command order first limits the query results and - > then orders them. --1. Change the final parameter to `argQuery.exe` and change the query to first `order by` the - **Name** property and then `limit` to the top five results: -- ```bash - mvn compile exec:java -Dexec.args "{subscriptionId} 'Resources | project name, type | order by name asc | limit 5'" - ``` --When the final query is run several times, assuming that nothing in your environment is changing, -the results returned are consistent and ordered by the **Name** property, but still limited to the -top five results. --## Clean up resources --If you wish to remove the Java console application and installed packages, you can do so by deleting -the `argQuery` project folder. --## Next steps --In this quickstart, you've created a Java console application with the required Resource Graph -packages and run your first query. To learn more about the Resource Graph language, continue to the -query language details page. --> [!div class="nextstepaction"] -> [Get more information about the query language](./concepts/query-language.md) |
| governance | First Query Javascript | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/governance/resource-graph/first-query-javascript.md | - Title: 'Quickstart: Your first JavaScript query' -description: In this quickstart, you follow the steps to enable the Resource Graph library for JavaScript and run your first query. Previously updated : 07/09/2021----# Quickstart: Run your first Resource Graph query using JavaScript --This quickstart walks you through the process of adding the libraries to your JavaScript -installation. The first step to using Azure Resource Graph is to initialize a JavaScript application -with the required libraries. --At the end of this process, you'll have added the libraries to your JavaScript installation and run -your first Resource Graph query. --## Prerequisites --- **Azure subscription**: If you don't have an Azure subscription, create a- [free](https://azure.microsoft.com/free/) account before you begin. --- **Node.js**: [Node.js](https://nodejs.org/) version 12 or higher is required.--## Application initialization --To enable JavaScript to query Azure Resource Graph, the environment must be configured. This setup -works wherever JavaScript can be used, including [bash on Windows 10](/windows/wsl/install-win10). --1. Initialize a new Node.js project by running the following command. -- ```bash - npm init -y - ``` --1. Add a reference to the yargs module. -- ```bash - npm install yargs - ``` --1. Add a reference to the Azure Resource Graph module. -- ```bash - npm install @azure/arm-resourcegraph - ``` --1. Add a reference to the Azure authentication library. -- ```bash - npm install @azure/identity - ``` -- > [!NOTE] - > Verify in _package.json_ `@azure/arm-resourcegraph` is version **4.2.1** or higher and - > `@azure/identity` is version **2.0.4** or higher. --## Query the Resource Graph --1. Create a new file named _index.js_ and enter the following code. -- ```javascript - const argv = require("yargs").argv; - const { DefaultAzureCredential } = require("@azure/identity"); - const { ResourceGraphClient } = require("@azure/arm-resourcegraph"); -- if (argv.query) { - const query = async () => { - const credentials = new DefaultAzureCredential(); - const client = new ResourceGraphClient(credentials); - const result = await client.resources( - { - query: argv.query - }, - { resultFormat: "table" } - ); - console.log("Records: " + result.totalRecords); - console.log(result.data); - }; -- query(); - } - ``` -- > [!NOTE] - > This code creates a tenant-based query. To limit the query to a - > [management group](../management-groups/overview.md) or subscription, define and add a - > [queryrequest](/javascript/api/@azure/arm-resourcegraph/queryrequest) to the `client.resources` - > call and specify either `managementGroups` or `subscriptions`. --1. Enter the following command in the terminal: -- ```bash - node index.js --query "Resources | project name, type | limit 5" - ``` -- > [!NOTE] - > As this query example doesn't provide a sort modifier such as `order by`, running this query - > multiple times is likely to yield a different set of resources per request. --1. Change the first parameter to `index.js` and change the query to `order by` the **Name** - property. -- ```bash - node index.js --query "Resources | project name, type | limit 5 | order by name asc" - ``` -- As the script attempts to authenticate, a message similar to the following message is displayed - in the terminal: -- > To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code FGB56WJUGK to authenticate. -- Once you authenticate in the browser, then the script continues to run. -- > [!NOTE] - > Just as with the first query, running this query multiple times is likely to yield a different - > set of resources per request. The order of the query commands is important. In this example, - > the `order by` comes after the `limit`. This command order first limits the query results and - > then orders them. --1. Change the first parameter to `index.js` and change the query to first `order by` the **Name** - property and then `limit` to the top five results. -- ```bash - node index.js --query "Resources | project name, type | order by name asc | limit 5" - ``` --When the final query is run several times, assuming that nothing in your environment is changing, -the results returned are consistent and ordered by the **Name** property, but still limited to the -top five results. --## Clean up resources --If you wish to remove the installed libraries from your application, run the following command. --```bash -npm uninstall @azure/arm-resourcegraph @azure/identity yargs -``` --## Next steps --In this quickstart, you've added the Resource Graph libraries to your JavaScript environment and run -your first query. To learn more about the Resource Graph language, continue to the query language -details page. --> [!div class="nextstepaction"] -> [Get more information about the query language](./concepts/query-language.md) |
| governance | First Query Python | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/governance/resource-graph/first-query-python.md | - Title: 'Quickstart: Your first Python query' -description: In this quickstart, you follow the steps to enable the Resource Graph library for Python and run your first query. Previously updated : 10/01/2021----# Quickstart: Run your first Resource Graph query using Python --The first step to using Azure Resource Graph is to check that the required libraries for Python are -installed. This quickstart walks you through the process of adding the libraries to your Python -installation. --At the end of this process, you'll have added the libraries to your Python installation and run your -first Resource Graph query. --## Prerequisites --If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/) account -before you begin. ---## Add the Resource Graph library --To enable Python to query Azure Resource Graph, the library must be added. This library works -wherever Python can be used, including [bash on Windows 10](/windows/wsl/install-win10) or locally -installed. --1. Check that the latest Python is installed (at least **3.8**). If it isn't yet installed, download - it at [Python.org](https://www.python.org/downloads/). --1. Check that the latest Azure CLI is installed (at least **2.5.1**). If it isn't yet installed, see - [Install the Azure CLI](/cli/azure/install-azure-cli). -- > [!NOTE] - > Azure CLI is required to enable Python to use the **CLI-based authentication** in the following - > examples. For information about other options, see - > [Authenticate using the Azure management libraries for Python](/azure/developer/python/sdk/authentication-overview). --1. Authenticate through Azure CLI. -- ```azurecli - az login - ``` --1. In your Python environment of choice, install the required libraries for Azure Resource Graph: -- ```bash - # Add the Resource Graph library for Python - pip install azure-mgmt-resourcegraph -- # Add the Resources library for Python - pip install azure-mgmt-resource -- # Add the CLI Core library for Python for authentication (development only!) - pip install azure-cli-core -- # Add the Azure identity library for Python - pip install azure.identity - ``` -- > [!NOTE] - > If Python is installed for all users, these commands must be run from an elevated console. --1. Validate that the libraries have been installed. `azure-mgmt-resourcegraph` should be **2.0.0** - or higher, `azure-mgmt-resource` should be **9.0.0** or higher, and `azure-cli-core` should be - **2.5.0** or higher. -- ```bash - # Check each installed library - pip show azure-mgmt-resourcegraph azure-mgmt-resource azure-cli-core azure.identity - ``` --## Run your first Resource Graph query --With the Python libraries added to your environment of choice, it's time to try out a simple -subscription-based Resource Graph query. The query returns the first five Azure resources with the -**Name** and **Resource Type** of each resource. To query by -[management group](../management-groups/overview.md), use the `management_groups` parameter with -`QueryRequest`. --1. Run your first Azure Resource Graph query using the installed libraries and the `resources` - method: -- ```python - # Import Azure Resource Graph library - import azure.mgmt.resourcegraph as arg -- # Import specific methods and models from other libraries - from azure.mgmt.resource import SubscriptionClient - from azure.identity import AzureCliCredential -- # Wrap all the work in a function - def getresources( strQuery ): - # Get your credentials from Azure CLI (development only!) and get your subscription list - credential = AzureCliCredential() - subsClient = SubscriptionClient(credential) - subsRaw = [] - for sub in subsClient.subscriptions.list(): - subsRaw.append(sub.as_dict()) - subsList = [] - for sub in subsRaw: - subsList.append(sub.get('subscription_id')) -- # Create Azure Resource Graph client and set options - argClient = arg.ResourceGraphClient(credential) - argQueryOptions = arg.models.QueryRequestOptions(result_format="objectArray") -- # Create query - argQuery = arg.models.QueryRequest(subscriptions=subsList, query=strQuery, options=argQueryOptions) -- # Run query - argResults = argClient.resources(argQuery) -- # Show Python object - print(argResults) -- getresources("Resources | project name, type | limit 5") - ``` -- > [!NOTE] - > As this query example does not provide a sort modifier such as `order by`, running this query - > multiple times is likely to yield a different set of resources per request. --1. Update the call to `getresources` and change the query to `order by` the **Name** property: -- ```python - getresources("Resources | project name, type | limit 5 | order by name asc") - ``` -- > [!NOTE] - > Just as with the first query, running this query multiple times is likely to yield a different - > set of resources per request. The order of the query commands is important. In this example, - > the `order by` comes after the `limit`. This command order first limits the query results and - > then orders them. --1. Update the call to `getresources` and change the query to first `order by` the **Name** property - and then `limit` to the top five results: -- ```python - getresources("Resources | project name, type | order by name asc | limit 5") - ``` --When the final query is run several times, assuming that nothing in your environment is changing, -the results returned are consistent and ordered by the **Name** property, but still limited to the -top five results. --## Clean up resources --If you wish to remove the installed libraries from your Python environment, you can do so by using -the following command: --```bash -# Remove the installed libraries from the Python environment -pip uninstall azure-mgmt-resourcegraph azure-mgmt-resource azure-cli-core azure.identity -``` --## Next steps --In this quickstart, you've added the Resource Graph libraries to your Python environment and run -your first query. To learn more about the Resource Graph language, continue to the query language -details page. --> [!div class="nextstepaction"] -> [Get more information about the query language](./concepts/query-language.md) |
| governance | First Query Ruby | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/governance/resource-graph/first-query-ruby.md | - Title: "Quickstart: Your first Ruby query" -description: In this quickstart, you follow the steps to enable the Resource Graph gem for Ruby and run your first query. Previously updated : 07/09/2021---# Quickstart: Run your first Resource Graph query using Ruby --The first step to using Azure Resource Graph is to check that the required gems for Ruby are -installed. This quickstart walks you through the process of adding the gems to your Ruby -installation. --At the end of this process, you'll have added the gems to your Ruby installation and run your first -Resource Graph query. --## Prerequisites --- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/)- account before you begin. -- An Azure service principal, including the _clientId_ and _clientSecret_.---## Create the Resource Graph project --To enable Ruby to query Azure Resource Graph, the gem must be added to the `Gemfile`. This gem works -wherever Ruby can be used, including with [Azure Cloud Shell](https://shell.azure.com), -[bash on Windows 10](/windows/wsl/install-win10), or locally installed. --1. Check that the latest Ruby is installed (at least **2.7.1**). If it isn't yet installed, download - it at [Ruby-Lang.org](https://www.ruby-lang.org/en/downloads/). --1. In your Ruby environment of choice, initialize a bundle in a new project folder: -- ```bash - # Initialize a bundle to create a new Gemfile - bundle init - ``` --1. Update your `Gemfile` with the gems needed for Azure Resource Graph. The updated file should look - similar to this example: -- ```file - # frozen_string_literal: true -- source "https://rubygems.org" -- git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } -- # gem "rails" - gem 'azure_mgmt_resourcegraph', '~> 0.17.2' - ``` --1. From the project folder, run `bundle install`. Confirm the gems were installed with - `bundle list`. --1. In the same project folder, create `argQuery.rb` with the following code and save the updated - file: -- ```ruby - #!/usr/bin/env ruby -- require 'azure_mgmt_resourcegraph' - ARG = Azure::ResourceGraph::Profiles::Latest::Mgmt -- # Get arguments and set options - options = { - tenant_id: ARGV[0], - client_id: ARGV[1], - client_secret: ARGV[2], - subscription_id: ARGV[3] - } -- # Create Resource Graph client from options - argClient = ARG::Client.new(options) -- # Create Resource Graph QueryRequest for subscription with query - query_request = ARGModels::QueryRequest.new.tap do |qr| - qr.subscriptions = [ARGV[3]] - qr.query = ARGV[4] - end -- # Get the resources from Resource Graph - response = argClient.resources(query_request) -- # Convert data to JSON and output - puts response.data.to_json - ``` --## Run your first Resource Graph query --With the Ruby script saved and ready to use, it's time to try out a simple Resource Graph query. The -query returns the first five Azure resources with the **Name** and **Resource Type** of each -resource. --In each call to `argQuery`, there are variables that are used that you need to replace with your own -values: --- `{tenantId}` - Replace with your tenant ID-- `{clientId}` - Replace with the client ID of your service principal-- `{clientSecret}` - Replace with the client secret of your service principal-- `{subscriptionId}` - Replace with your subscription ID--1. Change directories to the project folder where you created the `Gemfile` and `argClient.rb` - files. --1. Run your first Azure Resource Graph query using the gems and the `resources` method: -- ```bash - ruby argQuery.rb "{tenantId}" "{clientId}" "{clientSecret}" "{subscriptionId}" "Resources | project name, type | limit 5" - ``` -- > [!NOTE] - > As this query example does not provide a sort modifier such as `order by`, running this query - > multiple times is likely to yield a different set of resources per request. --1. Change the final parameter to `argQuery.rb` and change the query to `order by` the **Name** - property: -- ```bash - ruby argQuery.rb "{tenantId}" "{clientId}" "{clientSecret}" "{subscriptionId}" "Resources | project name, type | limit 5 | order by name asc" - ``` -- > [!NOTE] - > Just as with the first query, running this query multiple times is likely to yield a different - > set of resources per request. The order of the query commands is important. In this example, - > the `order by` comes after the `limit`. This command order first limits the query results and - > then orders them. --1. Change the final parameter to `argQuery.rb` and change the query to first `order by` the **Name** - property and then `limit` to the top five results: -- ```bash - ruby argQuery.rb "{tenantId}" "{clientId}" "{clientSecret}" "{subscriptionId}" "Resources | project name, type | order by name asc | limit 5" - ``` --When the final query is run several times, assuming that nothing in your environment is changing, -the results returned are consistent and ordered by the **Name** property, but still limited to the -top five results. --## Clean up resources --If you wish to remove the installed gems from your Ruby environment, you can do so by using -the following command: --```bash -# Remove the installed gems from the Ruby environment -gem uninstall azure_mgmt_resourcegraph -``` --> [!NOTE] -> The gem `azure_mgmt_resourcegraph` has dependencies such as `ms_rest` and `ms_rest_azure` that may -> have also been installed depending on your environment. You may uninstall these gems also if no -> longer needed. --## Next steps --In this quickstart, you've added the Resource Graph gems to your Ruby environment and run your first -query. To learn more about the Resource Graph language, continue to the query language details page. --> [!div class="nextstepaction"] -> [Get more information about the query language](./concepts/query-language.md) |
| hdinsight | Hdinsight Release Notes Archive | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/hdinsight/hdinsight-release-notes-archive.md | For workload specific versions, see * HDInsight 5.1 is now supported with ESP cluster. * Upgraded version of Ranger 2.3.0 and Oozie 5.2.1 are now part of HDInsight 5.1 * The Spark 3.3.1 (HDInsight 5.1) cluster comes with Hive Warehouse Connector (HWC) 2.1, which works together with the Interactive Query (HDInsight 5.1) cluster.+* Ubuntu 18.04 is supported under [ESM(Extended Security Maintenance)](https://techcommunity.microsoft.com/t5/linux-and-open-source-blog/canonical-ubuntu-18-04-lts-reaching-end-of-standard-support/ba-p/3822623) by the Azure Linux team for Azure HDInsight July 2023, release onwards. + > [!IMPORTANT] > This release addresses the following CVEs released by [MSRC](https://msrc.microsoft.com/update-guide/vulnerability) on August 8, 2023. The action is to update to the latest image **2307201242**. Customers are advised to plan accordingly. A minimum 4-core VM is required for Head Node to ensure the high availability an #### Cluster worker node provisioning change When 80% of the worker nodes are ready, the cluster enters **operational** stage. At this stage, customers can do all the data plane operations like running scripts and jobs. But customers can't do any control plane operation like scaling up/down. Only deletion is supported. -After the **operational** stage, the cluster waits another 60 minutes for the remaining 20% worker nodes. At the end of this 60 minute, the cluster moves to the **running** stage, even if all of worker nodes are still not available. Once a cluster enters the **running** stage, you can use it as normal. Both control plan operations like scaling up/down, and data plan operations like running scripts and jobs are accepted. If some of the requested worker nodes aren't available, the cluster will be marked as partial success. You are charged for the nodes that were deployed successfully. +After the **operational** stage, the cluster waits another 60 minutes for the remaining 20% worker nodes. At the end of this 60 minute period, the cluster moves to the **running** stage, even if all of worker nodes are still not available. Once a cluster enters the **running** stage, you can use it as normal. Both control plan operations like scaling up/down, and data plan operations like running scripts and jobs are accepted. If some of the requested worker nodes aren't available, the cluster will be marked as partial success. You are charged for the nodes that were deployed successfully. #### Create new service principal through HDInsight Previously, with cluster creation, customers can create a new service principal to access the connected ADLS Gen 1 account in Azure portal. Starting June 15, 2020, new service principal creation is not possible in the HDInsight creation workflow, only existing service principal is supported. See [Create Service Principal and Certificates using Azure Active Directory](../active-directory/develop/howto-create-service-principal-portal.md). |
| hdinsight | Hdinsight Release Notes | https://github.com/MicrosoftDocs/azure-docs/commits/main/articles/hdinsight/hdinsight-release-notes.md | description: Latest release notes for Azure HDInsight. Get development tips and Previously updated : 10/26/2023 Last updated : 01/18/2024 # Azure HDInsight release notes This article provides information about the **most recent** Azure HDInsight rele Azure HDInsight is one of the most popular services among enterprise customers for open-source analytics on Azure. Subscribe to the [HDInsight Release Notes](./subscribe-to-hdi-release-notes-repo.md) for up-to-date information on HDInsight and all HDInsight versions. -In this release HDI 5.1 version is moved to General Availability (GA) stage. To subscribe, click the “watch” button in the banner and watch out for [HDInsight Releases](https://github.com/Azure/HDInsight/releases). -## Release date: October 26, 2023 +## Release Information -This release applies to HDInsight 4.x and 5.x HDInsight release will be available to all regions over several days. This release is applicable for image number **2310140056**. [How to check the image number?](./view-hindsight-cluster-image-version.md) +### Release date: January 10, 2024 ++This hotfix release applies to HDInsight 4.x and 5.x versions. HDInsight release will be available to all regions over several days. This release is applicable for image number **2401030422**. [How to check the image number?](./view-hindsight-cluster-image-version.md) HDInsight uses safe deployment practices, which involve gradual region deployment. it might take up to 10 business days for a new release or a new version to be available in all regions. HDInsight uses safe deployment practices, which involve gradual region deploymen * HDInsight 5.0: Ubuntu 18.04.5 LTS Linux Kernel 5.4 * HDInsight 5.1: Ubuntu 18.04.5 LTS Linux Kernel 5.4 +> [!NOTE] +> Ubuntu 18.04 is supported under [Extended Security Maintenance(ESM)](https://techcommunity.microsoft.com/t5/linux-and-open-source-blog/canonical-ubuntu-18-04-lts-reaching-end-of-standard-support/ba-p/3822623) by the Azure Linux team for [Azure HDInsight July 2023](/azure/hdinsight/hdinsight-release-notes-archive#release-date-july-25-2023), release onwards. + For workload specific versions, see * [HDInsight 5.x component versions](./hdinsight-5x-component-versioning.md) * [HDInsight 4.x component versions](./hdinsight-40-component-versioning.md) -## What's new --* HDInsight announces the General availability of HDInsight 5.1 starting November 1, 2023. This release brings in a full stack refresh to the [open source components](./hdinsight-5x-component-versioning.md#open-source-components-available-with-hdinsight-5x) and the integrations from Microsoft. - * Latest Open Source Versions – [HDInsight 5.1](./hdinsight-5x-component-versioning.md) comes with the latest stable [open-source version](./hdinsight-5x-component-versioning.md#open-source-components-available-with-hdinsight-5x) available. Customers can benefit from all latest open source features, Microsoft performance improvements, and Bug fixes. - * Secure – The latest versions come with the most recent security fixes, both open-source security fixes and security improvements by Microsoft. - * Lower TCO – With performance enhancements customers can lower the operating cost, along with [enhanced autoscale](https://techcommunity.microsoft.com/t5/analytics-on-azure-blog/enhanced-autoscale-capabilities-in-hdinsight-clusters/ba-p/3811271). - -* Cluster permissions for secure storage - * Customers can specify (during cluster creation) whether a secure channel should be used for HDInsight c |