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

GetApiResult

data class GetApiResult(val apiRevision: String? = null, val apiRevisionDescription: String? = null, val apiType: String? = null, val apiVersion: String? = null, val apiVersionDescription: String? = null, val apiVersionSet: ApiVersionSetContractDetailsResponse? = null, val apiVersionSetId: String? = null, val authenticationSettings: AuthenticationSettingsContractResponse? = null, val description: String? = null, val displayName: String? = null, val id: String, val isCurrent: Boolean? = null, val isOnline: Boolean, val name: String, val path: String, val protocols: List<String>? = null, val serviceUrl: String? = null, val sourceApiId: String? = null, val subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null, val subscriptionRequired: Boolean? = null, val type: String)

Api details.

Constructors

GetApiResult

constructor(apiRevision: String? = null, apiRevisionDescription: String? = null, apiType: String? = null, apiVersion: String? = null, apiVersionDescription: String? = null, apiVersionSet: ApiVersionSetContractDetailsResponse? = null, apiVersionSetId: String? = null, authenticationSettings: AuthenticationSettingsContractResponse? = null, description: String? = null, displayName: String? = null, id: String, isCurrent: Boolean? = null, isOnline: Boolean, name: String, path: String, protocols: List<String>? = null, serviceUrl: String? = null, sourceApiId: String? = null, subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null, subscriptionRequired: Boolean? = null, type: String)

Types

Companion

object Companion

Properties

apiRevision

val apiRevision: String? = null

Describes the Revision of the Api. If no value is provided, default revision 1 is created

apiRevisionDescription

val apiRevisionDescription: String? = null

Description of the Api Revision.

apiType

val apiType: String? = null

Type of API.

apiVersion

val apiVersion: String? = null

Indicates the Version identifier of the API if the API is versioned

apiVersionDescription

val apiVersionDescription: String? = null

Description of the Api Version.

apiVersionSet

val apiVersionSet: ApiVersionSetContractDetailsResponse? = null

Version set details

apiVersionSetId

val apiVersionSetId: String? = null

A resource identifier for the related ApiVersionSet.

authenticationSettings

val authenticationSettings: AuthenticationSettingsContractResponse? = null

Collection of authentication settings included into this API.

description

val description: String? = null

Description of the API. May include HTML formatting tags.

displayName

val displayName: String? = null

API name. Must be 1 to 300 characters long.

val id: String

Resource ID.

isCurrent

val isCurrent: Boolean? = null

Indicates if API revision is current api revision.

isOnline

val isOnline: Boolean

Indicates if API revision is accessible via the gateway.

name

val name: String

Resource name.

path

val path: String

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

protocols

val protocols: List<String>? = null

Describes on which protocols the operations in this API can be invoked.

serviceUrl

val serviceUrl: String? = null

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

sourceApiId

val sourceApiId: String? = null

API identifier of the source API.

subscriptionKeyParameterNames

val subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null

Protocols over which API is made available.