1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. ApiRelease

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.apimanagement.ApiRelease

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a API Management API Release.

    Example Usage

    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: "company@terraform.io",
        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",
        },
    });
    const exampleApiRelease = new azure.apimanagement.ApiRelease("example", {
        name: "example-Api-Release",
        apiId: exampleApi.id,
    });
    
    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="company@terraform.io",
        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_=azure.apimanagement.ApiImportArgs(
            content_format="swagger-link-json",
            content_value="http://conferenceapi.azurewebsites.net/?format=json",
        ))
    example_api_release = azure.apimanagement.ApiRelease("example",
        name="example-Api-Release",
        api_id=example_api.id)
    
    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("company@terraform.io"),
    			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"),
    			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
    		}
    		_, err = apimanagement.NewApiRelease(ctx, "example", &apimanagement.ApiReleaseArgs{
    			Name:  pulumi.String("example-Api-Release"),
    			ApiId: exampleApi.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 = "company@terraform.io",
            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",
            },
        });
    
        var exampleApiRelease = new Azure.ApiManagement.ApiRelease("example", new()
        {
            Name = "example-Api-Release",
            ApiId = exampleApi.Id,
        });
    
    });
    
    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 com.pulumi.azure.apimanagement.ApiRelease;
    import com.pulumi.azure.apimanagement.ApiReleaseArgs;
    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("company@terraform.io")
                .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());
    
            var exampleApiRelease = new ApiRelease("exampleApiRelease", ApiReleaseArgs.builder()
                .name("example-Api-Release")
                .apiId(exampleApi.id())
                .build());
    
        }
    }
    
    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: company@terraform.io
          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
      exampleApiRelease:
        type: azure:apimanagement:ApiRelease
        name: example
        properties:
          name: example-Api-Release
          apiId: ${exampleApi.id}
    

    Create ApiRelease Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiRelease(name: string, args: ApiReleaseArgs, opts?: CustomResourceOptions);
    @overload
    def ApiRelease(resource_name: str,
                   args: ApiReleaseArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiRelease(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_id: Optional[str] = None,
                   name: Optional[str] = None,
                   notes: Optional[str] = None)
    func NewApiRelease(ctx *Context, name string, args ApiReleaseArgs, opts ...ResourceOption) (*ApiRelease, error)
    public ApiRelease(string name, ApiReleaseArgs args, CustomResourceOptions? opts = null)
    public ApiRelease(String name, ApiReleaseArgs args)
    public ApiRelease(String name, ApiReleaseArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:ApiRelease
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApiReleaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiReleaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiReleaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiReleaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiReleaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var apiReleaseResource = new Azure.ApiManagement.ApiRelease("apiReleaseResource", new()
    {
        ApiId = "string",
        Name = "string",
        Notes = "string",
    });
    
    example, err := apimanagement.NewApiRelease(ctx, "apiReleaseResource", &apimanagement.ApiReleaseArgs{
    	ApiId: pulumi.String("string"),
    	Name:  pulumi.String("string"),
    	Notes: pulumi.String("string"),
    })
    
    var apiReleaseResource = new ApiRelease("apiReleaseResource", ApiReleaseArgs.builder()
        .apiId("string")
        .name("string")
        .notes("string")
        .build());
    
    api_release_resource = azure.apimanagement.ApiRelease("apiReleaseResource",
        api_id="string",
        name="string",
        notes="string")
    
    const apiReleaseResource = new azure.apimanagement.ApiRelease("apiReleaseResource", {
        apiId: "string",
        name: "string",
        notes: "string",
    });
    
    type: azure:apimanagement:ApiRelease
    properties:
        apiId: string
        name: string
        notes: string
    

    ApiRelease Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApiRelease resource accepts the following input properties:

    ApiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    Name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    Notes string
    The Release Notes.
    ApiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    Name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    Notes string
    The Release Notes.
    apiId String
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name String
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes String
    The Release Notes.
    apiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes string
    The Release Notes.
    api_id str
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name str
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes str
    The Release Notes.
    apiId String
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name String
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes String
    The Release Notes.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiRelease resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiRelease Resource

    Get an existing ApiRelease resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiReleaseState, opts?: CustomResourceOptions): ApiRelease
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_id: Optional[str] = None,
            name: Optional[str] = None,
            notes: Optional[str] = None) -> ApiRelease
    func GetApiRelease(ctx *Context, name string, id IDInput, state *ApiReleaseState, opts ...ResourceOption) (*ApiRelease, error)
    public static ApiRelease Get(string name, Input<string> id, ApiReleaseState? state, CustomResourceOptions? opts = null)
    public static ApiRelease get(String name, Output<String> id, ApiReleaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    Name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    Notes string
    The Release Notes.
    ApiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    Name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    Notes string
    The Release Notes.
    apiId String
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name String
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes String
    The Release Notes.
    apiId string
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name string
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes string
    The Release Notes.
    api_id str
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name str
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes str
    The Release Notes.
    apiId String
    The ID of the API Management API. Changing this forces a new API Management API Release to be created.
    name String
    The name which should be used for this API Management API Release. Changing this forces a new API Management API Release to be created.
    notes String
    The Release Notes.

    Import

    API Management API Releases can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/apiRelease:ApiRelease example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/apis/api1/releases/release1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi