Skip to content

Commit 4163883

Browse files
authored
Merge pull request #272017 from MicrosoftDocs/release-ga-api-center
Release-ga-api-center --> main
2 parents e33a3f9 + 034e6fa commit 4163883

Some content is hidden

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

42 files changed

+708
-317
lines changed

articles/api-center/TOC.yml

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,24 @@
55
items:
66
- name: Overview
77
items:
8-
- name: What is API Center?
8+
- name: What is Azure API Center?
99
displayName: Overview
1010
href: overview.md
1111
- name: Key concepts
1212
href: key-concepts.md
1313
- name: Service limits
14-
href: ../azure-resource-manager/management/azure-subscription-service-limits.md#api-center-preview-limits
14+
href: ../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#api-center-limits
15+
- name: Frequently asked questions
16+
href: frequently-asked-questions.yml
1517
- name: Quickstarts
1618
items:
17-
- name: Create an API center
19+
- name: Create an API center - portal
1820
href: set-up-api-center.md
21+
- name: Create an API center - CLI
22+
href: set-up-api-center-azure-cli.md
1923
- name: Tutorials
2024
items:
21-
- name: 1 - Customize metadata properties
25+
- name: 1 - Define custom metadata
2226
href: add-metadata-properties.md
2327
- name: 2 - Add APIs to the inventory
2428
href: register-apis.md
@@ -30,18 +34,24 @@
3034
href: manage-apis-azure-cli.md
3135
- name: Import APIs from API Management
3236
href: import-api-management-apis.md
37+
- name: Build and register APIs - VS Code extension
38+
href: use-vscode-extension.md
3339
- name: API governance
3440
items:
41+
- name: Use metadata for governance
42+
href: metadata.md
3543
- name: Analyze APIs using linting rules
3644
href: enable-api-analysis-linting.md
3745
- name: API discovery and consumption
3846
items:
39-
- name: Enable API Center portal
47+
- name: Self-host Azure API Center portal
4048
href: enable-api-center-portal.md
41-
- name: Use VS Code extension
42-
href: use-vscode-extension.md
4349
- name: Discover APIs with GitHub Copilot Chat
4450
href: use-vscode-extension-copilot.md
51+
- name: API center management and operations
52+
items:
53+
- name: Reliability
54+
href: ../reliability/reliability-api-center.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json
4555
- name: Reference
4656
items:
4757
- name: Azure CLI
@@ -57,6 +67,8 @@
5767
- name: Python
5868
href: https://pypi.org/project/azure-mgmt-apicenter
5969
- name: Event Grid schema
60-
href: ../event-grid/event-schema-api-center.md
70+
href: ../event-grid/event-schema-api-center.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json
6171
- name: Resource Manager template
62-
href: /azure/templates/microsoft.apicenter/allversions
72+
href: /azure/templates/microsoft.apicenter/allversions
73+
- name: Azure built-in roles
74+
href: ../role-based-access-control/built-in-roles.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#integration

articles/api-center/add-metadata-properties.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,89 @@
11
---
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.
44
author: dlepow
55
ms.service: api-center
66
ms.topic: tutorial
7-
ms.date: 11/07/2023
7+
ms.date: 04/19/2024
88
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.
910
---
1011

11-
# Tutorial: Customize metadata properties
12+
# Tutorial: Define custom metadata
1213

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.
1415

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)
1620

1721
In this tutorial, you learn how to use the portal to:
1822
> [!div class="checklist"]
19-
> * Define custom metadata properties in your API center
23+
> * Define custom metadata in your API center
2024
> * View the metadata schema
2125
22-
[!INCLUDE [api-center-preview-feedback](includes/api-center-preview-feedback.md)]
23-
2426
## Prerequisites
2527

2628
* 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).
2729

28-
## Define properties in the metadata schema
30+
## Define metadata
2931

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.
3133

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)]
3335

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.
3637

37-
1. In the left menu, select **Metadata schema > + Add property**.
38+
1. In the left menu, under **Assets**, select **Metadata > + New metadata**.
3839

39-
1. On the **Details** tab, enter information about the property.
40+
1. On the **Details** tab, enter information about the metadata.
4041

4142
1. In **Title**, enter *Line of business*.
4243

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**.
4445

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**.
4647

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.":::
4849

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**.
5051

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**.
5255

53-
The property is added to the list.
56+
The metadata is added to the list on the **Metadata** page.
5457

55-
1. Select **+ Add property** to add another property.
58+
1. Select **+ New metadata** to add another example.
5659

57-
1. On the **Details** tab, enter information about the property.
60+
1. On the **Details** tab, enter information about the metadata.
5861

5962
1. In **Title**, enter *Public-facing*.
6063

6164
1. Select type **Boolean**.
6265

6366
1. On the **Assignments** tab, select **Required** for APIs. Select **Not applicable** for Deployments and Environments.
6467

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**.
6669

67-
The property is added to the list.
70+
The metadata is added to the list.
6871

6972
## View metadata schema
7073

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.
7275

73-
1. In the left menu, select **Metadata schema > View schema**.
76+
1. In the left menu, under **Assets**, select **Metadata > View metadata schema**.
7477

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.
7679

7780
:::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":::
7881

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-
8482
## Next steps
8583

8684
In this tutorial, you learned how to use the portal to:
8785
> [!div class="checklist"]
88-
> * Define custom metadata properties in your API center
86+
> * Define custom metadata in your API center
8987
> * View the metadata schema
9088
9189
Now that you've prepared your metadata schema, add APIs to the inventory in your API center.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
items:
2+
- name: Azure
3+
tocHref: /azure/
4+
topicHref: /azure/index
5+
items:
6+
- name: API Center
7+
tocHref: /azure/azure-resource-manager/
8+
topicHref: /azure/api-center/index
9+
- name: API Center
10+
tocHref: /azure/templates/
11+
topicHref: /azure/api-center/index
12+
- name: API Center
13+
tocHref: /azure/reliability/
14+
topicHref: /azure/api-center/index
15+
- name: API Center
16+
tocHref: /azure/api-management/
17+
topicHref: /azure/api-center/index
18+
- name: API Center
19+
tocHref: /azure/event-grid/
20+
topicHref: /azure/api-center/index

0 commit comments

Comments
 (0)