![JAR search and dependency download from the Maven repository](/logo.png)
com.pulumi.azurenative.apimanagement.kotlin.ApiPolicyArgs.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.azurenative.apimanagement.ApiPolicyArgs.builder
import com.pulumi.azurenative.apimanagement.kotlin.enums.PolicyContentFormat
import com.pulumi.core.Either
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Policy Contract details.
* Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
* Other available API versions: 2016-10-10, 2018-06-01-preview, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
* ## Example Usage
* ### ApiManagementCreateApiPolicy
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var apiPolicy = new AzureNative.ApiManagement.ApiPolicy("apiPolicy", new()
* {
* ApiId = "5600b57e7e8880006a040001",
* Format = AzureNative.ApiManagement.PolicyContentFormat.Xml,
* PolicyId = "policy",
* ResourceGroupName = "rg1",
* 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.NewApiPolicy(ctx, "apiPolicy", &apimanagement.ApiPolicyArgs{
* ApiId: pulumi.String("5600b57e7e8880006a040001"),
* Format: pulumi.String(apimanagement.PolicyContentFormatXml),
* PolicyId: pulumi.String("policy"),
* ResourceGroupName: pulumi.String("rg1"),
* 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.ApiPolicy;
* import com.pulumi.azurenative.apimanagement.ApiPolicyArgs;
* 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 apiPolicy = new ApiPolicy("apiPolicy", ApiPolicyArgs.builder()
* .apiId("5600b57e7e8880006a040001")
* .format("xml")
* .policyId("policy")
* .resourceGroupName("rg1")
* .serviceName("apimService1")
* .value(" ")
* .build());
* }
* }
* ```
* ### ApiManagementCreateApiPolicyNonXmlEncoded
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var apiPolicy = new AzureNative.ApiManagement.ApiPolicy("apiPolicy", new()
* {
* ApiId = "5600b57e7e8880006a040001",
* Format = AzureNative.ApiManagement.PolicyContentFormat.Rawxml,
* PolicyId = "policy",
* ResourceGroupName = "rg1",
* ServiceName = "apimService1",
* Value = @"
*
*
*
* ""@(context.Request.Headers.FirstOrDefault(h => h.Ke==""Via""))""
*
*
* ",
* });
* });
* ```
* ```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.NewApiPolicy(ctx, "apiPolicy", &apimanagement.ApiPolicyArgs{
* ApiId: pulumi.String("5600b57e7e8880006a040001"),
* Format: pulumi.String(apimanagement.PolicyContentFormatRawxml),
* PolicyId: pulumi.String("policy"),
* ResourceGroupName: pulumi.String("rg1"),
* ServiceName: pulumi.String("apimService1"),
* Value: pulumi.String(`
*
*
*
* "@(context.Request.Headers.FirstOrDefault(h => h.Ke=="Via"))"
*
*
* `),
* })
* 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.ApiPolicy;
* import com.pulumi.azurenative.apimanagement.ApiPolicyArgs;
* 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 apiPolicy = new ApiPolicy("apiPolicy", ApiPolicyArgs.builder()
* .apiId("5600b57e7e8880006a040001")
* .format("rawxml")
* .policyId("policy")
* .resourceGroupName("rg1")
* .serviceName("apimService1")
* .value("""
*
*
*
*
* "@(context.Request.Headers.FirstOrDefault(h => h.Ke=="Via"))"
*
*
* """)
* .build());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:apimanagement:ApiPolicy policy /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
* ```
* @property apiId API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
* @property format Format of the policyContent.
* @property policyId The identifier of the Policy.
* @property resourceGroupName The name of the resource group. The name is case insensitive.
* @property serviceName The name of the API Management service.
* @property value Contents of the Policy as defined by the format.
*/
public data class ApiPolicyArgs(
public val apiId: Output? = null,
public val format: Output>? = null,
public val policyId: Output? = null,
public val resourceGroupName: Output? = null,
public val serviceName: Output? = null,
public val `value`: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azurenative.apimanagement.ApiPolicyArgs =
com.pulumi.azurenative.apimanagement.ApiPolicyArgs.builder()
.apiId(apiId?.applyValue({ args0 -> args0 }))
.format(
format?.applyValue({ args0 ->
args0.transform({ args0 -> args0 }, { args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.policyId(policyId?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.serviceName(serviceName?.applyValue({ args0 -> args0 }))
.`value`(`value`?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ApiPolicyArgs].
*/
@PulumiTagMarker
public class ApiPolicyArgsBuilder internal constructor() {
private var apiId: Output? = null
private var format: Output>? = null
private var policyId: Output? = null
private var resourceGroupName: Output? = null
private var serviceName: Output? = null
private var `value`: Output? = null
/**
* @param value API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
*/
@JvmName("yjanpqybquwfheag")
public suspend fun apiId(`value`: Output) {
this.apiId = value
}
/**
* @param value Format of the policyContent.
*/
@JvmName("qhmmipabbbknroon")
public suspend fun format(`value`: Output>) {
this.format = value
}
/**
* @param value The identifier of the Policy.
*/
@JvmName("rusuakixynvfthcc")
public suspend fun policyId(`value`: Output) {
this.policyId = value
}
/**
* @param value The name of the resource group. The name is case insensitive.
*/
@JvmName("adqcdbbdsndgleam")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The name of the API Management service.
*/
@JvmName("jfuqgnadpbsatfxw")
public suspend fun serviceName(`value`: Output) {
this.serviceName = value
}
/**
* @param value Contents of the Policy as defined by the format.
*/
@JvmName("pfnfkpotlvccnrxj")
public suspend fun `value`(`value`: Output) {
this.`value` = value
}
/**
* @param value API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
*/
@JvmName("brrbbthnjsoiyvvg")
public suspend fun apiId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiId = mapped
}
/**
* @param value Format of the policyContent.
*/
@JvmName("jkovohrrbatxrfxd")
public suspend fun format(`value`: Either?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.format = mapped
}
/**
* @param value Format of the policyContent.
*/
@JvmName("ddfmywyerxeksxvr")
public fun format(`value`: String) {
val toBeMapped = Either.ofLeft(value)
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.format = mapped
}
/**
* @param value Format of the policyContent.
*/
@JvmName("xwcvnhwhcsigqpuc")
public fun format(`value`: PolicyContentFormat) {
val toBeMapped = Either.ofRight(value)
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.format = mapped
}
/**
* @param value The identifier of the Policy.
*/
@JvmName("fkdijlhhvspqfmmu")
public suspend fun policyId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.policyId = mapped
}
/**
* @param value The name of the resource group. The name is case insensitive.
*/
@JvmName("tpxbeednbnhltbdx")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The name of the API Management service.
*/
@JvmName("qlwxyecquwuedkss")
public suspend fun serviceName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serviceName = mapped
}
/**
* @param value Contents of the Policy as defined by the format.
*/
@JvmName("twhpysmkrdepyjlw")
public suspend fun `value`(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.`value` = mapped
}
internal fun build(): ApiPolicyArgs = ApiPolicyArgs(
apiId = apiId,
format = format,
policyId = policyId,
resourceGroupName = resourceGroupName,
serviceName = serviceName,
`value` = `value`,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy