import * as pulumi from "@pulumi/pulumi"; import * as types from "./types"; /** * Subscription details. * * Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2022-08-01. * * Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-06-01-preview, 2024-10-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apimanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details. */ 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 opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Subscription; /** @internal */ static readonly __pulumiType = "azure-native:apimanagement: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 is enabled */ readonly allowTracing: pulumi.Output; /** * The Azure API version of the resource. */ readonly azureApiVersion: pulumi.Output; /** * Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ readonly createdDate: pulumi.Output; /** * The name of the subscription, or null if the subscription has no name. */ readonly displayName: pulumi.Output; /** * Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ readonly endDate: pulumi.Output; /** * Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ readonly expirationDate: pulumi.Output; /** * The name of the resource */ readonly name: pulumi.Output; /** * Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ readonly notificationDate: pulumi.Output; /** * The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. */ readonly ownerId: pulumi.Output; /** * Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. */ readonly primaryKey: pulumi.Output; /** * Scope like /products/{productId} or /apis or /apis/{apiId}. */ readonly scope: pulumi.Output; /** * Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. */ readonly secondaryKey: pulumi.Output; /** * Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ readonly startDate: pulumi.Output; /** * Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. */ readonly state: pulumi.Output; /** * Optional subscription comment added by an administrator when the state is changed to the 'rejected'. */ readonly stateComment: pulumi.Output; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ readonly type: 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); } /** * The set of arguments for constructing a Subscription resource. */ export interface SubscriptionArgs { /** * Determines whether tracing can be enabled */ allowTracing?: pulumi.Input; /** * Determines the type of application which send the create user request. Default is legacy publisher portal. */ appType?: pulumi.Input; /** * Subscription name. */ displayName: pulumi.Input; /** * Notify change in Subscription State. * - If false, do not send any email notification for change of state of subscription * - If true, send email notification of change of state of subscription */ notify?: pulumi.Input; /** * User (user id path) for whom subscription is being created in form /users/{userId} */ ownerId?: pulumi.Input; /** * Primary subscription key. If not specified during request key will be generated automatically. */ primaryKey?: pulumi.Input; /** * The name of the resource group. The name is case insensitive. */ resourceGroupName: pulumi.Input; /** * Scope like /products/{productId} or /apis or /apis/{apiId}. */ scope: pulumi.Input; /** * Secondary subscription key. If not specified during request key will be generated automatically. */ secondaryKey?: pulumi.Input; /** * The name of the API Management service. */ serviceName: pulumi.Input; /** * Subscription entity Identifier. The entity represents the association between a user and a product in API Management. */ sid?: pulumi.Input; /** * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. */ state?: pulumi.Input; }