Skip to content

Commit 291f97e

Browse files
authored
Merge pull request #220628 from laujan/36622-align-dt-qs-new-template
36622 align dt qs new template
2 parents d2a6f9d + f8e2110 commit 291f97e

32 files changed

+1051
-90
lines changed
3.59 KB
Loading
3.33 KB
Loading

articles/cognitive-services/.openpublishing.redirection.cognitive-services.json

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6014,7 +6014,26 @@
60146014
"source_path_from_root": "/articles/cognitive-services/Translator/custom-translator/unsupported-language-deployments.md",
60156015
"redirect_url": "/azure/cognitive-services/Translator/custom-translator/beginners-guide",
60166016
"redirect_document_id": false
6017+
},
6018+
{
6019+
"source_path_from_root": "/articles/cognitive-services/Translator/document-translation/get-started-with-document-translation.md",
6020+
"redirect_url": "/azure/cognitive-services/Translator/document-translation/quickstarts/get-started-with-rest-api",
6021+
"redirect_document_id": true
6022+
},
6023+
{
6024+
"source_path_from_root": "/articles/cognitive-services/Translator/document-translation/client-sdks.md",
6025+
"redirect_url": "/azure/cognitive-services/Translator/document-translation/how-to-guides/use-client-sdks",
6026+
"redirect_document_id": true
6027+
},
6028+
{
6029+
"source_path_from_root": "/articles/cognitive-services/Translator/document-translation/create-sas-tokens.md",
6030+
"redirect_url": "/azure/cognitive-services/Translator/document-translation/how-to-guides/create-sas-tokens",
6031+
"redirect_document_id": true
6032+
},
6033+
{
6034+
"source_path_from_root": "/articles/cognitive-services/Translator/document-translation/managed-identity.md",
6035+
"redirect_url": "/azure/cognitive-services/Translator/document-translation/how-to-guides/create-use-managed-identities",
6036+
"redirect_document_id": true
60176037
}
6018-
60196038
]
60206039
}

articles/cognitive-services/Translator/document-translation/create-sas-tokens.md renamed to articles/cognitive-services/Translator/document-translation/how-to-guides/create-sas-tokens.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.topic: how-to
55
manager: nitinme
66
ms.author: lajanuar
77
author: laujan
8-
ms.date: 05/27/2022
8+
ms.date: 12/17/2022
99
---
1010

1111
# Create SAS tokens for your storage containers
@@ -18,7 +18,7 @@ At a high level, here's how SAS tokens work:
1818

1919
* If the storage service verifies that the SAS is valid, the request is authorized.
2020

21-
* If the SAS token is deemed invalid, the request is declined and the error code 403 (Forbidden) is returned.
21+
* If the SAS token is deemed invalid, the request is declined, and the error code 403 (Forbidden) is returned.
2222

2323
Azure Blob Storage offers three resource types:
2424

@@ -42,14 +42,14 @@ To get started, you'll need the following resources:
4242

4343
* A **standard performance** [Azure Blob Storage account](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM). You'll create containers to store and organize your files within your storage account. If you don't know how to create an Azure storage account with a storage container, follow these quickstarts:
4444

