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

GetWorkspaceApiResult

data class GetWorkspaceApiResult(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 contact: ApiContactInformationResponse? = null, val description: String? = null, val displayName: String? = null, val id: String, val isCurrent: Boolean? = null, val isOnline: Boolean, val license: ApiLicenseInformationResponse? = null, 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 termsOfServiceUrl: String? = null, val type: String)

API details.

Constructors

fun GetWorkspaceApiResult(apiRevision: String? = null, apiRevisionDescription: String? = null, apiType: String? = null, apiVersion: String? = null, apiVersionDescription: String? = null, apiVersionSet: ApiVersionSetContractDetailsResponse? = null, apiVersionSetId: String? = null, authenticationSettings: AuthenticationSettingsContractResponse? = null, contact: ApiContactInformationResponse? = null, description: String? = null, displayName: String? = null, id: String, isCurrent: Boolean? = null, isOnline: Boolean, license: ApiLicenseInformationResponse? = null, name: String, path: String, protocols: List<String>? = null, serviceUrl: String? = null, sourceApiId: String? = null, subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null, subscriptionRequired: Boolean? = null, termsOfServiceUrl: String? = 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.

contact

val contact: ApiContactInformationResponse? = null

Contact information for the 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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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.

license

val license: ApiLicenseInformationResponse? = null

License information for the API.

name

val name: String

The name of the resource

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