Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. WorkspaceApiRelease
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.WorkspaceApiRelease

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

ApiRelease details.

Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Example Usage

ApiManagementCreateWorkspaceApiRelease

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspaceApiRelease = new AzureNative.ApiManagement.WorkspaceApiRelease("workspaceApiRelease", new()
    {
        ApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1",
        Notes = "yahooagain",
        ReleaseId = "testrev",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        WorkspaceId = "wks1",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewWorkspaceApiRelease(ctx, "workspaceApiRelease", &apimanagement.WorkspaceApiReleaseArgs{
			ApiId:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1"),
			Notes:             pulumi.String("yahooagain"),
			ReleaseId:         pulumi.String("testrev"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceApiRelease;
import com.pulumi.azurenative.apimanagement.WorkspaceApiReleaseArgs;
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 workspaceApiRelease = new WorkspaceApiRelease("workspaceApiRelease", WorkspaceApiReleaseArgs.builder()
            .apiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1")
            .notes("yahooagain")
            .releaseId("testrev")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .workspaceId("wks1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceApiRelease = new azure_native.apimanagement.WorkspaceApiRelease("workspaceApiRelease", {
    apiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1",
    notes: "yahooagain",
    releaseId: "testrev",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    workspaceId: "wks1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_api_release = azure_native.apimanagement.WorkspaceApiRelease("workspaceApiRelease",
    api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1",
    notes="yahooagain",
    release_id="testrev",
    resource_group_name="rg1",
    service_name="apimService1",
    workspace_id="wks1")
Copy
resources:
  workspaceApiRelease:
    type: azure-native:apimanagement:WorkspaceApiRelease
    properties:
      apiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/a1
      notes: yahooagain
      releaseId: testrev
      resourceGroupName: rg1
      serviceName: apimService1
      workspaceId: wks1
Copy

Create WorkspaceApiRelease Resource

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

Constructor syntax

new WorkspaceApiRelease(name: string, args: WorkspaceApiReleaseArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceApiRelease(resource_name: str,
                        args: WorkspaceApiReleaseArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceApiRelease(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        workspace_id: Optional[str] = None,
                        notes: Optional[str] = None,
                        release_id: Optional[str] = None)
func NewWorkspaceApiRelease(ctx *Context, name string, args WorkspaceApiReleaseArgs, opts ...ResourceOption) (*WorkspaceApiRelease, error)
public WorkspaceApiRelease(string name, WorkspaceApiReleaseArgs args, CustomResourceOptions? opts = null)
public WorkspaceApiRelease(String name, WorkspaceApiReleaseArgs args)
public WorkspaceApiRelease(String name, WorkspaceApiReleaseArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceApiRelease
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var workspaceApiReleaseResource = new AzureNative.ApiManagement.WorkspaceApiRelease("workspaceApiReleaseResource", new()
{
    ApiId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    WorkspaceId = "string",
    Notes = "string",
    ReleaseId = "string",
});
Copy
example, err := apimanagement.NewWorkspaceApiRelease(ctx, "workspaceApiReleaseResource", &apimanagement.WorkspaceApiReleaseArgs{
	ApiId:             pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	WorkspaceId:       pulumi.String("string"),
	Notes:             pulumi.String("string"),
	ReleaseId:         pulumi.String("string"),
})
Copy
var workspaceApiReleaseResource = new WorkspaceApiRelease("workspaceApiReleaseResource", WorkspaceApiReleaseArgs.builder()
    .apiId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .workspaceId("string")
    .notes("string")
    .releaseId("string")
    .build());
Copy
workspace_api_release_resource = azure_native.apimanagement.WorkspaceApiRelease("workspaceApiReleaseResource",
    api_id="string",
    resource_group_name="string",
    service_name="string",
    workspace_id="string",
    notes="string",
    release_id="string")
Copy
const workspaceApiReleaseResource = new azure_native.apimanagement.WorkspaceApiRelease("workspaceApiReleaseResource", {
    apiId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    workspaceId: "string",
    notes: "string",
    releaseId: "string",
});
Copy
type: azure-native:apimanagement:WorkspaceApiRelease
properties:
    apiId: string
    notes: string
    releaseId: string
    resourceGroupName: string
    serviceName: string
    workspaceId: string
Copy

WorkspaceApiRelease Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkspaceApiRelease resource accepts the following input properties:

ApiId This property is required. string
Identifier of the API the release belongs to.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Notes string
Release Notes
ReleaseId Changes to this property will trigger replacement. string
Release identifier within an API. Must be unique in the current API Management service instance.
ApiId This property is required. string
Identifier of the API the release belongs to.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Notes string
Release Notes
ReleaseId Changes to this property will trigger replacement. string
Release identifier within an API. Must be unique in the current API Management service instance.
apiId This property is required. String
Identifier of the API the release belongs to.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
notes String
Release Notes
releaseId Changes to this property will trigger replacement. String
Release identifier within an API. Must be unique in the current API Management service instance.
apiId This property is required. string
Identifier of the API the release belongs to.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
notes string
Release Notes
releaseId Changes to this property will trigger replacement. string
Release identifier within an API. Must be unique in the current API Management service instance.
api_id This property is required. str
Identifier of the API the release belongs to.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
notes str
Release Notes
release_id Changes to this property will trigger replacement. str
Release identifier within an API. Must be unique in the current API Management service instance.
apiId This property is required. String
Identifier of the API the release belongs to.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
notes String
Release Notes
releaseId Changes to this property will trigger replacement. String
Release identifier within an API. Must be unique in the current API Management service instance.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
CreatedDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedDateTime string
The time the API release was updated.
AzureApiVersion string
The Azure API version of the resource.
CreatedDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UpdatedDateTime string
The time the API release was updated.
azureApiVersion String
The Azure API version of the resource.
createdDateTime String
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime String
The time the API release was updated.
azureApiVersion string
The Azure API version of the resource.
createdDateTime string
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime string
The time the API release was updated.
azure_api_version str
The Azure API version of the resource.
created_date_time str
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updated_date_time str
The time the API release was updated.
azureApiVersion String
The Azure API version of the resource.
createdDateTime String
The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
updatedDateTime String
The time the API release was updated.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:WorkspaceApiRelease testrev /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/releases/{releaseId}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native