45-
* [Create a storage account](../../../storage/common/storage-account-create.md). When you create your storage account, select **Standard** performance in the **Instance details** > **Performance** field.
46-
* [Create a container](../../../storage/blobs/storage-quickstart-blobs-portal.md#create-a-container). When you create your container, set **Public access level** to **Container** (anonymous read access for containers and files) in the **New Container** window.
45+
* [Create a storage account](../../../../storage/common/storage-account-create.md). When you create your storage account, select **Standard** performance in the **Instance details** > **Performance** field.
46+
* [Create a container](../../../../storage/blobs/storage-quickstart-blobs-portal.md#create-a-container). When you create your container, set **Public access level** to **Container** (anonymous read access for containers and files) in the **New Container** window.
4747

4848
## Create SAS tokens in the Azure portal
4949

5050
<!-- markdownlint-disable MD024 -->
5151

52-
Go to the [Azure portal](https://portal.azure.com/#home) and navigate to your container or a specific file as follows and continue with the steps below:
52+
Go to the [Azure portal](https://portal.azure.com/#home) and navigate to your container or a specific file as follows and continue with these steps:
5353

5454
| Create SAS token for a container| Create SAS token for a specific file|
5555
|:-----:|:-----:|
@@ -87,9 +87,9 @@ Go to the [Azure portal](https://portal.azure.com/#home) and navigate to your co
8787

8888
Azure Storage Explorer is a free standalone app that enables you to easily manage your Azure cloud storage resources from your desktop.
8989

90-
* You'll need the [**Azure Storage Explorer**](../../../vs-azure-tools-storage-manage-with-storage-explorer.md) app installed in your Windows, macOS, or Linux development environment.
90+
* You'll need the [**Azure Storage Explorer**](../../../../vs-azure-tools-storage-manage-with-storage-explorer.md) app installed in your Windows, macOS, or Linux development environment.
9191

92-
* After the Azure Storage Explorer app is installed, [connect it to the storage account](../../../vs-azure-tools-storage-manage-with-storage-explorer.md?tabs=windows#connect-to-a-storage-account-or-service) you're using for Document Translation. Follow the steps below to create tokens for a storage container or specific blob file:
92+
* After the Azure Storage Explorer app is installed, [connect it to the storage account](../../../../vs-azure-tools-storage-manage-with-storage-explorer.md?tabs=windows#connect-to-a-storage-account-or-service) you're using for Document Translation. Follow these steps to create tokens for a storage container or specific blob file:
9393

9494
### [SAS tokens for storage containers](#tab/Containers)
9595

@@ -141,7 +141,7 @@ You can include your SAS URL with REST API requests in two ways:
141141

142142
* Append the **SAS query string** to your existing sourceURL and targetURL values.
143143

144-
Here is a sample REST API request:
144+
Here's a sample REST API request:
145145

146146
```json
147147
{
@@ -171,5 +171,5 @@ That's it! You've learned how to create SAS tokens to authorize how clients acce
171171
## Next steps
172172

173173
> [!div class="nextstepaction"]
174-
> [Get Started with Document Translation](get-started-with-document-translation.md)
174+
> [Get Started with Document Translation](../quickstarts/get-started-with-rest-api.md)
175175
>

articles/cognitive-services/Translator/document-translation/managed-identity.md renamed to articles/cognitive-services/Translator/document-translation/how-to-guides/create-use-managed-identities.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: nitinme
77
ms.service: cognitive-services
88
ms.subservice: translator-text
99
ms.topic: how-to
10-
ms.date: 02/28/2022
10+
ms.date: 12/17/2022
1111
ms.author: lajanuar
1212
---
1313

@@ -24,7 +24,7 @@ Managed identities for Azure resources are service principals that create an Azu
2424

2525
* You can use managed identities to grant access to any resource that supports Azure AD authentication, including your own applications. Managed identities eliminate the need for you to include shared access signature tokens (SAS) with your HTTP requests.
2626

27-
* To grant access to an Azure resource, you'll assign an Azure role to a managed identity using [Azure role-based access control (Azure RBAC)](../../../role-based-access-control/overview.md).
27+
* To grant access to an Azure resource, you'll assign an Azure role to a managed identity using [Azure role-based access control (`Azure RBAC`)](../../../../role-based-access-control/overview.md).
2828

2929
* There's no added cost to use managed identities in Azure.
3030

@@ -34,29 +34,28 @@ Managed identities for Azure resources are service principals that create an Azu
3434
>
3535
> * Managed identities are a safer way to grant access to data without having SAS tokens included with your HTTP requests.
3636
37-
3837
## Prerequisites
3938
To get started, you'll need:
4039

4140
* An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/)—if you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/).
4241

43-
* A [**single-service Translator**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) (not a multi-service Cognitive Services) resource assigned to a **non-global** region. For detailed steps, _see_ [Create a Cognitive Services resource using the Azure portal](../../cognitive-services-apis-create-account.md?tabs=multiservice%2cwindows).
42+
* A [**single-service Translator**](https://portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation) (not a multi-service Cognitive Services) resource assigned to a **non-global** region. For detailed steps, _see_ [Create a Cognitive Services resource using the Azure portal](../../../cognitive-services-apis-create-account.md?tabs=multiservice%2cwindows).
4443

45-
* A brief understanding of [**Azure role-based access control (Azure RBAC)**](../../../role-based-access-control/role-assignments-portal.md) using the Azure portal.
44+
* A brief understanding of [**Azure role-based access control (`Azure RBAC`)**](../../../../role-based-access-control/role-assignments-portal.md) using the Azure portal.
4645

4746
* An [**Azure blob storage account**](https://portal.azure.com/#create/Microsoft.StorageAccount-ARM) in the same region as your Translator resource. You'll create containers to store and organize your blob data within your storage account.
4847

4948
* **If your storage account is behind a firewall, you must enable the following configuration**: </br>
5049

5150
* On your storage account page, select **Security + networking****Networking** from the left menu.
52-
:::image type="content" source="../media/managed-identities/security-and-networking-node.png" alt-text="Screenshot: security + networking tab.":::
51+
:::image type="content" source="../../media/managed-identities/security-and-networking-node.png" alt-text="Screenshot: security + networking tab.":::
5352

5453
* In the main window, select **Allow access from Selected networks**.
55-
:::image type="content" source="../media/managed-identities/firewalls-and-virtual-networks.png" alt-text="Screenshot: Selected networks radio button selected.":::
54+
:::image type="content" source="../../media/managed-identities/firewalls-and-virtual-networks.png" alt-text="Screenshot: Selected networks radio button selected.":::
5655

57-
* On the selected networks page, navigate to the **Exceptions** category and make certain that the [**Allow Azure services on the trusted services list to access this storage account**](../../../storage/common/storage-network-security.md?tabs=azure-portal#manage-exceptions) checkbox is enabled.
56+
* On the selected networks page, navigate to the **Exceptions** category and make certain that the [**Allow Azure services on the trusted services list to access this storage account**](../../../../storage/common/storage-network-security.md?tabs=azure-portal#manage-exceptions) checkbox is enabled.
5857

59-
:::image type="content" source="../media/managed-identities/allow-trusted-services-checkbox-portal-view.png" alt-text="Screenshot: allow trusted services checkbox, portal view":::
58+
:::image type="content" source="../../media/managed-identities/allow-trusted-services-checkbox-portal-view.png" alt-text="Screenshot: allow trusted services checkbox, portal view":::
6059

6160
## Managed identity assignments
6261

@@ -72,35 +71,35 @@ In the following steps, we'll enable a system-assigned managed identity and gran
7271

7372
>[!IMPORTANT]
7473
>
75-
> To enable a system-assigned managed identity, you need **Microsoft.Authorization/roleAssignments/write** permissions, such as [**Owner**](../../../role-based-access-control/built-in-roles.md#owner) or [**User Access Administrator**](../../../role-based-access-control/built-in-roles.md#user-access-administrator). You can specify a scope at four levels: management group, subscription, resource group, or resource.
74+
> To enable a system-assigned managed identity, you need **Microsoft.Authorization/roleAssignments/write** permissions, such as [**Owner**](../../../../role-based-access-control/built-in-roles.md#owner) or [**User Access Administrator**](../../../../role-based-access-control/built-in-roles.md#user-access-administrator). You can specify a scope at four levels: management group, subscription, resource group, or resource.
7675
7776
1. Sign in to the [Azure portal](https://portal.azure.com) using an account associated with your Azure subscription.
7877

7978
1. Navigate to your **Translator** resource page in the Azure portal.
8079

8180
1. In the left rail, select **Identity** from the **Resource Management** list:
8281

83-
:::image type="content" source="../media/managed-identities/resource-management-identity-tab.png" alt-text="Screenshot: resource management identity tab in the Azure portal.":::
82+
:::image type="content" source="../../media/managed-identities/resource-management-identity-tab.png" alt-text="Screenshot: resource management identity tab in the Azure portal.":::
8483

8584
1. In the main window, toggle the **System assigned Status** tab to **On**.
8685

8786
## Grant access to your storage account
8887

89-
You need to grant Translator access to your storage account before it can create, read, or delete blobs. Once you've enabled Translator with a system-assigned managed identity, you can use Azure role-based access control (Azure RBAC), to give Translator access to your Azure storage containers.
88+
You need to grant Translator access to your storage account before it can create, read, or delete blobs. Once you've enabled Translator with a system-assigned managed identity, you can use Azure role-based access control (`Azure RBAC`), to give Translator access to your Azure storage containers.
9089

9190
The **Storage Blob Data Contributor** role gives Translator (represented by the system-assigned managed identity) read, write, and delete access to the blob container and data.
9291

9392
1. Under **Permissions** select **Azure role assignments**:
9493

95-
:::image type="content" source="../media/managed-identities/enable-system-assigned-managed-identity-portal.png" alt-text="Screenshot: enable system-assigned managed identity in Azure portal.":::
94+
:::image type="content" source="../../media/managed-identities/enable-system-assigned-managed-identity-portal.png" alt-text="Screenshot: enable system-assigned managed identity in Azure portal.":::
9695

9796
1. An Azure role assignments page will open. Choose your subscription from the drop-down menu then select **&plus; Add role assignment**.
9897

99-
:::image type="content" source="../media/managed-identities/azure-role-assignments-page-portal.png" alt-text="Screenshot: Azure role assignments page in the Azure portal.":::
98+
:::image type="content" source="../../media/managed-identities/azure-role-assignments-page-portal.png" alt-text="Screenshot: Azure role assignments page in the Azure portal.":::
10099

101100
>[!NOTE]
102101
>
103-
> If you are unable to assign a role in the Azure portal because the Add > Add role assignment option is disabled or get the permissions error, "you do not have permissions to add role assignment at this scope", check that you are currently signed in as a user with an assigned a role that has Microsoft.Authorization/roleAssignments/write permissions such as [**Owner**](../../../role-based-access-control/built-in-roles.md#owner) or [**User Access Administrator**](../../../role-based-access-control/built-in-roles.md#user-access-administrator) at the storage scope for the storage resource.
102+
> If you are unable to assign a role in the Azure portal because the Add > Add role assignment option is disabled or get the permissions error, "you do not have permissions to add role assignment at this scope", check that you are currently signed in as a user with an assigned a role that has Microsoft.Authorization/roleAssignments/write permissions such as [**Owner**](../../../../role-based-access-control/built-in-roles.md#owner) or [**User Access Administrator**](../../../../role-based-access-control/built-in-roles.md#user-access-administrator) at the storage scope for the storage resource.
104103
105104
1. Next, you're going to assign a **Storage Blob Data Contributor** role to your Translator service resource. In the **Add role assignment** pop-up window, complete the fields as follows and select **Save**:
106105

@@ -111,21 +110,21 @@ The **Storage Blob Data Contributor** role gives Translator (represented by the
111110
|**Resource**| **_The name of your storage resource_**.|
112111
|**Role** | **_Storage Blob Data Contributor_**.|
113112

114-
:::image type="content" source="../media/managed-identities/add-role-assignment-window.png" alt-text="Screenshot: add role assignments page in the Azure portal.":::
113+
:::image type="content" source="../../media/managed-identities/add-role-assignment-window.png" alt-text="Screenshot: add role assignments page in the Azure portal.":::
115114

116115
1. After you've received the _Added Role assignment_ confirmation message, refresh the page to see the added role assignment.
117116

118-
:::image type="content" source="../media/managed-identities/add-role-assignment-confirmation.png" alt-text="Screenshot: Added role assignment confirmation pop-up message.":::
117+
:::image type="content" source="../../media/managed-identities/add-role-assignment-confirmation.png" alt-text="Screenshot: Added role assignment confirmation pop-up message.":::
119118

120119
1. If you don't see the change right away, wait and try refreshing the page once more. When you assign or remove role assignments, it can take up to 30 minutes for changes to take effect.
121120

122-
:::image type="content" source="../media/managed-identities/assigned-roles-window.png" alt-text="Screenshot: Azure role assignments window.":::
121+
:::image type="content" source="../../media/managed-identities/assigned-roles-window.png" alt-text="Screenshot: Azure role assignments window.":::
123122

124123
## HTTP requests
125124

126125
* A batch Document Translation request is submitted to your Translator service endpoint via a POST request.
127126

128-
* With managed identity and Azure RBAC, you'll no longer need to include SAS URLs.
127+
* With managed identity and `Azure RBAC`, you'll no longer need to include SAS URLs.
129128

130129
* If successful, the POST method returns a `202 Accepted` response code and the batch request is created by the service.
131130

@@ -177,7 +176,7 @@ The following headers are included with each Document Translation API request:
177176
### Translate a specific document in a container
178177

179178
* **Required**: "storageType": "File"
180-
* The sample request below shows a single document getting translated into two target languages
179+
* This sample request returns a single document translated into two target languages:
181180

182181
```json
183182
{
@@ -231,16 +230,16 @@ The following headers are included with each Document Translation API request:
231230
}
232231
```
233232

234-
Great! You've learned how to enable and use a system-assigned managed identity. With managed identity for Azure Resources and Azure RBAC, you granted Translator specific access rights to your storage resource without including SAS tokens with your HTTP requests.
233+
Great! You've learned how to enable and use a system-assigned managed identity. With managed identity for Azure Resources and `Azure RBAC`, you granted Translator specific access rights to your storage resource without including SAS tokens with your HTTP requests.
235234

236235
## Next steps
237236

238237
**Quickstart**
239238

240239
> [!div class="nextstepaction"]
241-
> [Get started with Document Translation](get-started-with-document-translation.md)
240+
> [Get started with Document Translation](../quickstarts/get-started-with-rest-api.md)
242241
243242
**Tutorial**
244243

245244
> [!div class="nextstepaction"]
246-
> [Access Azure Storage from a web app using managed identities](../../../app-service/scenario-secure-app-access-storage.md?bc=%2fazure%2fcognitive-services%2ftranslator%2fbreadcrumb%2ftoc.json&toc=%2fazure%2fcognitive-services%2ftranslator%2ftoc.json)
245+
> [Access Azure Storage from a web app using managed identities](../../../../app-service/scenario-secure-app-access-storage.md?bc=%2fazure%2fcognitive-services%2ftranslator%2fbreadcrumb%2ftoc.json&toc=%2fazure%2fcognitive-services%2ftranslator%2ftoc.json)

0 commit comments

Comments
 (0)