Skip to content

Commit d9c7e97

Browse files
authored
Merge pull request #283271 from MicrosoftDocs/main
8/1/2024 PM Publish
2 parents 0fab8b5 + 60a2446 commit d9c7e97

File tree

473 files changed

+3968
-2385
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

473 files changed

+3968
-2385
lines changed

.openpublishing.redirection.json

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"redirections": [
3+
{
4+
"source_path": "articles/network-watcher/connection-monitor-create-using-template.md",
5+
"redirect_url": "/previous-versions/azure/network-watcher/connection-monitor-create-using-template",
6+
"redirect_document_id": false
7+
},
38
{
49
"source_path": "articles/network-watcher/network-watcher-connectivity-rest.md",
510
"redirect_url": "/previous-versions/azure/network-watcher/network-watcher-connectivity-rest",
@@ -4896,9 +4901,21 @@
48964901
"redirect_document_id": false
48974902
},
48984903
{
4899-
"source_path_from_root":"/articles/container-registry/manual-regional-move.md",
4900-
"redirect_url":"/azure/operational-excellence/relocation-container-registry",
4901-
"redirect_document_id":false
4904+
"source_path_from_root": "/articles/load-balancer/tutorial-cross-region-cli.md",
4905+
"redirect_url": "/azure/virtual-network/ip-services/tutorial-cross-region-portal",
4906+
4907+
"redirect_document_id": false
4908+
},
4909+
{
4910+
"source_path_from_root": "/articles/load-balancer/tutorial-cross-region-powershell.md",
4911+
"redirect_url": "/azure/virtual-network/ip-services/tutorial-cross-region-portal",
4912+
4913+
"redirect_document_id": false
4914+
},
4915+
{
4916+
"source_path_from_root":"/articles/container-registry/manual-regional-move.md",
4917+
"redirect_url": "/azure/operational-excellence/relocation-container-registry",
4918+
"redirect_document_id":false
49024919
},
49034920
{
49044921
"source_path": "articles/data-catalog/data-catalog-developer-concepts.md",
@@ -5022,13 +5039,13 @@
50225039
},
50235040
{
50245041
"source_path_from_root": "/articles/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6-powershell.md",
5025-
"redirect_url": "/azure/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6--portal",
5042+
"redirect_url": "/azure/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6-portal",
50265043
"redirect_document_id": false
50275044
},
50285045
{
50295046
"source_path_from_root": "/articles/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6-cli.md",
5030-
"redirect_url": "/azure/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6--portal",
5047+
"redirect_url": "/azure/virtual-network/ip-services/create-custom-ip-address-prefix-ipv6-portal",
50315048
"redirect_document_id": false
5032-
}
5049+
}
50335050
]
50345051
}

articles/ai-services/TOC.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ items:
1616
- name: Create an Azure AI services resource
1717
href: multi-service-resource.md
1818
displayName: applied, cognitive, form
19-
- name: Create a new resource using Bicep
19+
- name: Create an Azure AI services resource using Bicep
2020
href: create-account-bicep.md
21-
- name: Create a new resource using an ARM template
21+
- name: Create an Azure AI services resource using an ARM template
2222
href: create-account-resource-manager-template.md
23-
- name: Create a new resource using Terraform
23+
- name: Create an Azure AI services resource using Terraform
2424
href: create-account-terraform.md
2525
- name: Concepts
2626
items:

articles/ai-services/authentication.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
title: Authentication in Azure AI services
33
titleSuffix: Azure AI services
44
description: "There are three ways to authenticate a request to an Azure AI services resource: a resource key, a bearer token, or a multi-service subscription. In this article, you'll learn about each method, and how to make a request."
5-
#services: cognitive-services
65
author: mgreenegit
76
manager: nitinme
87
ms.service: azure-ai-services
98
ms.custom: devx-track-azurepowershell
109
ms.topic: how-to
11-
ms.date: 08/30/2023
10+
ms.date: 8/1/2024
1211
ms.author: migreene
1312
---
1413

@@ -22,9 +21,9 @@ Each request to an Azure AI service must include an authentication header. This
2221

2322
## Prerequisites
2423

25-
Before you make a request, you need an Azure account and an Azure AI services subscription. If you already have an account, go ahead and skip to the next section. If you don't have an account, we have a guide to get you set up in minutes: [Create a multi-service resource](multi-service-resource.md?pivots=azportal).
24+
Before you make a request, you need an Azure account and an Azure AI services subscription. If you already have an account, go ahead and skip to the next section. If you don't have an account, we have a guide to get you set up in minutes: [Create an Azure AI services resource](multi-service-resource.md?pivots=azportal).
2625

27-
You can get your resource key from the [Azure portal](multi-service-resource.md?pivots=azportal#get-the-keys-for-your-resource) after [creating your account](https://azure.microsoft.com/free/cognitive-services/).
26+
Go to your resource in the Azure portal. The **Keys & Endpoint** section can be found in the **Resource Management** section. Copy your endpoint and access key as you'll need both for authenticating your API calls. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption.
2827

2928
## Authentication headers
3029

@@ -33,14 +32,14 @@ Let's quickly review the authentication headers available for use with Azure AI
3332
| Header | Description |
3433
|--------|-------------|
3534
| Ocp-Apim-Subscription-Key | Use this header to authenticate with a resource key for a specific service or a multi-service resource key. |
36-
| Ocp-Apim-Subscription-Region | This header is only required when using a multi-service resource key with the [Translator service](./Translator/reference/v3-0-reference.md). Use this header to specify the resource region. |
35+
| Ocp-Apim-Subscription-Region | This header is only required when using a multi-service resource key with the [Azure AI Translator service](./Translator/reference/v3-0-reference.md). Use this header to specify the resource region. |
3736
| Authorization | Use this header if you are using an access token. The steps to perform a token exchange are detailed in the following sections. The value provided follows this format: `Bearer <TOKEN>`. |
3837

3938
## Authenticate with a single-service resource key
4039

41-
The first option is to authenticate a request with a resource key for a specific service, like Translator. The keys are available in the Azure portal for each resource that you've created. To use a resource key to authenticate a request, it must be passed along as the `Ocp-Apim-Subscription-Key` header.
40+
The first option is to authenticate a request with a resource key for a specific service, like Azure AI Translator. The keys are available in the Azure portal for each resource that you've created. Go to your resource in the Azure portal. The **Keys & Endpoint** section can be found in the **Resource Management** section. Copy your endpoint and access key as you'll need both for authenticating your API calls. You can use either `KEY1` or `KEY2`. Always having two keys allows you to securely rotate and regenerate keys without causing a service disruption.
4241

43-
These sample requests demonstrate how to use the `Ocp-Apim-Subscription-Key` header. Keep in mind, when using this sample you'll need to include a valid resource key.
42+
To use a resource key to authenticate a request, it must be passed along as the `Ocp-Apim-Subscription-Key` header. This is a sample call to the Azure AI Translator service:
4443

4544
This is a sample call to the Translator service:
4645
```cURL
@@ -50,23 +49,19 @@ curl -X POST 'https://api.cognitive.microsofttranslator.com/translate?api-versio
5049
--data-raw '[{ "text": "How much for the cup of coffee?" }]' | json_pp
5150
```
5251

53-
The following video demonstrates using an Azure AI services key.
54-
5552
## Authenticate with a multi-service resource key
5653

5754
You can use a [multi-service](./multi-service-resource.md) resource key to authenticate requests. The main difference is that the multi-service resource key isn't tied to a specific service, rather, a single key can be used to authenticate requests for multiple Azure AI services. See [Azure AI services pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) for information about regional availability, supported features, and pricing.
5855

5956
The resource key is provided in each request as the `Ocp-Apim-Subscription-Key` header.
6057

61-
[![Multi-service resource key demonstration for Azure AI services](./media/index/single-key-demonstration-video.png)](https://www.youtube.com/watch?v=psHtA1p7Cas&feature=youtu.be)
62-
6358
### Supported regions
6459

65-
When using the [multi-service](./multi-service-resource.md) resource key to make a request to `api.cognitive.microsoft.com`, you must include the region in the URL. For example: `westus.api.cognitive.microsoft.com`.
60+
When using the [Azure AI services multi-service](./multi-service-resource.md) resource key to make a request to `api.cognitive.microsoft.com`, you must include the region in the URL. For example: `westus.api.cognitive.microsoft.com`.
6661

6762
When using a multi-service resource key with [Azure AI Translator](./translator/index.yml), you must specify the resource region with the `Ocp-Apim-Subscription-Region` header.
6863

69-
Multi-service authentication is supported in these regions:
64+
Multi-service resource authentication is supported in these regions:
7065

7166
- `australiaeast`
7267
- `brazilsouth`
@@ -93,7 +88,7 @@ Multi-service authentication is supported in these regions:
9388

9489
### Sample requests
9590

96-
This is a sample call to the Translator service:
91+
This is a sample call to the Azure AI Translator service:
9792

9893
```cURL
9994
curl -X POST 'https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&from=en&to=de' \
@@ -111,9 +106,6 @@ Some Azure AI services accept, and in some cases require, an access token. Curre
111106
* Speech Services: Speech to text API
112107
* Speech Services: Text to speech API
113108

114-
>[!NOTE]
115-
> QnA Maker also uses the Authorization header, but requires an endpoint key. For more information, see [QnA Maker: Get answer from knowledge base](./qnamaker/quickstarts/get-answer-from-knowledge-base-using-url-tool.md).
116-
117109
>[!WARNING]
118110
> The services that support access tokens may change over time, please check the API reference for a service before using this authentication method.
119111
@@ -151,7 +143,7 @@ These multi-service regions support token exchange:
151143
- `westus`
152144
- `westus2`
153145

154-
After you get an access token, you'll need to pass it in each request as the `Authorization` header. This is a sample call to the Translator service:
146+
After you get an access token, you'll need to pass it in each request as the `Authorization` header. This is a sample call to the Azure AI Translator service:
155147

156148
```cURL
157149
curl -X POST 'https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&from=en&to=de' \

articles/ai-services/autoscale.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ Yes, you can disable the autoscale feature through Azure portal or CLI and retur
6767

6868
Autoscale feature is available for the following services:
6969

70-
* [Azure AI services multi-key](./multi-service-resource.md?pivots=azportal)
7170
* [Azure AI Vision](computer-vision/index.yml)
7271
* [Language](language-service/overview.md) (only available for sentiment analysis, key phrase extraction, named entity recognition, and text analytics for health)
7372
* [Anomaly Detector](anomaly-detector/overview.md)

articles/ai-services/cognitive-services-container-support.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,7 @@ Azure AI containers provide the following set of Docker containers, each of whic
7474
| [Azure AI Vision][cv-containers] | **Read OCR** ([image](https://mcr.microsoft.com/product/azure-cognitive-services/vision/read/about)) | The Read OCR container allows you to extract printed and handwritten text from images and documents with support for JPEG, PNG, BMP, PDF, and TIFF file formats. For more information, see the [Read API documentation](./computer-vision/overview-ocr.md). | Generally Available. <br>This container can also [run in disconnected environments](containers/disconnected-containers.md). |
7575
| [Spatial Analysis][spa-containers] | **Spatial analysis** ([image](https://mcr.microsoft.com/product/azure-cognitive-services/vision/spatial-analysis/about)) | Analyzes real-time streaming video to understand spatial relationships between people, their movement, and interactions with objects in physical environments. | Preview |
7676

77-
<!--
78-
|[Personalizer](./personalizer/what-is-personalizer.md) |F0, S0|**Personalizer** ([image](https://go.microsoft.com/fwlink/?linkid=2083928&clcid=0x409))|Azure AI Personalizer is a cloud-based API service that allows you to choose the best experience to show to your users, learning from their real-time behavior.|
79-
-->
80-
81-
Additionally, some containers are supported in the Azure AI services [multi-service resource](multi-service-resource.md?pivots=azportal) offering. You can create one single Azure AI services All-In-One resource and use the same billing key across supported services for the following services:
77+
Additionally, some containers are supported in the [Azure AI services multi-service resource](multi-service-resource.md?pivots=azportal) offering. You can create one single Azure AI services resource and use the same billing key across supported services for the following services:
8278

8379
* Azure AI Vision
8480
* LUIS
@@ -117,9 +113,6 @@ Install and explore the functionality provided by containers in Azure AI service
117113
* [Language service containers][ta-containers]
118114
* [Translator containers][tr-containers]
119115

120-
<!--* [Personalizer containers](https://go.microsoft.com/fwlink/?linkid=2083928&clcid=0x409)
121-
-->
122-
123116
[ad-containers]: anomaly-Detector/anomaly-detector-container-howto.md
124117
[cv-containers]: computer-vision/computer-vision-how-to-install-containers.md
125118
[lu-containers]: luis/luis-container-howto.md

articles/ai-services/cognitive-services-data-loss-prevention.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Azure AI services data loss prevention capabilities allow customers to configure
1515

1616
## Prerequisites
1717

18-
- Before you make a request, you need an Azure account and an Azure AI services subscription. If you already have an account, go ahead and skip to the next section. If you don't have an account, we have a guide to get you set up in minutes: [Create a multi-service resource](multi-service-resource.md?pivots=azportal).
19-
- You can get your subscription key from the [Azure portal](multi-service-resource.md?pivots=azportal#get-the-keys-for-your-resource) after [creating your account](https://azure.microsoft.com/free/cognitive-services/).
18+
Before you make a request, you need an Azure account and an Azure AI services subscription. If you already have an account, go ahead and skip to the next section. If you don't have an account, we have a guide to get you set up in minutes: [Create an Azure AI services multi-service resource](multi-service-resource.md?pivots=azportal).
2019

2120
## Enabling data loss prevention
2221

@@ -43,14 +42,14 @@ There are two parts to enable data loss prevention. First, the resource property
4342
4443
```azurecli-interactive
4544
az rest -m get \
46-
-u /subscriptions/{subscription ID}}/resourceGroups/{resource group}/providers/Microsoft.CognitiveServices/accounts/{account name}?api-version=2021-04-30 \
45+
-u /subscriptions/{subscription ID}/resourceGroups/{resource group}/providers/Microsoft.CognitiveServices/accounts/{account name}?api-version=2021-04-30 \
4746
```
4847
4948
1. Configure the restrictOutboundNetworkAccess property and update the allowed FqdnList with the approved URLs
5049
5150
```azurecli-interactive
5251
az rest -m patch \
53-
-u /subscriptions/{subscription ID}}/resourceGroups/{resource group}/providers/Microsoft.CognitiveServices/accounts/{account name}?api-version=2021-04-30 \
52+
-u /subscriptions/{subscription ID}/resourceGroups/{resource group}/providers/Microsoft.CognitiveServices/accounts/{account name}?api-version=2021-04-30 \
5453
-b '{"properties": { "restrictOutboundNetworkAccess": true, "allowedFqdnList": [ "microsoft.com" ] }}'
5554
```
5655

0 commit comments

Comments
 (0)