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

Package-level declarations

Types

ApiDefinitionPropertiesSpecificationResponse

data class ApiDefinitionPropertiesSpecificationResponse(val name: String? = null, val version: String? = null)

API specification details.

AzureApiManagementSourceResponse

data class AzureApiManagementSourceResponse(val msiResourceId: String? = null, val resourceId: String)

API source configuration for Azure API Management.

ContactResponse

data class ContactResponse(val email: String? = null, val name: String? = null, val url: String? = null)

Contact information

DeploymentServerResponse

data class DeploymentServerResponse(val runtimeUri: List<String>? = null)

Server

EnvironmentServerResponse

data class EnvironmentServerResponse(val managementPortalUri: List<String>? = null, val type: String? = null)

Server information of the environment.

ExternalDocumentationResponse

data class ExternalDocumentationResponse(val description: String? = null, val title: String? = null, val url: String)

Additional, external documentation for the API.

GetApiDefinitionResult

data class GetApiDefinitionResult(val description: String? = null, val id: String, val name: String, val specification: ApiDefinitionPropertiesSpecificationResponse, val systemData: SystemDataResponse, val title: String, val type: String)

API definition entity.

GetApiResult

data class GetApiResult(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.

GetApiSourceResult

data class GetApiSourceResult(val azureApiManagementSource: AzureApiManagementSourceResponse? = null, val id: String, val importSpecification: String? = null, val linkState: LinkStateResponse, val name: String, val systemData: SystemDataResponse, val targetEnvironmentId: String? = null, val targetLifecycleStage: String? = null, val type: String)

API source entity.

GetApiVersionResult

data class GetApiVersionResult(val id: String, val lifecycleStage: String, val name: String, val systemData: SystemDataResponse, val title: String, val type: String)

API version entity.

GetDeploymentResult

data class GetDeploymentResult(val customProperties: Any? = null, val definitionId: String? = null, val description: String? = null, val environmentId: String? = null, val id: String, val name: String, val server: DeploymentServerResponse? = null, val state: String? = null, val systemData: SystemDataResponse, val title: String? = null, val type: String)

API deployment entity.

GetEnvironmentResult

data class GetEnvironmentResult(val customProperties: Any? = null, val description: String? = null, val id: String, val kind: String, val name: String, val onboarding: OnboardingResponse? = null, val server: EnvironmentServerResponse? = null, val systemData: SystemDataResponse, val title: String, val type: String)

Environment entity.

GetMetadataSchemaResult

data class GetMetadataSchemaResult(val assignedTo: List<MetadataAssignmentResponse>? = null, val id: String, val name: String, val schema: String, val systemData: SystemDataResponse, val type: String)

Metadata schema entity. Used to define metadata for the entities in API catalog.

GetServiceResult

data class GetServiceResult(val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The service entity.

GetWorkspaceResult

data class GetWorkspaceResult(val description: String? = null, val id: String, val name: String, val systemData: SystemDataResponse, val title: String, val type: String)

Workspace entity.

LicenseResponse

data class LicenseResponse(val identifier: String? = null, val name: String? = null, val url: String? = null)

The license information for the API.

LinkStateResponse

data class LinkStateResponse(val lastUpdatedOn: String, val message: String? = null, val state: String? = null)

The link state.

ManagedServiceIdentityResponse

data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

MetadataAssignmentResponse

data class MetadataAssignmentResponse(val deprecated: Boolean? = null, val entity: String? = null, val required: Boolean? = null)

Assignment metadata

OnboardingResponse

data class OnboardingResponse(val developerPortalUri: List<String>? = null, val instructions: String? = null)

Onboarding information

SystemDataResponse

data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

TermsOfServiceResponse

data class TermsOfServiceResponse(val url: String)

UserAssignedIdentityResponse

data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties