Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getWorkspaceProductApiLink
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getWorkspaceProductApiLink

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the API link for the product.

Uses Azure REST API version 2022-09-01-preview.

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

Using getWorkspaceProductApiLink

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspaceProductApiLink(args: GetWorkspaceProductApiLinkArgs, opts?: InvokeOptions): Promise<GetWorkspaceProductApiLinkResult>
function getWorkspaceProductApiLinkOutput(args: GetWorkspaceProductApiLinkOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceProductApiLinkResult>
Copy
def get_workspace_product_api_link(api_link_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,
                                   opts: Optional[InvokeOptions] = None) -> GetWorkspaceProductApiLinkResult
def get_workspace_product_api_link_output(api_link_id: Optional[pulumi.Input[str]] = None,
                                   product_id: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   service_name: Optional[pulumi.Input[str]] = None,
                                   workspace_id: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceProductApiLinkResult]
Copy
func LookupWorkspaceProductApiLink(ctx *Context, args *LookupWorkspaceProductApiLinkArgs, opts ...InvokeOption) (*LookupWorkspaceProductApiLinkResult, error)
func LookupWorkspaceProductApiLinkOutput(ctx *Context, args *LookupWorkspaceProductApiLinkOutputArgs, opts ...InvokeOption) LookupWorkspaceProductApiLinkResultOutput
Copy

> Note: This function is named LookupWorkspaceProductApiLink in the Go SDK.

public static class GetWorkspaceProductApiLink 
{
    public static Task<GetWorkspaceProductApiLinkResult> InvokeAsync(GetWorkspaceProductApiLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceProductApiLinkResult> Invoke(GetWorkspaceProductApiLinkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceProductApiLinkResult> getWorkspaceProductApiLink(GetWorkspaceProductApiLinkArgs args, InvokeOptions options)
public static Output<GetWorkspaceProductApiLinkResult> getWorkspaceProductApiLink(GetWorkspaceProductApiLinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceProductApiLink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiLinkId
This property is required.
Changes to this property will trigger replacement.
string
Product-API link identifier. Must be unique in the current API Management service instance.
ProductId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ApiLinkId
This property is required.
Changes to this property will trigger replacement.
string
Product-API link identifier. Must be unique in the current API Management service instance.
ProductId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
apiLinkId
This property is required.
Changes to this property will trigger replacement.
String
Product-API link identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
String
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
apiLinkId
This property is required.
Changes to this property will trigger replacement.
string
Product-API link identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
api_link_id
This property is required.
Changes to this property will trigger replacement.
str
Product-API link identifier. Must be unique in the current API Management service instance.
product_id
This property is required.
Changes to this property will trigger replacement.
str
Product identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
apiLinkId
This property is required.
Changes to this property will trigger replacement.
String
Product-API link identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
String
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceProductApiLink Result

The following output properties are available:

ApiId string
Full resource Id of an API.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ApiId string
Full resource Id of an API.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
apiId String
Full resource Id of an API.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
apiId string
Full resource Id of an API.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
api_id str
Full resource Id of an API.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
apiId String
Full resource Id of an API.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native