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

GetApiResult

data class GetApiResult(val azureApiVersion: String, val contacts: List<ContactResponse>? = null, val customProperties: Any? = null, val description: String? = null, val externalDocumentation: List<ExternalDocumentationResponse>? = null, val id: String, val kind: String, val license: LicenseResponse? = null, val lifecycleStage: String, val name: String, val summary: String? = null, val systemData: SystemDataResponse, val termsOfService: TermsOfServiceResponse? = null, val title: String, val type: String)

API entity.

Constructors

Link copied to clipboard
constructor(azureApiVersion: String, contacts: List<ContactResponse>? = null, customProperties: Any? = null, description: String? = null, externalDocumentation: List<ExternalDocumentationResponse>? = null, id: String, kind: String, license: LicenseResponse? = null, lifecycleStage: String, name: String, summary: String? = null, systemData: SystemDataResponse, termsOfService: TermsOfServiceResponse? = null, title: String, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val azureApiVersion: String

The Azure API version of the resource.

Link copied to clipboard
val contacts: List<ContactResponse>? = null

The set of contacts

Link copied to clipboard
val customProperties: Any? = null

The custom metadata defined for API catalog entities.

Link copied to clipboard
val description: String? = null

Description of the API.

Link copied to clipboard
val externalDocumentation: List<ExternalDocumentationResponse>? = null

The set of external documentation

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

Link copied to clipboard
val kind: String

Kind of API. For example, REST or GraphQL.

Link copied to clipboard
val license: LicenseResponse? = null

The license information for the API.

Link copied to clipboard
val lifecycleStage: String

Current lifecycle stage of the API.

Link copied to clipboard
val name: String

The name of the resource

Link copied to clipboard
val summary: String? = null

Short description of the API.

Link copied to clipboard
val systemData: SystemDataResponse

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val termsOfService: TermsOfServiceResponse? = null

Terms of service for the API.

Link copied to clipboard
val title: String

API title.

Link copied to clipboard
val type: String

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