All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.apimanagement.kotlin.ApiOperationPolicyArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.apimanagement.kotlin

import com.pulumi.azure.apimanagement.ApiOperationPolicyArgs.builder
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

/**
 * Manages an API Management API Operation Policy
 * ## 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",
 * });
 * const exampleApiOperation = new azure.apimanagement.ApiOperation("example", {
 *     operationId: "acctest-operation",
 *     apiName: exampleApi.name,
 *     apiManagementName: exampleService.name,
 *     resourceGroupName: example.name,
 *     displayName: "DELETE Resource",
 *     method: "DELETE",
 *     urlTemplate: "/resource",
 * });
 * const exampleApiOperationPolicy = new azure.apimanagement.ApiOperationPolicy("example", {
 *     apiName: exampleApiOperation.apiName,
 *     apiManagementName: exampleApiOperation.apiManagementName,
 *     resourceGroupName: exampleApiOperation.resourceGroupName,
 *     operationId: exampleApiOperation.operationId,
 *     xmlContent: `
 *   
 *     
 *   
 * 
 * `,
 * });
 * ```
 * ```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")
 * example_api_operation = azure.apimanagement.ApiOperation("example",
 *     operation_id="acctest-operation",
 *     api_name=example_api.name,
 *     api_management_name=example_service.name,
 *     resource_group_name=example.name,
 *     display_name="DELETE Resource",
 *     method="DELETE",
 *     url_template="/resource")
 * example_api_operation_policy = azure.apimanagement.ApiOperationPolicy("example",
 *     api_name=example_api_operation.api_name,
 *     api_management_name=example_api_operation.api_management_name,
 *     resource_group_name=example_api_operation.resource_group_name,
 *     operation_id=example_api_operation.operation_id,
 *     xml_content="""
 *   
 *     
 *   
 * 
 * """)
 * ```
 * ```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",
 *     });
 *     var exampleApiOperation = new Azure.ApiManagement.ApiOperation("example", new()
 *     {
 *         OperationId = "acctest-operation",
 *         ApiName = exampleApi.Name,
 *         ApiManagementName = exampleService.Name,
 *         ResourceGroupName = example.Name,
 *         DisplayName = "DELETE Resource",
 *         Method = "DELETE",
 *         UrlTemplate = "/resource",
 *     });
 *     var exampleApiOperationPolicy = new Azure.ApiManagement.ApiOperationPolicy("example", new()
 *     {
 *         ApiName = exampleApiOperation.ApiName,
 *         ApiManagementName = exampleApiOperation.ApiManagementName,
 *         ResourceGroupName = exampleApiOperation.ResourceGroupName,
 *         OperationId = exampleApiOperation.OperationId,
 *         XmlContent = @"
 *   
 *     
 *   
 * 
 * ",
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		exampleApi, err := apimanagement.NewApi(ctx, "example", &apimanagement.ApiArgs{
 * 			Name:              pulumi.String("example-api"),
 * 			ResourceGroupName: example.Name,
 * 			ApiManagementName: exampleService.Name,
 * 			Revision:          pulumi.String("1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleApiOperation, err := apimanagement.NewApiOperation(ctx, "example", &apimanagement.ApiOperationArgs{
 * 			OperationId:       pulumi.String("acctest-operation"),
 * 			ApiName:           exampleApi.Name,
 * 			ApiManagementName: exampleService.Name,
 * 			ResourceGroupName: example.Name,
 * 			DisplayName:       pulumi.String("DELETE Resource"),
 * 			Method:            pulumi.String("DELETE"),
 * 			UrlTemplate:       pulumi.String("/resource"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewApiOperationPolicy(ctx, "example", &apimanagement.ApiOperationPolicyArgs{
 * 			ApiName:           exampleApiOperation.ApiName,
 * 			ApiManagementName: exampleApiOperation.ApiManagementName,
 * 			ResourceGroupName: exampleApiOperation.ResourceGroupName,
 * 			OperationId:       exampleApiOperation.OperationId,
 * 			XmlContent: 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.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.ApiOperation;
 * import com.pulumi.azure.apimanagement.ApiOperationArgs;
 * import com.pulumi.azure.apimanagement.ApiOperationPolicy;
 * import com.pulumi.azure.apimanagement.ApiOperationPolicyArgs;
 * 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")
 *             .build());
 *         var exampleApiOperation = new ApiOperation("exampleApiOperation", ApiOperationArgs.builder()
 *             .operationId("acctest-operation")
 *             .apiName(exampleApi.name())
 *             .apiManagementName(exampleService.name())
 *             .resourceGroupName(example.name())
 *             .displayName("DELETE Resource")
 *             .method("DELETE")
 *             .urlTemplate("/resource")
 *             .build());
 *         var exampleApiOperationPolicy = new ApiOperationPolicy("exampleApiOperationPolicy", ApiOperationPolicyArgs.builder()
 *             .apiName(exampleApiOperation.apiName())
 *             .apiManagementName(exampleApiOperation.apiManagementName())
 *             .resourceGroupName(exampleApiOperation.resourceGroupName())
 *             .operationId(exampleApiOperation.operationId())
 *             .xmlContent("""
 * 
 *   
 *     
 *   
 * 
 *             """)
 *             .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'
 *   exampleApiOperation:
 *     type: azure:apimanagement:ApiOperation
 *     name: example
 *     properties:
 *       operationId: acctest-operation
 *       apiName: ${exampleApi.name}
 *       apiManagementName: ${exampleService.name}
 *       resourceGroupName: ${example.name}
 *       displayName: DELETE Resource
 *       method: DELETE
 *       urlTemplate: /resource
 *   exampleApiOperationPolicy:
 *     type: azure:apimanagement:ApiOperationPolicy
 *     name: example
 *     properties:
 *       apiName: ${exampleApiOperation.apiName}
 *       apiManagementName: ${exampleApiOperation.apiManagementName}
 *       resourceGroupName: ${exampleApiOperation.resourceGroupName}
 *       operationId: ${exampleApiOperation.operationId}
 *       xmlContent: |
 *         
 *           
 *             
 *           
 *         
 * ```
 * 
 * ## Import
 * API Management API Operation Policy can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/apiOperationPolicy:ApiOperationPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/operations/operation1
 * ```
 * @property apiManagementName The name of the API Management Service. Changing this forces a new resource to be created.
 * @property apiName The name of the API within the API Management Service where the Operation exists. Changing this forces a new resource to be created.
 * @property operationId The operation identifier within an API. Must be unique in the current API Management service instance. Changing this forces a new resource to be created.
 * @property resourceGroupName The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
 * @property xmlContent The XML Content for this Policy.
 * @property xmlLink A link to a Policy XML Document, which must be publicly available.
 */
public data class ApiOperationPolicyArgs(
    public val apiManagementName: Output? = null,
    public val apiName: Output? = null,
    public val operationId: Output? = null,
    public val resourceGroupName: Output? = null,
    public val xmlContent: Output? = null,
    public val xmlLink: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.apimanagement.ApiOperationPolicyArgs =
        com.pulumi.azure.apimanagement.ApiOperationPolicyArgs.builder()
            .apiManagementName(apiManagementName?.applyValue({ args0 -> args0 }))
            .apiName(apiName?.applyValue({ args0 -> args0 }))
            .operationId(operationId?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .xmlContent(xmlContent?.applyValue({ args0 -> args0 }))
            .xmlLink(xmlLink?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ApiOperationPolicyArgs].
 */
@PulumiTagMarker
public class ApiOperationPolicyArgsBuilder internal constructor() {
    private var apiManagementName: Output? = null

    private var apiName: Output? = null

    private var operationId: Output? = null

    private var resourceGroupName: Output? = null

    private var xmlContent: Output? = null

    private var xmlLink: Output? = null

    /**
     * @param value The name of the API Management Service. Changing this forces a new resource to be created.
     */
    @JvmName("qywincrhviuldaau")
    public suspend fun apiManagementName(`value`: Output) {
        this.apiManagementName = value
    }

    /**
     * @param value The name of the API within the API Management Service where the Operation exists. Changing this forces a new resource to be created.
     */
    @JvmName("wvbrvjqfajxgbloc")
    public suspend fun apiName(`value`: Output) {
        this.apiName = value
    }

    /**
     * @param value The operation identifier within an API. Must be unique in the current API Management service instance. Changing this forces a new resource to be created.
     */
    @JvmName("poyrbstekmstkgxx")
    public suspend fun operationId(`value`: Output) {
        this.operationId = value
    }

    /**
     * @param value The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
     */
    @JvmName("qqddkbjdshkcmnam")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value The XML Content for this Policy.
     */
    @JvmName("ahobacyxddgaoeck")
    public suspend fun xmlContent(`value`: Output) {
        this.xmlContent = value
    }

    /**
     * @param value A link to a Policy XML Document, which must be publicly available.
     */
    @JvmName("yrjhotpguemutlvr")
    public suspend fun xmlLink(`value`: Output) {
        this.xmlLink = value
    }

    /**
     * @param value The name of the API Management Service. Changing this forces a new resource to be created.
     */
    @JvmName("wiaqwkernfetohkq")
    public suspend fun apiManagementName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiManagementName = mapped
    }

    /**
     * @param value The name of the API within the API Management Service where the Operation exists. Changing this forces a new resource to be created.
     */
    @JvmName("cteuulxqcwiiuovm")
    public suspend fun apiName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiName = mapped
    }

    /**
     * @param value The operation identifier within an API. Must be unique in the current API Management service instance. Changing this forces a new resource to be created.
     */
    @JvmName("vedgmirppjhieolr")
    public suspend fun operationId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.operationId = mapped
    }

    /**
     * @param value The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
     */
    @JvmName("gxllnonvemxoffai")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value The XML Content for this Policy.
     */
    @JvmName("guhliteqomlkpdfn")
    public suspend fun xmlContent(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.xmlContent = mapped
    }

    /**
     * @param value A link to a Policy XML Document, which must be publicly available.
     */
    @JvmName("mtarrnljthjrrywj")
    public suspend fun xmlLink(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.xmlLink = mapped
    }

    internal fun build(): ApiOperationPolicyArgs = ApiOperationPolicyArgs(
        apiManagementName = apiManagementName,
        apiName = apiName,
        operationId = operationId,
        resourceGroupName = resourceGroupName,
        xmlContent = xmlContent,
        xmlLink = xmlLink,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy