pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin.outputs/GetApiResult

GetApiResult

data class GetApiResult(val apiManagementName: String, val description: String, val displayName: String, val id: String, val isCurrent: Boolean, val isOnline: Boolean, val name: String, val path: String, val protocols: List<String>, val resourceGroupName: String, val revision: String, val serviceUrl: String, val soapPassThrough: Boolean, val subscriptionKeyParameterNames: List<GetApiSubscriptionKeyParameterName>, val subscriptionRequired: Boolean, val version: String, val versionSetId: String)

A collection of values returned by getApi.

Constructors

constructor(apiManagementName: String, description: String, displayName: String, id: String, isCurrent: Boolean, isOnline: Boolean, name: String, path: String, protocols: List<String>, resourceGroupName: String, revision: String, serviceUrl: String, soapPassThrough: Boolean, subscriptionKeyParameterNames: List<GetApiSubscriptionKeyParameterName>, subscriptionRequired: Boolean, version: String, versionSetId: String)

Types

object Companion

Properties

apiManagementName

val apiManagementName: String

val description: String

A description of the API Management API, which may include HTML formatting tags.

val displayName: String

The display name of the API.

The provider-assigned unique ID for this managed resource.

val isCurrent: Boolean

Is this the current API Revision?

val isOnline: Boolean

Is this API Revision online/accessible via the Gateway?

val name: String

val path: String

The Path for this API Management API.

val protocols: List<String>

A list of protocols the operations in this API can be invoked.

resourceGroupName

val resourceGroupName: String

val revision: String

val serviceUrl: String

Absolute URL of the backend service implementing this API.

soapPassThrough

val soapPassThrough: Boolean

Should this API expose a SOAP frontend, rather than a HTTP frontend?

subscriptionKeyParameterNames

val subscriptionKeyParameterNames: List<GetApiSubscriptionKeyParameterName>

A subscription_key_parameter_names block as documented below.

subscriptionRequired

val subscriptionRequired: Boolean

Should this API require a subscription key?

val version: String

The Version number of this API, if this API is versioned.

val versionSetId: String

The ID of the Version Set which this API is associated with.