1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. WorkspaceProductApiLink
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.WorkspaceProductApiLink

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 workspaceProductApiLink = new AzureNative.ApiManagement.WorkspaceProductApiLink("workspaceProductApiLink", new()
        {
            ApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
            ApiLinkId = "link1",
            ProductId = "testproduct",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            WorkspaceId = "wks1",
        });
    
    });
    
    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.NewWorkspaceProductApiLink(ctx, "workspaceProductApiLink", &apimanagement.WorkspaceProductApiLinkArgs{
    			ApiId:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api"),
    			ApiLinkId:         pulumi.String("link1"),
    			ProductId:         pulumi.String("testproduct"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    			WorkspaceId:       pulumi.String("wks1"),
    		})
    		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.WorkspaceProductApiLink;
    import com.pulumi.azurenative.apimanagement.WorkspaceProductApiLinkArgs;
    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 workspaceProductApiLink = new WorkspaceProductApiLink("workspaceProductApiLink", WorkspaceProductApiLinkArgs.builder()        
                .apiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api")
                .apiLinkId("link1")
                .productId("testproduct")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .workspaceId("wks1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    workspace_product_api_link = azure_native.apimanagement.WorkspaceProductApiLink("workspaceProductApiLink",
        api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
        api_link_id="link1",
        product_id="testproduct",
        resource_group_name="rg1",
        service_name="apimService1",
        workspace_id="wks1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const workspaceProductApiLink = new azure_native.apimanagement.WorkspaceProductApiLink("workspaceProductApiLink", {
        apiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
        apiLinkId: "link1",
        productId: "testproduct",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
        workspaceId: "wks1",
    });
    
    resources:
      workspaceProductApiLink:
        type: azure-native:apimanagement:WorkspaceProductApiLink
        properties:
          apiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api
          apiLinkId: link1
          productId: testproduct
          resourceGroupName: rg1
          serviceName: apimService1
          workspaceId: wks1
    

    Create WorkspaceProductApiLink Resource

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

    Constructor syntax

    new WorkspaceProductApiLink(name: string, args: WorkspaceProductApiLinkArgs, opts?: CustomResourceOptions);
    @overload
    def WorkspaceProductApiLink(resource_name: str,
                                args: WorkspaceProductApiLinkArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkspaceProductApiLink(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,
                                workspace_id: Optional[str] = None,
                                api_link_id: Optional[str] = None)
    func NewWorkspaceProductApiLink(ctx *Context, name string, args WorkspaceProductApiLinkArgs, opts ...ResourceOption) (*WorkspaceProductApiLink, error)
    public WorkspaceProductApiLink(string name, WorkspaceProductApiLinkArgs args, CustomResourceOptions? opts = null)
    public WorkspaceProductApiLink(String name, WorkspaceProductApiLinkArgs args)
    public WorkspaceProductApiLink(String name, WorkspaceProductApiLinkArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:WorkspaceProductApiLink
    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 WorkspaceProductApiLinkArgs
    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 WorkspaceProductApiLinkArgs
    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 WorkspaceProductApiLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceProductApiLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceProductApiLinkArgs
    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 workspaceProductApiLinkResource = new AzureNative.ApiManagement.WorkspaceProductApiLink("workspaceProductApiLinkResource", new()
    {
        ApiId = "string",
        ProductId = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        WorkspaceId = "string",
        ApiLinkId = "string",
    });
    
    example, err := apimanagement.NewWorkspaceProductApiLink(ctx, "workspaceProductApiLinkResource", &apimanagement.WorkspaceProductApiLinkArgs{
    ApiId: pulumi.String("string"),
    ProductId: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    WorkspaceId: pulumi.String("string"),
    ApiLinkId: pulumi.String("string"),
    })
    
    var workspaceProductApiLinkResource = new WorkspaceProductApiLink("workspaceProductApiLinkResource", WorkspaceProductApiLinkArgs.builder()        
        .apiId("string")
        .productId("string")
        .resourceGroupName("string")
        .serviceName("string")
        .workspaceId("string")
        .apiLinkId("string")
        .build());
    
    workspace_product_api_link_resource = azure_native.apimanagement.WorkspaceProductApiLink("workspaceProductApiLinkResource",
        api_id="string",
        product_id="string",
        resource_group_name="string",
        service_name="string",
        workspace_id="string",
        api_link_id="string")
    
    const workspaceProductApiLinkResource = new azure_native.apimanagement.WorkspaceProductApiLink("workspaceProductApiLinkResource", {
        apiId: "string",
        productId: "string",
        resourceGroupName: "string",
        serviceName: "string",
        workspaceId: "string",
        apiLinkId: "string",
    });
    
    type: azure-native:apimanagement:WorkspaceProductApiLink
    properties:
        apiId: string
        apiLinkId: string
        productId: string
        resourceGroupName: string
        serviceName: string
        workspaceId: string
    

    WorkspaceProductApiLink 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 WorkspaceProductApiLink 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.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.
    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.
    workspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    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.
    workspace_id str
    Workspace identifier. Must be unique in the current API Management service instance.
    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.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.
    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 WorkspaceProductApiLink 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:WorkspaceProductApiLink link1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/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