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

Link copied to clipboard
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, 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

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiRevision: String? = null

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

Link copied to clipboard
val apiRevisionDescription: String? = null

Description of the API Revision.

Link copied to clipboard
val apiType: String? = null

Type of API.

Link copied to clipboard
val apiVersion: String? = null

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

Link copied to clipboard
val apiVersionDescription: String? = null

Description of the API Version.

Link copied to clipboard
val apiVersionSet: ApiVersionSetContractDetailsResponse? = null

Version set details

Link copied to clipboard
val apiVersionSetId: String? = null

A resource identifier for the related ApiVersionSet.

Link copied to clipboard
val authenticationSettings: AuthenticationSettingsContractResponse? = null

Collection of authentication settings included into this API.

Link copied to clipboard
val contact: ApiContactInformationResponse? = null

Contact information for the API.

Link copied to clipboard
val description: String? = null

Description of the API. May include HTML formatting tags.

Link copied to clipboard
val displayName: String? = null

API name. Must be 1 to 300 characters long.

Link copied to clipboard
val id: String

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

Link copied to clipboard
val isCurrent: Boolean? = null

Indicates if API revision is current api revision.

Link copied to clipboard
val isOnline: Boolean

Indicates if API revision is accessible via the gateway.

Link copied to clipboard
val license: ApiLicenseInformationResponse? = null

License information for the API.

Link copied to clipboard
val name: String

The name of the resource

Link copied to clipboard
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.

Link copied to clipboard
val protocols: List<String>? = null

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

Link copied to clipboard
val serviceUrl: String? = null

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

Link copied to clipboard
val sourceApiId: String? = null

API identifier of the source API.

Link copied to clipboard
val subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContractResponse? = null

Protocols over which API is made available.

Link copied to clipboard
val subscriptionRequired: Boolean? = null

Specifies whether an API or Product subscription is required for accessing the API.

Link copied to clipboard
val termsOfServiceUrl: String? = null

A URL to the Terms of Service for the API. MUST be in the format of a URL.

Link copied to clipboard
val type: String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"