/
getProduct.ts
90 lines (86 loc) · 2.72 KB
/
getProduct.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "../utilities";
/**
* Use this data source to access information about an existing API Management Product.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
*
* const test = pulumi.output(azure.apimanagement.getProduct({
* apiManagementName: "example-apim",
* productId: "my-product",
* resourceGroupName: "search-service",
* }));
*
* export const productTerms = test.terms;
* ```
*/
export function getProduct(args: GetProductArgs, opts?: pulumi.InvokeOptions): Promise<GetProductResult> {
return pulumi.runtime.invoke("azure:apimanagement/getProduct:getProduct", {
"apiManagementName": args.apiManagementName,
"productId": args.productId,
"resourceGroupName": args.resourceGroupName,
}, opts);
}
/**
* A collection of arguments for invoking getProduct.
*/
export interface GetProductArgs {
/**
* The Name of the API Management Service in which this Product exists.
*/
readonly apiManagementName: string;
/**
* The Identifier for the API Management Product.
*/
readonly productId: string;
/**
* The Name of the Resource Group in which the API Management Service exists.
*/
readonly resourceGroupName: string;
}
/**
* A collection of values returned by getProduct.
*/
export interface GetProductResult {
readonly apiManagementName: string;
/**
* Do subscribers need to be approved prior to being able to use the Product?
*/
readonly approvalRequired: boolean;
/**
* The description of this Product, which may include HTML formatting tags.
*/
readonly description: string;
/**
* The Display Name for this API Management Product.
*/
readonly displayName: string;
readonly productId: string;
/**
* Is this Product Published?
*/
readonly published: boolean;
readonly resourceGroupName: string;
/**
* Is a Subscription required to access API's included in this Product?
*/
readonly subscriptionRequired: boolean;
/**
* The number of subscriptions a user can have to this Product at the same time.
*/
readonly subscriptionsLimit: number;
/**
* Any Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
*/
readonly terms: string;
/**
* id is the provider-assigned unique ID for this managed resource.
*/
readonly id: string;
}