pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin.outputs/GetSubscriptionResult

GetSubscriptionResult

data class GetSubscriptionResult(val allowTracing: Boolean? = null, val createdDate: String, val displayName: String? = null, val endDate: String? = null, val expirationDate: String? = null, val id: String, val name: String, val notificationDate: String? = null, val ownerId: String? = null, val primaryKey: String? = null, val scope: String, val secondaryKey: String? = null, val startDate: String? = null, val state: String, val stateComment: String? = null, val type: String)

Subscription details.

Constructors

fun GetSubscriptionResult(allowTracing: Boolean? = null, createdDate: String, displayName: String? = null, endDate: String? = null, expirationDate: String? = null, id: String, name: String, notificationDate: String? = null, ownerId: String? = null, primaryKey: String? = null, scope: String, secondaryKey: String? = null, startDate: String? = null, state: String, stateComment: String? = null, type: String)

Types

Companion

object Companion

Properties

allowTracing

val allowTracing: Boolean? = null

Determines whether tracing is enabled

createdDate

val createdDate: String

Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

displayName

val displayName: String? = null

The name of the subscription, or null if the subscription has no name.

endDate

val endDate: String? = null

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.

expirationDate

val expirationDate: String? = null

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.

val id: String

Resource ID.

name

val name: String

Resource name.

notificationDate

val notificationDate: String? = null

Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

ownerId

val ownerId: String? = null

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.

primaryKey

val primaryKey: String? = null

Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

scope

val scope: String

Scope like /products/{productId} or /apis or /apis/{apiId}.

secondaryKey

val secondaryKey: String? = null

Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

startDate

val startDate: String? = null

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.

state

val state: String

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.

stateComment

val stateComment: String? = null

Optional subscription comment added by an administrator when the state is changed to the 'rejected'.

type

val type: String

Resource type for API Management resource.