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.76.0 published on Friday, Dec 6, 2024 by Pulumi
azure-native.apimanagement.getWorkspaceProduct
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.76.0 published on Friday, Dec 6, 2024 by Pulumi
Gets the details of the product specified by its identifier. 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 getWorkspaceProduct
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 getWorkspaceProduct(args: GetWorkspaceProductArgs, opts?: InvokeOptions): Promise<GetWorkspaceProductResult>
function getWorkspaceProductOutput(args: GetWorkspaceProductOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceProductResult>
def get_workspace_product(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) -> GetWorkspaceProductResult
def get_workspace_product_output(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[GetWorkspaceProductResult]
func LookupWorkspaceProduct(ctx *Context, args *LookupWorkspaceProductArgs, opts ...InvokeOption) (*LookupWorkspaceProductResult, error)
func LookupWorkspaceProductOutput(ctx *Context, args *LookupWorkspaceProductOutputArgs, opts ...InvokeOption) LookupWorkspaceProductResultOutput
> Note: This function is named LookupWorkspaceProduct
in the Go SDK.
public static class GetWorkspaceProduct
{
public static Task<GetWorkspaceProductResult> InvokeAsync(GetWorkspaceProductArgs args, InvokeOptions? opts = null)
public static Output<GetWorkspaceProductResult> Invoke(GetWorkspaceProductInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspaceProductResult> getWorkspaceProduct(GetWorkspaceProductArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getWorkspaceProduct
arguments:
# arguments dictionary
The following arguments are supported:
- Product
Id string - Product identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Product
Id string - Product identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- product
Id String - Product identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- product
Id string - Product identifier. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- product_
id str - Product identifier. Must be unique in the current API Management service instance.
- resource_
group_ strname - 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.
- product
Id String - Product identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
getWorkspaceProduct Result
The following output properties are available:
- Display
Name string - Product name.
- 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"
- Approval
Required bool - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- Description string
- Product description. May include HTML formatting tags.
- State string
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- Subscription
Required bool - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- Subscriptions
Limit int - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- Terms string
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- Display
Name string - Product name.
- 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"
- Approval
Required bool - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- Description string
- Product description. May include HTML formatting tags.
- State string
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- Subscription
Required bool - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- Subscriptions
Limit int - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- Terms string
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- display
Name String - Product name.
- 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"
- approval
Required Boolean - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- description String
- Product description. May include HTML formatting tags.
- state String
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- subscription
Required Boolean - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- subscriptions
Limit Integer - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- terms String
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- display
Name string - Product name.
- 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"
- approval
Required boolean - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- description string
- Product description. May include HTML formatting tags.
- state string
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- subscription
Required boolean - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- subscriptions
Limit number - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- terms string
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- display_
name str - Product name.
- 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"
- approval_
required bool - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- description str
- Product description. May include HTML formatting tags.
- state str
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- subscription_
required bool - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- subscriptions_
limit int - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- terms str
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
- display
Name String - Product name.
- 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"
- approval
Required Boolean - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
- description String
- Product description. May include HTML formatting tags.
- state String
- whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
- subscription
Required Boolean - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
- subscriptions
Limit Number - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
- terms String
- Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
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.76.0 published on Friday, Dec 6, 2024 by Pulumi