You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-manage-protocols-ciphers.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ API Management supports TLS versions up to TLS 1.3 for client and backend connec
46
46
1. Select **Save**.
47
47
48
48
> [!NOTE]
49
-
> Some protocols or cipher suites (such as backend-side TLS 1.2) can't be enabled or disabled from the Azure portal. Instead, you'll need to apply the REST API call. Use the `properties.customProperties` structure in the [Create/Update API Management Service](/rest/api/apimanagement/current-ga/api-management-service/create-or-update) REST API.
49
+
> Some protocols or cipher suites such as backend-side TLS 1.2 can't be enabled or disabled from the Azure portal. Instead, you'll need to apply the REST API call for these updates (backend side only). Use the `properties.customProperties` structure in the [Create/Update API Management Service](/rest/api/apimanagement/current-ga/api-management-service/create-or-update) REST API.
When you import the backend API into API Management, your API Management API becomes a façade for the backend API. You can customize the façade to your needs in API Management without changing the backend API. For more information, see [Transform and protect your API](transform-api.md).
21
+
When you import the backend API into API Management, your API Management API becomes the gateway for the backend API. You can customize the gateway to your needs in API Management without changing the backend API. For more information, see [Transform and protect your API](transform-api.md).
22
22
23
23
In this tutorial, you learn how to:
24
24
@@ -35,24 +35,26 @@ After import, you can manage the API in the Azure portal.
35
35
## Prerequisites
36
36
37
37
- Understand [Azure API Management terminology](api-management-terminology.md).
38
-
-[Create an Azure API Management instance](get-started-create-service-instance.md).
38
+
- Create an [Azure API Management instance](get-started-create-service-instance.md).
This section shows how to import and publish an OpenAPI specification backend API.
45
45
46
-
1. In the left navigation of your API Management instance, under **APIs**, select **APIs**.
46
+
1. In your API Management instance, under **APIs** in the sidebar menu, select **APIs**.
47
+
47
48
1. Select the **OpenAPI** tile.
49
+
48
50
1. In the **Create from OpenAPI specification** window, select **Full**.
51
+
49
52
1. Enter the values from the following table.
50
53
51
54
You can set API values during creation or later by going to the **Settings** tab.
52
55
53
56
:::image type="content" source="media/import-and-publish/open-api-specs.png" alt-text="Screenshot of creating an API in the portal.":::
54
57
55
-
56
58
|Setting|Value|Description|
57
59
|-------|-----|-----------|
58
60
|**OpenAPI specification**|*https:\//petstore3.swagger.io/api/v3/openapi.json* -or- *https:\//petstore.swagger.io/v2/swagger.json*|Specifies the backend service implementing the API and the operations that the API supports. <br/><br/>The backend service URL appears later as the **Web service URL** on the API's **Settings** page.<br/><br/>After import, you can add, edit, rename, or delete operations in the specification. |
@@ -64,25 +66,27 @@ This section shows how to import and publish an OpenAPI specification backend AP
64
66
|**API URL suffix**|*petstore*|The suffix appended to the base URL for the API Management service. API Management distinguishes and routes APIs by their suffix, so the suffix must be unique for every API for a given publisher. Learn more about [how API Management routes requests](#how-api-management-routes-requests). |
65
67
|**Tags**||Tags for organizing APIs for searching, grouping, or filtering.|
66
68
|**Products**|**Unlimited**|Association of one or more APIs. In certain tiers, API Management instance comes with two sample products: **Starter** and **Unlimited**. You publish an API in the developer portal by associating the API with a product.<br/><br/> You can include several APIs in a product and offer product [subscriptions](api-management-subscriptions.md) to developers through the developer portal. To add this API to another product, type or select the product name. Repeat this step to add the API to multiple products. You can also add APIs to products later from the **Settings** page.<br/><br/> For more information about products, see [Create and publish a product](api-management-howto-add-products.md).|
67
-
|**Gateways**|**Managed**|API gateway(s) that expose the API. This field is available only in **Developer** and **Premium** tier services.<br/><br/>**Managed** indicates the gateway built into the API Management service and hosted by Microsoft in Azure. [Self-hosted gateways](self-hosted-gateway-overview.md) are available only in the Premium and Developer service tiers. You can deploy them on-premises or in other clouds.<br/><br/> If you don't select any gateways, the API isn't available and your API requests don't succeed.|
69
+
|**Gateways**|**Managed**|API gateways that expose the API. This field is available only in **Developer** and **Premium** tier services.<br/><br/>**Managed** indicates the gateway built into the API Management service and hosted by Microsoft in Azure. [Self-hosted gateways](self-hosted-gateway-overview.md) are available only in the Premium and Developer service tiers. You can deploy them on-premises or in other clouds.<br/><br/> If you don't select any gateways, the API isn't available and your API requests don't succeed.|
68
70
|**Version this API?**|Select or deselect|For more information, see [Publish multiple versions of your API](api-management-get-started-publish-versions.md).|
69
71
70
72
1. Select **Create** to create your API.
71
73
72
-
If you have problems importing an API definition, see the [list of known issues and restrictions](api-management-api-import-restrictions.md).
74
+
If you have problems importing an API definition, see [API import restrictions and known issues](api-management-api-import-restrictions.md).
73
75
74
76
## View and modify API settings
75
77
76
78
After importing your API, you can view and modify its settings and operations in the Azure portal.
77
79
78
-
1. In the left navigation of your API Management instance, under **APIs**, select **APIs**.
80
+
1. In your API Management instance, under **APIs** in the sidebar menu, select **APIs**.
81
+
79
82
1. Select your imported API (for example, **Swagger Petstore**).
80
83
:::image type="content" source="media/import-and-publish/view-api-settings.png" lightbox="media/import-and-publish/view-api-settings.png" alt-text="Screenshot of API settings in API Management in the portal.":::
81
84
82
85
1. Select the **Design** tab to view and modify API operations in the OpenAPI specification, including:
83
86
- Operation details such as URL, method, and description
84
87
- Request and response definitions
85
88
- Policies to modify requests and responses
89
+
86
90
1. Select the **Settings** tab to view and modify API configuration details, including:
87
91
- Display name, name, and description
88
92
- Web service URL (backend service), URL scheme, and API URL suffix
@@ -95,10 +99,12 @@ As you go through the API Management tutorials, you learn more about configuring
95
99
96
100
You can call API operations directly from the Azure portal, which provides a convenient way to view and test the operations. In the portal's test console, by default, APIs are called by using a key from the built-in all-access subscription. You can also test API calls by using a subscription key scoped to a product.
97
101
98
-
1. In the left navigation of your API Management instance, select **APIs** > **APIs** > **Swagger Petstore**.
102
+
1. In your API Management instance, select **APIs** > **APIs** > **Swagger Petstore**.
103
+
99
104
1. Select the **Test** tab, and then select **Finds Pets by status**. The page shows the *status***Query parameter**. Select one of the available values, such as *pending*. You can also add query parameters and headers here.
100
105
101
106
In the **HTTP request** section, the **Ocp-Apim-Subscription-Key** header is filled in automatically for you, which you can see if you select the "eye" icon.
107
+
102
108
1. Select **Send**.
103
109
104
110
:::image type="content" source="media/import-and-publish/test-new-api.png" alt-text="Screenshot of testing an API in Azure portal." lightbox="media/import-and-publish/test-new-api.png":::
@@ -135,26 +141,18 @@ The following table describes each routing parameter in the context of the Petst
The Bicep file used in this quickstart is from [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/azure-api-management-create/).
38
+
The Bicep file used in this quickstart is from [Azure quickstart templates](/samples/azure/azure-quickstart-templates/azure-api-management-create/).
In this example, the Bicep file by default configures the API Management instance in the Developer tier, an economical option to evaluate Azure API Management. This tier isn't for production use.
48
47
49
-
More Azure API Management Bicep samples can be found in [Azure Quickstart Templates](https://azure.microsoft.com/resources/templates/?resourceType=Microsoft.Apimanagement&pageNumber=1&sort=Popular).
48
+
More Azure API Management Bicep samples can be found in [Azure quickstart templates](/samples/browse/?terms=api%20management&languages=bicep).
50
49
51
50
## Deploy the Bicep file
52
51
53
-
You can use Azure CLI or Azure PowerShell to deploy the Bicep file. For more information about deploying Bicep files, see [Deploy](../azure-resource-manager/bicep/deploy-cli.md).
52
+
You can use Azure CLI or Azure PowerShell to deploy the Bicep file. For more information about deploying Bicep files, see [Deploy Bicep files with the Azure CLI](../azure-resource-manager/bicep/deploy-cli.md).
53
+
54
+
1. Save the Bicep file as *main.bicep* to your local computer.
54
55
55
-
1. Save the Bicep file as **main.bicep** to your local computer.
56
56
1. Deploy the Bicep file using either Azure CLI or Azure PowerShell.
57
57
58
+
Replace *\<publisher-name\>* and *\<publisher-email\>* with your organization's name and your email address to receive notifications.
59
+
58
60
# [CLI](#tab/CLI)
59
61
60
62
```azurecli
@@ -73,16 +75,14 @@ You can use Azure CLI or Azure PowerShell to deploy the Bicep file. For more in
73
75
74
76
---
75
77
76
-
Replace **\<publisher-name\>** and **\<publisher-email\>** with the name of the API publisher's organization and the email address to receive notifications.
77
-
78
78
When the deployment finishes, you should see a message indicating the deployment succeeded.
79
79
80
80
> [!TIP]
81
81
> It can take between 30 and 40 minutes to create and activate an API Management service in the Developer tier. Times vary by tier.
82
82
83
83
## Review deployed resources
84
84
85
-
Use the Azure portal, Azure CLI or Azure PowerShell to list the deployed App Configuration resource in the resource group.
85
+
Use the Azure portal, Azure CLI, or Azure PowerShell to list the deployed App Configuration resource in the resource group.
Copy file name to clipboardExpand all lines: articles/api-management/validate-graphql-request-policy.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ The `validate-graphql-request` policy validates the GraphQL request and authoriz
42
42
|Name|Description|Required|
43
43
|----------|-----------------|--------------|
44
44
| authorize | Add this element to set an appropriate authorization rule for one or more paths. | No |
45
-
| rule | Add one or more of these elements to authorize specific query paths. Each rule can optionally specify a different [action](#request-actions). May be specified conditionally using a policy expression. | No |
45
+
| rule | Add one or more of these elements to authorize specific query paths. Each rule can optionally specify a different [action](#request-actions). May be specified conditionally using a policy expression.<br/><br/>For each GraphQL leaf field, API Management evaluates all matching rules and applies the most specific path match (for example, `/Query/listUsers` overrides `/Query/*`).| No |
0 commit comments