1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getProduct
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.apimanagement.getProduct

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Gets the details of the product specified by its identifier. API Version: 2020-12-01.

    Using getProduct

    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 getProduct(args: GetProductArgs, opts?: InvokeOptions): Promise<GetProductResult>
    function getProductOutput(args: GetProductOutputArgs, opts?: InvokeOptions): Output<GetProductResult>
    def get_product(product_id: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    service_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetProductResult
    def get_product_output(product_id: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    service_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetProductResult]
    func LookupProduct(ctx *Context, args *LookupProductArgs, opts ...InvokeOption) (*LookupProductResult, error)
    func LookupProductOutput(ctx *Context, args *LookupProductOutputArgs, opts ...InvokeOption) LookupProductResultOutput

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

    public static class GetProduct 
    {
        public static Task<GetProductResult> InvokeAsync(GetProductArgs args, InvokeOptions? opts = null)
        public static Output<GetProductResult> Invoke(GetProductInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProductResult> getProduct(GetProductArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:apimanagement:getProduct
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProductId string

    Product identifier. Must be unique in the current API Management service instance.

    ResourceGroupName string

    The name of the resource group.

    ServiceName string

    The name of the API Management service.

    ProductId string

    Product identifier. Must be unique in the current API Management service instance.

    ResourceGroupName string

    The name of the resource group.

    ServiceName string

    The name of the API Management service.

    productId String

    Product identifier. Must be unique in the current API Management service instance.

    resourceGroupName String

    The name of the resource group.

    serviceName String

    The name of the API Management service.

    productId string

    Product identifier. Must be unique in the current API Management service instance.

    resourceGroupName string

    The name of the resource group.

    serviceName string

    The name of the API Management service.

    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.

    service_name str

    The name of the API Management service.

    productId String

    Product identifier. Must be unique in the current API Management service instance.

    resourceGroupName String

    The name of the resource group.

    serviceName String

    The name of the API Management service.

    getProduct Result

    The following output properties are available:

    DisplayName string

    Product name.

    Id string

    Resource ID.

    Name string

    Resource name.

    Type string

    Resource type for API Management resource.

    ApprovalRequired 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.

    SubscriptionRequired 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.

    SubscriptionsLimit 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.

    DisplayName string

    Product name.

    Id string

    Resource ID.

    Name string

    Resource name.

    Type string

    Resource type for API Management resource.

    ApprovalRequired 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.

    SubscriptionRequired 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.

    SubscriptionsLimit 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.

    displayName String

    Product name.

    id String

    Resource ID.

    name String

    Resource name.

    type String

    Resource type for API Management resource.

    approvalRequired 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.

    subscriptionRequired 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.

    subscriptionsLimit 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.

    displayName string

    Product name.

    id string

    Resource ID.

    name string

    Resource name.

    type string

    Resource type for API Management resource.

    approvalRequired 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.

    subscriptionRequired 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.

    subscriptionsLimit 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

    Resource ID.

    name str

    Resource name.

    type str

    Resource type for API Management resource.

    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.

    displayName String

    Product name.

    id String

    Resource ID.

    name String

    Resource name.

    type String

    Resource type for API Management resource.

    approvalRequired 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.

    subscriptionRequired 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.

    subscriptionsLimit 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
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi