|
1 | 1 | ---
|
2 |
| -title: Tutorial - Customize metadata properties in Azure API Center (preview) | Microsoft Docs |
3 |
| -description: In this tutorial, define custom metadata properties in your API center. Use custom and built-in properties to organize your APIs. |
| 2 | +title: Tutorial - Define custom metadata for API governance |
| 3 | +description: In this tutorial, define custom metadata in your API center. Use custom and built-in metadata to organize and govern your APIs. |
4 | 4 | author: dlepow
|
5 | 5 | ms.service: api-center
|
6 | 6 | ms.topic: tutorial
|
7 |
| -ms.date: 11/07/2023 |
| 7 | +ms.date: 04/19/2024 |
8 | 8 | ms.author: danlep
|
| 9 | +#customer intent: As the owner of an Azure API center, I want a step by step introduction to configure custom metadata properties to govern my APIs. |
9 | 10 | ---
|
10 | 11 |
|
11 |
| -# Tutorial: Customize metadata properties |
| 12 | +# Tutorial: Define custom metadata |
12 | 13 |
|
13 |
| -In this tutorial, define custom properties to help you organize your APIs and other information in your API center. Use custom metadata properties and several built-in properties for search and filtering and to enforce governance standards in your organization. |
| 14 | +In this tutorial, define custom metadata to help you organize your APIs and other information in your API center. Use custom and built-in metadata for search and filtering and to enforce governance standards in your organization. |
14 | 15 |
|
15 |
| -For background information about the metadata schema in API Center, see [Key concepts](key-concepts.md). |
| 16 | +For background information about metadata in Azure API Center, see: |
| 17 | + |
| 18 | +* [Key concepts](key-concepts.md#metadata) |
| 19 | +* [Metadata for API governance](metadata.md) |
16 | 20 |
|
17 | 21 | In this tutorial, you learn how to use the portal to:
|
18 | 22 | > [!div class="checklist"]
|
19 |
| -> * Define custom metadata properties in your API center |
| 23 | +> * Define custom metadata in your API center |
20 | 24 | > * View the metadata schema
|
21 | 25 |
|
22 |
| -[!INCLUDE [api-center-preview-feedback](includes/api-center-preview-feedback.md)] |
23 |
| - |
24 | 26 | ## Prerequisites
|
25 | 27 |
|
26 | 28 | * An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](set-up-api-center.md).
|
27 | 29 |
|
28 |
| -## Define properties in the metadata schema |
| 30 | +## Define metadata |
29 | 31 |
|
30 |
| -You organize your API inventory by setting values of metadata properties. While several common properties such as "API type" and "Version lifecycle" are available out of the box, each API center provides a configurable metadata schema so you can add properties that are specific to your organization. |
| 32 | +Here you define two custom metadata examples: *Line of business* and *Public-facing*; if you prefer, define other metadata of your own. When you add or update APIs and other information in your inventory, you'll set values for custom and any common built-in metadata. |
31 | 33 |
|
32 |
| -Here you define two example properties: *Line of business* and *Public-facing*; if you prefer, define other properties of your own. When you add or update APIs and other information in your inventory, you'll set values for these properties and any common built-in properties. |
| 34 | +[!INCLUDE [metadata-sensitive-data](includes/metadata-sensitive-data.md)] |
33 | 35 |
|
34 |
| -> [!IMPORTANT] |
35 |
| -> Take care not to include any sensitive, confidential, or personal information in the titles (names) of metadata properties you define. These titles are visible in monitoring logs that are used by Microsoft to improve the functionality of the service. However, other metadata details and values are your protected customer data. |
| 36 | +1. In the [Azure portal](https://portal.azure.com), navigate to your API center. |
36 | 37 |
|
37 |
| -1. In the left menu, select **Metadata schema > + Add property**. |
| 38 | +1. In the left menu, under **Assets**, select **Metadata > + New metadata**. |
38 | 39 |
|
39 |
| -1. On the **Details** tab, enter information about the property. |
| 40 | +1. On the **Details** tab, enter information about the metadata. |
40 | 41 |
|
41 | 42 | 1. In **Title**, enter *Line of business*.
|
42 | 43 |
|
43 |
| - 1. Select type **Predefined choices** and enter choices such as *Marketing, Finance, IT, Sales*, and so on. Optionally enable **Allow selection of multiple values**. |
| 44 | + 1. Optionally, enter a **Description**. |
44 | 45 |
|
45 |
| - :::image type="content" source="media/add-metadata-properties/metadata-property-details.png" alt-text="Screenshot of metadata schema property in the portal."::: |
| 46 | + 1. Select type **Predefined choices** and enter choices such as *Marketing, Finance, IT, Sales*, and so on. Optionally enable **Allow selection of multiple values**. Select **Next**. |
46 | 47 |
|
47 |
| -1. On the **Assignments** tab, select **Required** for APIs. Select **Optional** for Deployments and Environments. (You'll add these entities in later tutorials.) |
| 48 | + :::image type="content" source="media/add-metadata-properties/metadata-property-details.png" alt-text="Screenshot of adding custom metadata in the portal."::: |
48 | 49 |
|
49 |
| - :::image type="content" source="media/add-metadata-properties/metadata-property-assignments.png" alt-text="Screenshot of metadata property assignments in the portal."::: |
| 50 | +1. On the **Assignments** tab, select **Required** for APIs. Select **Optional** for Deployments and Environments. (You'll add these entities in later tutorials.) Select **Next**. |
50 | 51 |
|
51 |
| -1. On the **Review + Create** tab, review the settings and select **Create**. |
| 52 | + :::image type="content" source="media/add-metadata-properties/metadata-property-assignments.png" alt-text="Screenshot of metadata assignments in the portal." ::: |
| 53 | + |
| 54 | +1. On the **Review + create** tab, review the settings and select **Create**. |
52 | 55 |
|
53 |
| - The property is added to the list. |
| 56 | + The metadata is added to the list on the **Metadata** page. |
54 | 57 |
|
55 |
| -1. Select **+ Add property** to add another property. |
| 58 | +1. Select **+ New metadata** to add another example. |
56 | 59 |
|
57 |
| -1. On the **Details** tab, enter information about the property. |
| 60 | +1. On the **Details** tab, enter information about the metadata. |
58 | 61 |
|
59 | 62 | 1. In **Title**, enter *Public-facing*.
|
60 | 63 |
|
61 | 64 | 1. Select type **Boolean**.
|
62 | 65 |
|
63 | 66 | 1. On the **Assignments** tab, select **Required** for APIs. Select **Not applicable** for Deployments and Environments.
|
64 | 67 |
|
65 |
| -1. On the **Review + Create** tab, review the settings and select **Create**. |
| 68 | +1. On the **Review + create** tab, review the settings and select **Create**. |
66 | 69 |
|
67 |
| - The property is added to the list. |
| 70 | + The metadata is added to the list. |
68 | 71 |
|
69 | 72 | ## View metadata schema
|
70 | 73 |
|
71 |
| -You can view and download the JSON schema for the metadata properties in your API center. The schema includes built-in and custom properties. |
| 74 | +You can view and download the JSON schema for the metadata defined in your API center. The schema includes built-in and custom metadata. |
72 | 75 |
|
73 |
| -1. In the left menu, select **Metadata schema > View schema**. |
| 76 | +1. In the left menu, under **Assets**, select **Metadata > View metadata schema**. |
74 | 77 |
|
75 |
| -1. Select **View schema > API** to see the metadata schema for APIs, which includes built-in properties and the properties that you added. You can also view the metadata schema defined for deployments and environments in your API center. |
| 78 | +1. Select **View metadata schema > APIs** to see the metadata schema for APIs, which includes built-in and custom metadata. You can also view the metadata schema defined for deployments and environments in your API center. |
76 | 79 |
|
77 | 80 | :::image type="content" source="media/add-metadata-properties/metadata-schema.png" alt-text="Screenshot of metadata schema in the portal." lightbox="media/add-metadata-properties/metadata-schema.png":::
|
78 | 81 |
|
79 |
| -> [!NOTE] |
80 |
| -> * Add properties in the schema at any time and apply them to APIs and other entities in your API center. |
81 |
| -> * After adding a property, you can change its assignment to an entity, for example from required to optional for APIs. |
82 |
| -> * You can't delete, unassign, or change the type of properties that are currently set in entities. Remove them from the entities first, and then you can delete or change them. |
83 |
| -
|
84 | 82 | ## Next steps
|
85 | 83 |
|
86 | 84 | In this tutorial, you learned how to use the portal to:
|
87 | 85 | > [!div class="checklist"]
|
88 |
| -> * Define custom metadata properties in your API center |
| 86 | +> * Define custom metadata in your API center |
89 | 87 | > * View the metadata schema
|
90 | 88 |
|
91 | 89 | Now that you've prepared your metadata schema, add APIs to the inventory in your API center.
|
|
0 commit comments