Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.kotlin
import com.pulumi.azure.apimanagement.ApiArgs.builder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiContactArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiContactArgsBuilder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiImportArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiImportArgsBuilder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiLicenseArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiLicenseArgsBuilder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiOauth2AuthorizationArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiOauth2AuthorizationArgsBuilder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiOpenidAuthenticationArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiOpenidAuthenticationArgsBuilder
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiSubscriptionKeyParameterNamesArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.ApiSubscriptionKeyParameterNamesArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Manages an API within an API Management Service.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleService = new azure.apimanagement.Service("example", {
* name: "example-apim",
* location: example.location,
* resourceGroupName: example.name,
* publisherName: "My Company",
* publisherEmail: "[email protected]",
* skuName: "Developer_1",
* });
* const exampleApi = new azure.apimanagement.Api("example", {
* name: "example-api",
* resourceGroupName: example.name,
* apiManagementName: exampleService.name,
* revision: "1",
* displayName: "Example API",
* path: "example",
* protocols: ["https"],
* "import": {
* contentFormat: "swagger-link-json",
* contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_service = azure.apimanagement.Service("example",
* name="example-apim",
* location=example.location,
* resource_group_name=example.name,
* publisher_name="My Company",
* publisher_email="[email protected]",
* sku_name="Developer_1")
* example_api = azure.apimanagement.Api("example",
* name="example-api",
* resource_group_name=example.name,
* api_management_name=example_service.name,
* revision="1",
* display_name="Example API",
* path="example",
* protocols=["https"],
* import_={
* "content_format": "swagger-link-json",
* "content_value": "http://conferenceapi.azurewebsites.net/?format=json",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleService = new Azure.ApiManagement.Service("example", new()
* {
* Name = "example-apim",
* Location = example.Location,
* ResourceGroupName = example.Name,
* PublisherName = "My Company",
* PublisherEmail = "[email protected]",
* SkuName = "Developer_1",
* });
* var exampleApi = new Azure.ApiManagement.Api("example", new()
* {
* Name = "example-api",
* ResourceGroupName = example.Name,
* ApiManagementName = exampleService.Name,
* Revision = "1",
* DisplayName = "Example API",
* Path = "example",
* Protocols = new[]
* {
* "https",
* },
* Import = new Azure.ApiManagement.Inputs.ApiImportArgs
* {
* ContentFormat = "swagger-link-json",
* ContentValue = "http://conferenceapi.azurewebsites.net/?format=json",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
* Name: pulumi.String("example-apim"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* PublisherName: pulumi.String("My Company"),
* PublisherEmail: pulumi.String("[email protected]"),
* SkuName: pulumi.String("Developer_1"),
* })
* if err != nil {
* return err
* }
* _, err = apimanagement.NewApi(ctx, "example", &apimanagement.ApiArgs{
* Name: pulumi.String("example-api"),
* ResourceGroupName: example.Name,
* ApiManagementName: exampleService.Name,
* Revision: pulumi.String("1"),
* DisplayName: pulumi.String("Example API"),
* Path: pulumi.String("example"),
* Protocols: pulumi.StringArray{
* pulumi.String("https"),
* },
* Import: &apimanagement.ApiImportArgs{
* ContentFormat: pulumi.String("swagger-link-json"),
* ContentValue: pulumi.String("http://conferenceapi.azurewebsites.net/?format=json"),
* },
* })
* 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.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.apimanagement.Service;
* import com.pulumi.azure.apimanagement.ServiceArgs;
* import com.pulumi.azure.apimanagement.Api;
* import com.pulumi.azure.apimanagement.ApiArgs;
* import com.pulumi.azure.apimanagement.inputs.ApiImportArgs;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleService = new Service("exampleService", ServiceArgs.builder()
* .name("example-apim")
* .location(example.location())
* .resourceGroupName(example.name())
* .publisherName("My Company")
* .publisherEmail("[email protected]")
* .skuName("Developer_1")
* .build());
* var exampleApi = new Api("exampleApi", ApiArgs.builder()
* .name("example-api")
* .resourceGroupName(example.name())
* .apiManagementName(exampleService.name())
* .revision("1")
* .displayName("Example API")
* .path("example")
* .protocols("https")
* .import_(ApiImportArgs.builder()
* .contentFormat("swagger-link-json")
* .contentValue("http://conferenceapi.azurewebsites.net/?format=json")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleService:
* type: azure:apimanagement:Service
* name: example
* properties:
* name: example-apim
* location: ${example.location}
* resourceGroupName: ${example.name}
* publisherName: My Company
* publisherEmail: [email protected]
* skuName: Developer_1
* exampleApi:
* type: azure:apimanagement:Api
* name: example
* properties:
* name: example-api
* resourceGroupName: ${example.name}
* apiManagementName: ${exampleService.name}
* revision: '1'
* displayName: Example API
* path: example
* protocols:
* - https
* import:
* contentFormat: swagger-link-json
* contentValue: http://conferenceapi.azurewebsites.net/?format=json
* ```
*
* ## Import
* API Management API's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/api:Api example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1;rev=1
* ```
* @property apiManagementName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
* @property apiType Type of API. Possible values are `graphql`, `http`, `soap`, and `websocket`. Defaults to `http`.
* @property contact A `contact` block as documented below.
* @property description A description of the API Management API, which may include HTML formatting tags.
* @property displayName The display name of the API.
* @property import A `import` block as documented below.
* @property license A `license` block as documented below.
* @property name The name of the API Management API. Changing this forces a new resource to be created.
* @property oauth2Authorization An `oauth2_authorization` block as documented below.
* @property openidAuthentication An `openid_authentication` block as documented below.
* @property path The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
* @property protocols A list of protocols the operations in this API can be invoked. Possible values are `http`, `https`, `ws`, and `wss`.
* > **NOTE:** `display_name`, `path` and `protocols` are required when `source_api_id` is not set.
* @property resourceGroupName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
* @property revision The Revision which used for this API. Changing this forces a new resource to be created.
* @property revisionDescription The description of the API Revision of the API Management API.
* @property serviceUrl Absolute URL of the backend service implementing this API.
* @property soapPassThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.
* > **NOTE:** This property has been deprecated in favour of the `api_type` property and will be removed in version 4.0 of the provider.
* @property sourceApiId The API id of the source API, which could be in format `azurerm_api_management_api.example.id` or in format `azurerm_api_management_api.example.id;rev=1`
* @property subscriptionKeyParameterNames A `subscription_key_parameter_names` block as documented below.
* @property subscriptionRequired Should this API require a subscription key? Defaults to `true`.
* @property termsOfServiceUrl Absolute URL of the Terms of Service for the API.
* @property version The Version number of this API, if this API is versioned.
* @property versionDescription The description of the API Version of the API Management API.
* @property versionSetId The ID of the Version Set which this API is associated with.
* > **NOTE:** When `version` is set, `version_set_id` must also be specified
*/
public data class ApiArgs(
public val apiManagementName: Output? = null,
public val apiType: Output? = null,
public val contact: Output? = null,
public val description: Output? = null,
public val displayName: Output? = null,
public val `import`: Output? = null,
public val license: Output? = null,
public val name: Output? = null,
public val oauth2Authorization: Output? = null,
public val openidAuthentication: Output? = null,
public val path: Output? = null,
public val protocols: Output>? = null,
public val resourceGroupName: Output? = null,
public val revision: Output? = null,
public val revisionDescription: Output? = null,
public val serviceUrl: Output? = null,
@Deprecated(
message = """
`soap_pass_through` will be removed in favour of the property `api_type` in version 4.0 of the
AzureRM Provider
""",
)
public val soapPassThrough: Output? = null,
public val sourceApiId: Output? = null,
public val subscriptionKeyParameterNames: Output? = null,
public val subscriptionRequired: Output? = null,
public val termsOfServiceUrl: Output? = null,
public val version: Output? = null,
public val versionDescription: Output? = null,
public val versionSetId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.apimanagement.ApiArgs =
com.pulumi.azure.apimanagement.ApiArgs.builder()
.apiManagementName(apiManagementName?.applyValue({ args0 -> args0 }))
.apiType(apiType?.applyValue({ args0 -> args0 }))
.contact(contact?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.import_(`import`?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.license(license?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.name(name?.applyValue({ args0 -> args0 }))
.oauth2Authorization(
oauth2Authorization?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.openidAuthentication(
openidAuthentication?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.path(path?.applyValue({ args0 -> args0 }))
.protocols(protocols?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.revision(revision?.applyValue({ args0 -> args0 }))
.revisionDescription(revisionDescription?.applyValue({ args0 -> args0 }))
.serviceUrl(serviceUrl?.applyValue({ args0 -> args0 }))
.soapPassThrough(soapPassThrough?.applyValue({ args0 -> args0 }))
.sourceApiId(sourceApiId?.applyValue({ args0 -> args0 }))
.subscriptionKeyParameterNames(
subscriptionKeyParameterNames?.applyValue({ args0 ->
args0.let({ args0 -> args0.toJava() })
}),
)
.subscriptionRequired(subscriptionRequired?.applyValue({ args0 -> args0 }))
.termsOfServiceUrl(termsOfServiceUrl?.applyValue({ args0 -> args0 }))
.version(version?.applyValue({ args0 -> args0 }))
.versionDescription(versionDescription?.applyValue({ args0 -> args0 }))
.versionSetId(versionSetId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ApiArgs].
*/
@PulumiTagMarker
public class ApiArgsBuilder internal constructor() {
private var apiManagementName: Output? = null
private var apiType: Output? = null
private var contact: Output? = null
private var description: Output? = null
private var displayName: Output? = null
private var `import`: Output? = null
private var license: Output? = null
private var name: Output? = null
private var oauth2Authorization: Output? = null
private var openidAuthentication: Output? = null
private var path: Output? = null
private var protocols: Output>? = null
private var resourceGroupName: Output? = null
private var revision: Output? = null
private var revisionDescription: Output? = null
private var serviceUrl: Output? = null
private var soapPassThrough: Output? = null
private var sourceApiId: Output? = null
private var subscriptionKeyParameterNames: Output? = null
private var subscriptionRequired: Output? = null
private var termsOfServiceUrl: Output? = null
private var version: Output? = null
private var versionDescription: Output? = null
private var versionSetId: Output? = null
/**
* @param value The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
*/
@JvmName("rsjukdmpkcdudokh")
public suspend fun apiManagementName(`value`: Output) {
this.apiManagementName = value
}
/**
* @param value Type of API. Possible values are `graphql`, `http`, `soap`, and `websocket`. Defaults to `http`.
*/
@JvmName("urqgkqxdfjbrpfbp")
public suspend fun apiType(`value`: Output) {
this.apiType = value
}
/**
* @param value A `contact` block as documented below.
*/
@JvmName("beqcsnbwypddqyxk")
public suspend fun contact(`value`: Output) {
this.contact = value
}
/**
* @param value A description of the API Management API, which may include HTML formatting tags.
*/
@JvmName("efjrhufluqqegwdx")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The display name of the API.
*/
@JvmName("cbsnixpgephcjnqw")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value A `import` block as documented below.
*/
@JvmName("vovufdxvtfvkhjkk")
public suspend fun `import`(`value`: Output) {
this.`import` = value
}
/**
* @param value A `license` block as documented below.
*/
@JvmName("arkahxeyuibvgsbv")
public suspend fun license(`value`: Output) {
this.license = value
}
/**
* @param value The name of the API Management API. Changing this forces a new resource to be created.
*/
@JvmName("cuxyfsefdrnescku")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value An `oauth2_authorization` block as documented below.
*/
@JvmName("mkojclvsesudkqfw")
public suspend fun oauth2Authorization(`value`: Output) {
this.oauth2Authorization = value
}
/**
* @param value An `openid_authentication` block as documented below.
*/
@JvmName("rbvtxvrkqjhthrgh")
public suspend fun openidAuthentication(`value`: Output) {
this.openidAuthentication = value
}
/**
* @param value The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
*/
@JvmName("lyxxquvnaqitmlbi")
public suspend fun path(`value`: Output) {
this.path = value
}
/**
* @param value A list of protocols the operations in this API can be invoked. Possible values are `http`, `https`, `ws`, and `wss`.
* > **NOTE:** `display_name`, `path` and `protocols` are required when `source_api_id` is not set.
*/
@JvmName("difgvcwdcmglgedo")
public suspend fun protocols(`value`: Output>) {
this.protocols = value
}
@JvmName("eusypwcllljcilhu")
public suspend fun protocols(vararg values: Output) {
this.protocols = Output.all(values.asList())
}
/**
* @param values A list of protocols the operations in this API can be invoked. Possible values are `http`, `https`, `ws`, and `wss`.
* > **NOTE:** `display_name`, `path` and `protocols` are required when `source_api_id` is not set.
*/
@JvmName("csdmauwbvbedacab")
public suspend fun protocols(values: List>) {
this.protocols = Output.all(values)
}
/**
* @param value The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
*/
@JvmName("ojcutdscmmwaqfqm")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The Revision which used for this API. Changing this forces a new resource to be created.
*/
@JvmName("cfebkcnyrlrutrwq")
public suspend fun revision(`value`: Output) {
this.revision = value
}
/**
* @param value The description of the API Revision of the API Management API.
*/
@JvmName("owgeqmrmrnbpmkoa")
public suspend fun revisionDescription(`value`: Output) {
this.revisionDescription = value
}
/**
* @param value Absolute URL of the backend service implementing this API.
*/
@JvmName("bblhbctbniyihcgw")
public suspend fun serviceUrl(`value`: Output) {
this.serviceUrl = value
}
/**
* @param value Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.
* > **NOTE:** This property has been deprecated in favour of the `api_type` property and will be removed in version 4.0 of the provider.
*/
@Deprecated(
message = """
`soap_pass_through` will be removed in favour of the property `api_type` in version 4.0 of the
AzureRM Provider
""",
)
@JvmName("lxtwulkbtbtsybfk")
public suspend fun soapPassThrough(`value`: Output) {
this.soapPassThrough = value
}
/**
* @param value The API id of the source API, which could be in format `azurerm_api_management_api.example.id` or in format `azurerm_api_management_api.example.id;rev=1`
*/
@JvmName("llgxumkhchgpxdau")
public suspend fun sourceApiId(`value`: Output) {
this.sourceApiId = value
}
/**
* @param value A `subscription_key_parameter_names` block as documented below.
*/
@JvmName("rprlgdaknbgabpch")
public suspend fun subscriptionKeyParameterNames(`value`: Output) {
this.subscriptionKeyParameterNames = value
}
/**
* @param value Should this API require a subscription key? Defaults to `true`.
*/
@JvmName("rybnjjyprogopest")
public suspend fun subscriptionRequired(`value`: Output) {
this.subscriptionRequired = value
}
/**
* @param value Absolute URL of the Terms of Service for the API.
*/
@JvmName("twwckbjkgassvdwq")
public suspend fun termsOfServiceUrl(`value`: Output) {
this.termsOfServiceUrl = value
}
/**
* @param value The Version number of this API, if this API is versioned.
*/
@JvmName("afhjltybiuxokops")
public suspend fun version(`value`: Output) {
this.version = value
}
/**
* @param value The description of the API Version of the API Management API.
*/
@JvmName("wfccehdhmfsooxod")
public suspend fun versionDescription(`value`: Output) {
this.versionDescription = value
}
/**
* @param value The ID of the Version Set which this API is associated with.
* > **NOTE:** When `version` is set, `version_set_id` must also be specified
*/
@JvmName("bnjewarrvilncfjo")
public suspend fun versionSetId(`value`: Output) {
this.versionSetId = value
}
/**
* @param value The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
*/
@JvmName("bvmpeehvfadlxqhb")
public suspend fun apiManagementName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiManagementName = mapped
}
/**
* @param value Type of API. Possible values are `graphql`, `http`, `soap`, and `websocket`. Defaults to `http`.
*/
@JvmName("urrfnffctbovkoua")
public suspend fun apiType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiType = mapped
}
/**
* @param value A `contact` block as documented below.
*/
@JvmName("tfhfemeaqopunwja")
public suspend fun contact(`value`: ApiContactArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.contact = mapped
}
/**
* @param argument A `contact` block as documented below.
*/
@JvmName("smgukbvhqexlffps")
public suspend fun contact(argument: suspend ApiContactArgsBuilder.() -> Unit) {
val toBeMapped = ApiContactArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.contact = mapped
}
/**
* @param value A description of the API Management API, which may include HTML formatting tags.
*/
@JvmName("mxcqahusnuswhokn")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The display name of the API.
*/
@JvmName("sleabdgjemdobtso")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value A `import` block as documented below.
*/
@JvmName("lbkybybttcqvxsou")
public suspend fun `import`(`value`: ApiImportArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.`import` = mapped
}
/**
* @param argument A `import` block as documented below.
*/
@JvmName("obyraxixynwsvaow")
public suspend fun `import`(argument: suspend ApiImportArgsBuilder.() -> Unit) {
val toBeMapped = ApiImportArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.`import` = mapped
}
/**
* @param value A `license` block as documented below.
*/
@JvmName("ptbblervhdwjdjwc")
public suspend fun license(`value`: ApiLicenseArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.license = mapped
}
/**
* @param argument A `license` block as documented below.
*/
@JvmName("ngjdljgdsrnisvlc")
public suspend fun license(argument: suspend ApiLicenseArgsBuilder.() -> Unit) {
val toBeMapped = ApiLicenseArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.license = mapped
}
/**
* @param value The name of the API Management API. Changing this forces a new resource to be created.
*/
@JvmName("sekteqcdhtnlvriu")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value An `oauth2_authorization` block as documented below.
*/
@JvmName("kswuhedhirxdjwyx")
public suspend fun oauth2Authorization(`value`: ApiOauth2AuthorizationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.oauth2Authorization = mapped
}
/**
* @param argument An `oauth2_authorization` block as documented below.
*/
@JvmName("gidgdgwregnibwkv")
public suspend fun oauth2Authorization(argument: suspend ApiOauth2AuthorizationArgsBuilder.() -> Unit) {
val toBeMapped = ApiOauth2AuthorizationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.oauth2Authorization = mapped
}
/**
* @param value An `openid_authentication` block as documented below.
*/
@JvmName("ltyumrannbnacokn")
public suspend fun openidAuthentication(`value`: ApiOpenidAuthenticationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.openidAuthentication = mapped
}
/**
* @param argument An `openid_authentication` block as documented below.
*/
@JvmName("xysticpawtfslmvp")
public suspend fun openidAuthentication(argument: suspend ApiOpenidAuthenticationArgsBuilder.() -> Unit) {
val toBeMapped = ApiOpenidAuthenticationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.openidAuthentication = mapped
}
/**
* @param value The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
*/
@JvmName("hxipgergdrjyfqcb")
public suspend fun path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.path = mapped
}
/**
* @param value A list of protocols the operations in this API can be invoked. Possible values are `http`, `https`, `ws`, and `wss`.
* > **NOTE:** `display_name`, `path` and `protocols` are required when `source_api_id` is not set.
*/
@JvmName("xulgrtvsnkuqeniy")
public suspend fun protocols(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.protocols = mapped
}
/**
* @param values A list of protocols the operations in this API can be invoked. Possible values are `http`, `https`, `ws`, and `wss`.
* > **NOTE:** `display_name`, `path` and `protocols` are required when `source_api_id` is not set.
*/
@JvmName("cmnjmjabujuvrbaf")
public suspend fun protocols(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.protocols = mapped
}
/**
* @param value The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
*/
@JvmName("ngvmfmtgpqinqpfa")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The Revision which used for this API. Changing this forces a new resource to be created.
*/
@JvmName("yckxwxwnngyuqbdm")
public suspend fun revision(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.revision = mapped
}
/**
* @param value The description of the API Revision of the API Management API.
*/
@JvmName("khdrioadbjrgbpgn")
public suspend fun revisionDescription(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.revisionDescription = mapped
}
/**
* @param value Absolute URL of the backend service implementing this API.
*/
@JvmName("yvqscvcoioyekwfi")
public suspend fun serviceUrl(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serviceUrl = mapped
}
/**
* @param value Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to `false`.
* > **NOTE:** This property has been deprecated in favour of the `api_type` property and will be removed in version 4.0 of the provider.
*/
@Deprecated(
message = """
`soap_pass_through` will be removed in favour of the property `api_type` in version 4.0 of the
AzureRM Provider
""",
)
@JvmName("itamyacdcppkosfx")
public suspend fun soapPassThrough(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.soapPassThrough = mapped
}
/**
* @param value The API id of the source API, which could be in format `azurerm_api_management_api.example.id` or in format `azurerm_api_management_api.example.id;rev=1`
*/
@JvmName("swqlsluvalsqimsp")
public suspend fun sourceApiId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sourceApiId = mapped
}
/**
* @param value A `subscription_key_parameter_names` block as documented below.
*/
@JvmName("rjdksqmddrcwppiy")
public suspend fun subscriptionKeyParameterNames(`value`: ApiSubscriptionKeyParameterNamesArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subscriptionKeyParameterNames = mapped
}
/**
* @param argument A `subscription_key_parameter_names` block as documented below.
*/
@JvmName("mvajioauqencjdrq")
public suspend fun subscriptionKeyParameterNames(argument: suspend ApiSubscriptionKeyParameterNamesArgsBuilder.() -> Unit) {
val toBeMapped = ApiSubscriptionKeyParameterNamesArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.subscriptionKeyParameterNames = mapped
}
/**
* @param value Should this API require a subscription key? Defaults to `true`.
*/
@JvmName("udrcqcfwkrelmhck")
public suspend fun subscriptionRequired(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subscriptionRequired = mapped
}
/**
* @param value Absolute URL of the Terms of Service for the API.
*/
@JvmName("bribdiioapusxlys")
public suspend fun termsOfServiceUrl(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.termsOfServiceUrl = mapped
}
/**
* @param value The Version number of this API, if this API is versioned.
*/
@JvmName("llubkmwvcwdcsxah")
public suspend fun version(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.version = mapped
}
/**
* @param value The description of the API Version of the API Management API.
*/
@JvmName("jpysmcaklffnjkox")
public suspend fun versionDescription(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.versionDescription = mapped
}
/**
* @param value The ID of the Version Set which this API is associated with.
* > **NOTE:** When `version` is set, `version_set_id` must also be specified
*/
@JvmName("yfrwuaawmuudnoph")
public suspend fun versionSetId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.versionSetId = mapped
}
internal fun build(): ApiArgs = ApiArgs(
apiManagementName = apiManagementName,
apiType = apiType,
contact = contact,
description = description,
displayName = displayName,
`import` = `import`,
license = license,
name = name,
oauth2Authorization = oauth2Authorization,
openidAuthentication = openidAuthentication,
path = path,
protocols = protocols,
resourceGroupName = resourceGroupName,
revision = revision,
revisionDescription = revisionDescription,
serviceUrl = serviceUrl,
soapPassThrough = soapPassThrough,
sourceApiId = sourceApiId,
subscriptionKeyParameterNames = subscriptionKeyParameterNames,
subscriptionRequired = subscriptionRequired,
termsOfServiceUrl = termsOfServiceUrl,
version = version,
versionDescription = versionDescription,
versionSetId = versionSetId,
)
}
