com.pulumi.azurenative.apimanagement.kotlin.ApiSchema.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-native-kotlin Show documentation
Show all versions of pulumi-azure-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azurenative.apimanagement.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [ApiSchema].
*/
@PulumiTagMarker
public class ApiSchemaResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiSchemaArgs = ApiSchemaArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ApiSchemaArgsBuilder.() -> Unit) {
val builder = ApiSchemaArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ApiSchema {
val builtJavaResource = com.pulumi.azurenative.apimanagement.ApiSchema(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ApiSchema(builtJavaResource)
}
}
/**
* API Schema Contract details.
* Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
* Other available API versions: 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
* ## Example Usage
* ### ApiManagementCreateApiSchema
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var apiSchema = new AzureNative.ApiManagement.ApiSchema("apiSchema", new()
* {
* ApiId = "59d6bb8f1f7fab13dc67ec9b",
* ContentType = "application/vnd.ms-azure-apim.xsd+xml",
* ResourceGroupName = "rg1",
* SchemaId = "ec12520d-9d48-4e7b-8f39-698ca2ac63f1",
* ServiceName = "apimService1",
* Value = @"
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* ",
* });
* });
* ```
* ```go
* package main
* import (
* apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apimanagement.NewApiSchema(ctx, "apiSchema", &apimanagement.ApiSchemaArgs{
* ApiId: pulumi.String("59d6bb8f1f7fab13dc67ec9b"),
* ContentType: pulumi.String("application/vnd.ms-azure-apim.xsd+xml"),
* ResourceGroupName: pulumi.String("rg1"),
* SchemaId: pulumi.String("ec12520d-9d48-4e7b-8f39-698ca2ac63f1"),
* ServiceName: pulumi.String("apimService1"),
* Value: pulumi.String(`
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* `),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apimanagement.ApiSchema;
* import com.pulumi.azurenative.apimanagement.ApiSchemaArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var apiSchema = new ApiSchema("apiSchema", ApiSchemaArgs.builder()
* .apiId("59d6bb8f1f7fab13dc67ec9b")
* .contentType("application/vnd.ms-azure-apim.xsd+xml")
* .resourceGroupName("rg1")
* .schemaId("ec12520d-9d48-4e7b-8f39-698ca2ac63f1")
* .serviceName("apimService1")
* .value("""
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* """)
* .build());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:apimanagement:ApiSchema ec12520d-9d48-4e7b-8f39-698ca2ac63f1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
* ```
*/
public class ApiSchema internal constructor(
override val javaResource: com.pulumi.azurenative.apimanagement.ApiSchema,
) : KotlinCustomResource(javaResource, ApiSchemaMapper) {
/**
* Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
*/
public val components: Output?
get() = javaResource.components().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.
*/
public val contentType: Output
get() = javaResource.contentType().applyValue({ args0 -> args0 })
/**
* Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
*/
public val definitions: Output?
get() = javaResource.definitions().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the resource
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
*/
public val `value`: Output?
get() = javaResource.`value`().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}
public object ApiSchemaMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azurenative.apimanagement.ApiSchema::class == javaResource::class
override fun map(javaResource: Resource): ApiSchema = ApiSchema(
javaResource as
com.pulumi.azurenative.apimanagement.ApiSchema,
)
}
/**
* @see [ApiSchema].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ApiSchema].
*/
public suspend fun apiSchema(name: String, block: suspend ApiSchemaResourceBuilder.() -> Unit): ApiSchema {
val builder = ApiSchemaResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ApiSchema].
* @param name The _unique_ name of the resulting resource.
*/
public fun apiSchema(name: String): ApiSchema {
val builder = ApiSchemaResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy