Product Api
Manages an API Management API Assignment to a Product.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.apimanagement.getService({
name: "example-api",
resourceGroupName: "example-resources",
});
const exampleGetApi = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getApi({
name: "search-api",
apiManagementName: example.name,
resourceGroupName: example1.resourceGroupName,
revision: "2",
}));
const exampleGetProduct = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getProduct({
productId: "my-product",
apiManagementName: example.name,
resourceGroupName: example1.resourceGroupName,
}));
const exampleProductApi = new azure.apimanagement.ProductApi("example", {
apiName: exampleGetApi.then(exampleGetApi => exampleGetApi.name),
productId: exampleGetProduct.then(exampleGetProduct => exampleGetProduct.productId),
apiManagementName: example.then(example => example.name),
resourceGroupName: example.then(example => example.resourceGroupName),
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.apimanagement.get_service(name="example-api",
resource_group_name="example-resources")
example_get_api = azure.apimanagement.get_api(name="search-api",
api_management_name=example.name,
resource_group_name=example.resource_group_name,
revision="2")
example_get_product = azure.apimanagement.get_product(product_id="my-product",
api_management_name=example.name,
resource_group_name=example.resource_group_name)
example_product_api = azure.apimanagement.ProductApi("example",
api_name=example_get_api.name,
product_id=example_get_product.product_id,
api_management_name=example.name,
resource_group_name=example.resource_group_name)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ApiManagement.GetService.Invoke(new()
{
Name = "example-api",
ResourceGroupName = "example-resources",
});
var exampleGetApi = Azure.ApiManagement.GetApi.Invoke(new()
{
Name = "search-api",
ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
Revision = "2",
});
var exampleGetProduct = Azure.ApiManagement.GetProduct.Invoke(new()
{
ProductId = "my-product",
ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
});
var exampleProductApi = new Azure.ApiManagement.ProductApi("example", new()
{
ApiName = exampleGetApi.Apply(getApiResult => getApiResult.Name),
ProductId = exampleGetProduct.Apply(getProductResult => getProductResult.ProductId),
ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := apimanagement.LookupService(ctx, &apimanagement.LookupServiceArgs{
Name: "example-api",
ResourceGroupName: "example-resources",
}, nil)
if err != nil {
return err
}
exampleGetApi, err := apimanagement.LookupApi(ctx, &apimanagement.LookupApiArgs{
Name: "search-api",
ApiManagementName: example.Name,
ResourceGroupName: example.ResourceGroupName,
Revision: "2",
}, nil)
if err != nil {
return err
}
exampleGetProduct, err := apimanagement.LookupProduct(ctx, &apimanagement.LookupProductArgs{
ProductId: "my-product",
ApiManagementName: example.Name,
ResourceGroupName: example.ResourceGroupName,
}, nil)
if err != nil {
return err
}
_, err = apimanagement.NewProductApi(ctx, "example", &apimanagement.ProductApiArgs{
ApiName: pulumi.String(exampleGetApi.Name),
ProductId: pulumi.String(exampleGetProduct.ProductId),
ApiManagementName: pulumi.String(example.Name),
ResourceGroupName: pulumi.String(example.ResourceGroupName),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.apimanagement.ApimanagementFunctions;
import com.pulumi.azure.apimanagement.inputs.GetServiceArgs;
import com.pulumi.azure.apimanagement.inputs.GetApiArgs;
import com.pulumi.azure.apimanagement.inputs.GetProductArgs;
import com.pulumi.azure.apimanagement.ProductApi;
import com.pulumi.azure.apimanagement.ProductApiArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ApimanagementFunctions.getService(GetServiceArgs.builder()
.name("example-api")
.resourceGroupName("example-resources")
.build());
final var exampleGetApi = ApimanagementFunctions.getApi(GetApiArgs.builder()
.name("search-api")
.apiManagementName(example.name())
.resourceGroupName(example.resourceGroupName())
.revision("2")
.build());
final var exampleGetProduct = ApimanagementFunctions.getProduct(GetProductArgs.builder()
.productId("my-product")
.apiManagementName(example.name())
.resourceGroupName(example.resourceGroupName())
.build());
var exampleProductApi = new ProductApi("exampleProductApi", ProductApiArgs.builder()
.apiName(exampleGetApi.name())
.productId(exampleGetProduct.productId())
.apiManagementName(example.name())
.resourceGroupName(example.resourceGroupName())
.build());
}
}
Content copied to clipboard
resources:
exampleProductApi:
type: azure:apimanagement:ProductApi
name: example
properties:
apiName: ${exampleGetApi.name}
productId: ${exampleGetProduct.productId}
apiManagementName: ${example.name}
resourceGroupName: ${example.resourceGroupName}
variables:
example:
fn::invoke:
function: azure:apimanagement:getService
arguments:
name: example-api
resourceGroupName: example-resources
exampleGetApi:
fn::invoke:
function: azure:apimanagement:getApi
arguments:
name: search-api
apiManagementName: ${example.name}
resourceGroupName: ${example.resourceGroupName}
revision: '2'
exampleGetProduct:
fn::invoke:
function: azure:apimanagement:getProduct
arguments:
productId: my-product
apiManagementName: ${example.name}
resourceGroupName: ${example.resourceGroupName}
Content copied to clipboard
API Providers
This resource uses the following Azure API Providers:
Microsoft.ApiManagement
: 2022-08-01
Import
API Management Product API's can be imported using the resource id
, e.g.
$ pulumi import azure:apimanagement/productApi:ProductApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/products/exampleId/apis/apiId
Content copied to clipboard
Properties
Link copied to clipboard
The name of the API Management Service. Changing this forces a new resource to be created.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.