import * as pulumi from "@pulumi/pulumi"; /** * Manages a Subscription within a API Management Service. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = azure.apimanagement.getService({ * name: "example-apim", * resourceGroupName: "example-resources", * }); * const exampleGetProduct = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getProduct({ * productId: "00000000-0000-0000-0000-000000000000", * apiManagementName: example.name, * resourceGroupName: example1.resourceGroupName, * })); * const exampleGetUser = Promise.all([example, example]).then(([example, example1]) => azure.apimanagement.getUser({ * userId: "11111111-1111-1111-1111-111111111111", * apiManagementName: example.name, * resourceGroupName: example1.resourceGroupName, * })); * const exampleSubscription = new azure.apimanagement.Subscription("example", { * apiManagementName: example.then(example => example.name), * resourceGroupName: example.then(example => example.resourceGroupName), * userId: exampleGetUser.then(exampleGetUser => exampleGetUser.id), * productId: exampleGetProduct.then(exampleGetProduct => exampleGetProduct.id), * displayName: "Parser API", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2022-08-01 * * ## Import * * API Management Subscriptions can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/subscription:Subscription example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/subscriptions/subscription-name * ``` */ export declare class Subscription extends pulumi.CustomResource { /** * Get an existing Subscription resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SubscriptionState, opts?: pulumi.CustomResourceOptions): Subscription; /** * Returns true if the given object is an instance of Subscription. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Subscription; /** * Determines whether tracing can be enabled. Defaults to `true`. */ readonly allowTracing: pulumi.Output; /** * The ID of the API which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `/apis` scope is used for the subscription and all apis are accessible. */ readonly apiId: pulumi.Output; /** * The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created. */ readonly apiManagementName: pulumi.Output; /** * The display name of this Subscription. */ readonly displayName: pulumi.Output; /** * The primary subscription key to use for the subscription. */ readonly primaryKey: pulumi.Output; /** * The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `allApis` scope is used for the subscription. */ readonly productId: pulumi.Output; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The secondary subscription key to use for the subscription. */ readonly secondaryKey: pulumi.Output; /** * The state of this Subscription. Possible values are `active`, `cancelled`, `expired`, `rejected`, `submitted` and `suspended`. Defaults to `submitted`. */ readonly state: pulumi.Output; /** * An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created. */ readonly subscriptionId: pulumi.Output; /** * The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created. */ readonly userId: pulumi.Output; /** * Create a Subscription resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Subscription resources. */ export interface SubscriptionState { /** * Determines whether tracing can be enabled. Defaults to `true`. */ allowTracing?: pulumi.Input; /** * The ID of the API which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `/apis` scope is used for the subscription and all apis are accessible. */ apiId?: pulumi.Input; /** * The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created. */ apiManagementName?: pulumi.Input; /** * The display name of this Subscription. */ displayName?: pulumi.Input; /** * The primary subscription key to use for the subscription. */ primaryKey?: pulumi.Input; /** * The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `allApis` scope is used for the subscription. */ productId?: pulumi.Input; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The secondary subscription key to use for the subscription. */ secondaryKey?: pulumi.Input; /** * The state of this Subscription. Possible values are `active`, `cancelled`, `expired`, `rejected`, `submitted` and `suspended`. Defaults to `submitted`. */ state?: pulumi.Input; /** * An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created. */ subscriptionId?: pulumi.Input; /** * The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created. */ userId?: pulumi.Input; } /** * The set of arguments for constructing a Subscription resource. */ export interface SubscriptionArgs { /** * Determines whether tracing can be enabled. Defaults to `true`. */ allowTracing?: pulumi.Input; /** * The ID of the API which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `/apis` scope is used for the subscription and all apis are accessible. */ apiId?: pulumi.Input; /** * The name of the API Management Service where this Subscription should be created. Changing this forces a new resource to be created. */ apiManagementName: pulumi.Input; /** * The display name of this Subscription. */ displayName: pulumi.Input; /** * The primary subscription key to use for the subscription. */ primaryKey?: pulumi.Input; /** * The ID of the Product which should be assigned to this Subscription. Changing this forces a new resource to be created. * * > **Note:** Only one of `productId` and `apiId` can be set. If both are missing `allApis` scope is used for the subscription. */ productId?: pulumi.Input; /** * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * The secondary subscription key to use for the subscription. */ secondaryKey?: pulumi.Input; /** * The state of this Subscription. Possible values are `active`, `cancelled`, `expired`, `rejected`, `submitted` and `suspended`. Defaults to `submitted`. */ state?: pulumi.Input; /** * An Identifier which should used as the ID of this Subscription. If not specified a new Subscription ID will be generated. Changing this forces a new resource to be created. */ subscriptionId?: pulumi.Input; /** * The ID of the User which should be assigned to this Subscription. Changing this forces a new resource to be created. */ userId?: pulumi.Input; }