1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. ProductApiLink
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.ProductApiLink

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Product-API link details. Azure REST API version: 2022-09-01-preview.

    Other available API versions: 2023-03-01-preview, 2023-05-01-preview.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var productApiLink = new AzureNative.ApiManagement.ProductApiLink("productApiLink", new()
        {
            ApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
            ApiLinkId = "link1",
            ProductId = "testproduct",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apimanagement.NewProductApiLink(ctx, "productApiLink", &apimanagement.ProductApiLinkArgs{
    			ApiId:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api"),
    			ApiLinkId:         pulumi.String("link1"),
    			ProductId:         pulumi.String("testproduct"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apimanagement.ProductApiLink;
    import com.pulumi.azurenative.apimanagement.ProductApiLinkArgs;
    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) {
            var productApiLink = new ProductApiLink("productApiLink", ProductApiLinkArgs.builder()        
                .apiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api")
                .apiLinkId("link1")
                .productId("testproduct")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    product_api_link = azure_native.apimanagement.ProductApiLink("productApiLink",
        api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
        api_link_id="link1",
        product_id="testproduct",
        resource_group_name="rg1",
        service_name="apimService1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const productApiLink = new azure_native.apimanagement.ProductApiLink("productApiLink", {
        apiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
        apiLinkId: "link1",
        productId: "testproduct",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
    });
    
    resources:
      productApiLink:
        type: azure-native:apimanagement:ProductApiLink
        properties:
          apiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api
          apiLinkId: link1
          productId: testproduct
          resourceGroupName: rg1
          serviceName: apimService1
    

    Create ProductApiLink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProductApiLink(name: string, args: ProductApiLinkArgs, opts?: CustomResourceOptions);
    @overload
    def ProductApiLink(resource_name: str,
                       args: ProductApiLinkArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProductApiLink(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api_id: Optional[str] = None,
                       product_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       api_link_id: Optional[str] = None)
    func NewProductApiLink(ctx *Context, name string, args ProductApiLinkArgs, opts ...ResourceOption) (*ProductApiLink, error)
    public ProductApiLink(string name, ProductApiLinkArgs args, CustomResourceOptions? opts = null)
    public ProductApiLink(String name, ProductApiLinkArgs args)
    public ProductApiLink(String name, ProductApiLinkArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:ProductApiLink
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProductApiLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProductApiLinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProductApiLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProductApiLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProductApiLinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var productApiLinkResource = new AzureNative.ApiManagement.ProductApiLink("productApiLinkResource", new()
    {
        ApiId = "string",
        ProductId = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        ApiLinkId = "string",
    });
    
    example, err := apimanagement.NewProductApiLink(ctx, "productApiLinkResource", &apimanagement.ProductApiLinkArgs{
    ApiId: pulumi.String("string"),
    ProductId: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    ApiLinkId: pulumi.String("string"),
    })
    
    var productApiLinkResource = new ProductApiLink("productApiLinkResource", ProductApiLinkArgs.builder()        
        .apiId("string")
        .productId("string")
        .resourceGroupName("string")
        .serviceName("string")
        .apiLinkId("string")
        .build());
    
    product_api_link_resource = azure_native.apimanagement.ProductApiLink("productApiLinkResource",
        api_id="string",
        product_id="string",
        resource_group_name="string",
        service_name="string",
        api_link_id="string")
    
    const productApiLinkResource = new azure_native.apimanagement.ProductApiLink("productApiLinkResource", {
        apiId: "string",
        productId: "string",
        resourceGroupName: "string",
        serviceName: "string",
        apiLinkId: "string",
    });
    
    type: azure-native:apimanagement:ProductApiLink
    properties:
        apiId: string
        apiLinkId: string
        productId: string
        resourceGroupName: string
        serviceName: string
    

    ProductApiLink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ProductApiLink resource accepts the following input properties:

    ApiId string
    Full resource Id of an API.
    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiLinkId string
    Product-API link identifier. Must be unique in the current API Management service instance.
    ApiId string
    Full resource Id of an API.
    ProductId string
    Product identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiLinkId string
    Product-API link identifier. Must be unique in the current API Management service instance.
    apiId String
    Full resource Id of an API.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiLinkId String
    Product-API link identifier. Must be unique in the current API Management service instance.
    apiId string
    Full resource Id of an API.
    productId string
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    apiLinkId string
    Product-API link identifier. Must be unique in the current API Management service instance.
    api_id str
    Full resource Id of an API.
    product_id str
    Product identifier. Must be unique in the current API Management service instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    api_link_id str
    Product-API link identifier. Must be unique in the current API Management service instance.
    apiId String
    Full resource Id of an API.
    productId String
    Product identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiLinkId String
    Product-API link identifier. Must be unique in the current API Management service instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProductApiLink resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:ProductApiLink link1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apiLinks/{apiLinkId} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi