Package-level declarations

Types

Link copied to clipboard
class Api : KotlinCustomResource

API entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class ApiArgs(val apiName: Output<String>? = null, val contacts: Output<List<ContactArgs>>? = null, val customProperties: Output<Any>? = null, val description: Output<String>? = null, val externalDocumentation: Output<List<ExternalDocumentationArgs>>? = null, val kind: Output<Either<String, ApiKind>>? = null, val license: Output<LicenseArgs>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val summary: Output<String>? = null, val termsOfService: Output<TermsOfServiceArgs>? = null, val title: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<ApiArgs>

API entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard

Builder for ApiArgs.

Link copied to clipboard
Link copied to clipboard
class ApiDefinition : KotlinCustomResource

API definition entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class ApiDefinitionArgs(val apiName: Output<String>? = null, val definitionName: Output<String>? = null, val description: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val title: Output<String>? = null, val versionName: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<ApiDefinitionArgs>

API definition entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object ApiDefinitionMapper : ResourceMapper<ApiDefinition>
Link copied to clipboard
Link copied to clipboard
object ApiMapper : ResourceMapper<Api>
Link copied to clipboard

Builder for Api.

Link copied to clipboard
class ApiSource : KotlinCustomResource

API source entity. Uses Azure REST API version 2024-06-01-preview.

Link copied to clipboard
data class ApiSourceArgs(val apiSourceName: Output<String>? = null, val azureApiManagementSource: Output<AzureApiManagementSourceArgs>? = null, val importSpecification: Output<Either<String, ImportSpecificationOptions>>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val targetEnvironmentId: Output<String>? = null, val targetLifecycleStage: Output<Either<String, LifecycleStage>>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<ApiSourceArgs>

API source entity. Uses Azure REST API version 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object ApiSourceMapper : ResourceMapper<ApiSource>
Link copied to clipboard
Link copied to clipboard
class ApiVersion : KotlinCustomResource

API version entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class ApiVersionArgs(val apiName: Output<String>? = null, val lifecycleStage: Output<Either<String, LifecycleStage>>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val title: Output<String>? = null, val versionName: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<ApiVersionArgs>

API version entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object ApiVersionMapper : ResourceMapper<ApiVersion>
Link copied to clipboard
Link copied to clipboard
class Deployment : KotlinCustomResource

API deployment entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class DeploymentArgs(val apiName: Output<String>? = null, val customProperties: Output<Any>? = null, val definitionId: Output<String>? = null, val deploymentName: Output<String>? = null, val description: Output<String>? = null, val environmentId: Output<String>? = null, val resourceGroupName: Output<String>? = null, val server: Output<DeploymentServerArgs>? = null, val serviceName: Output<String>? = null, val state: Output<Either<String, DeploymentState>>? = null, val title: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<DeploymentArgs>

API deployment entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object DeploymentMapper : ResourceMapper<Deployment>
Link copied to clipboard
Link copied to clipboard
class Environment : KotlinCustomResource

Environment entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class EnvironmentArgs(val customProperties: Output<Any>? = null, val description: Output<String>? = null, val environmentName: Output<String>? = null, val kind: Output<Either<String, EnvironmentKind>>? = null, val onboarding: Output<OnboardingArgs>? = null, val resourceGroupName: Output<String>? = null, val server: Output<EnvironmentServerArgs>? = null, val serviceName: Output<String>? = null, val title: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<EnvironmentArgs>

Environment entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object EnvironmentMapper : ResourceMapper<Environment>
Link copied to clipboard
Link copied to clipboard
class MetadataSchema : KotlinCustomResource

Metadata schema entity. Used to define metadata for the entities in API catalog. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class MetadataSchemaArgs(val assignedTo: Output<List<MetadataAssignmentArgs>>? = null, val metadataSchemaName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val schema: Output<String>? = null, val serviceName: Output<String>? = null) : ConvertibleToJava<MetadataSchemaArgs>

Metadata schema entity. Used to define metadata for the entities in API catalog. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object MetadataSchemaMapper : ResourceMapper<MetadataSchema>
Link copied to clipboard
class Service : KotlinCustomResource

The service entity. Uses Azure REST API version 2023-07-01-preview. Other available API versions: 2024-03-01, 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class ServiceArgs(val identity: Output<ManagedServiceIdentityArgs>? = null, val location: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<ServiceArgs>

The service entity. Uses Azure REST API version 2023-07-01-preview. Other available API versions: 2024-03-01, 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object ServiceMapper : ResourceMapper<Service>
Link copied to clipboard
Link copied to clipboard
class Workspace : KotlinCustomResource

Workspace entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
data class WorkspaceArgs(val description: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val title: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<WorkspaceArgs>

Workspace entity. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-03-15-preview, 2024-06-01-preview.

Link copied to clipboard
Link copied to clipboard
object WorkspaceMapper : ResourceMapper<Workspace>
Link copied to clipboard

Functions

Link copied to clipboard
fun api(name: String): Api
suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api
Link copied to clipboard
Link copied to clipboard
suspend fun apiSource(name: String, block: suspend ApiSourceResourceBuilder.() -> Unit): ApiSource
Link copied to clipboard
suspend fun apiVersion(name: String, block: suspend ApiVersionResourceBuilder.() -> Unit): ApiVersion
Link copied to clipboard
suspend fun deployment(name: String, block: suspend DeploymentResourceBuilder.() -> Unit): Deployment
Link copied to clipboard
suspend fun environment(name: String, block: suspend EnvironmentResourceBuilder.() -> Unit): Environment
Link copied to clipboard
Link copied to clipboard
fun service(name: String): Service
suspend fun service(name: String, block: suspend ServiceResourceBuilder.() -> Unit): Service
Link copied to clipboard
suspend fun workspace(name: String, block: suspend WorkspaceResourceBuilder.() -> Unit): Workspace