Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. ApiDefinition
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apicenter.ApiDefinition

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

API definition entity.

Uses Azure REST API version 2024-03-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01.

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

Example Usage

ApiDefinitions_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var apiDefinition = new AzureNative.ApiCenter.ApiDefinition("apiDefinition", new()
    {
        ApiName = "openapi",
        DefinitionName = "openapi",
        Description = "Default spec",
        ResourceGroupName = "contoso-resources",
        ServiceName = "contoso",
        Title = "OpenAPI",
        VersionName = "2023-01-01",
        WorkspaceName = "default",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apicenter.NewApiDefinition(ctx, "apiDefinition", &apicenter.ApiDefinitionArgs{
			ApiName:           pulumi.String("openapi"),
			DefinitionName:    pulumi.String("openapi"),
			Description:       pulumi.String("Default spec"),
			ResourceGroupName: pulumi.String("contoso-resources"),
			ServiceName:       pulumi.String("contoso"),
			Title:             pulumi.String("OpenAPI"),
			VersionName:       pulumi.String("2023-01-01"),
			WorkspaceName:     pulumi.String("default"),
		})
		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.apicenter.ApiDefinition;
import com.pulumi.azurenative.apicenter.ApiDefinitionArgs;
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 apiDefinition = new ApiDefinition("apiDefinition", ApiDefinitionArgs.builder()
            .apiName("openapi")
            .definitionName("openapi")
            .description("Default spec")
            .resourceGroupName("contoso-resources")
            .serviceName("contoso")
            .title("OpenAPI")
            .versionName("2023-01-01")
            .workspaceName("default")
            .build());

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

const apiDefinition = new azure_native.apicenter.ApiDefinition("apiDefinition", {
    apiName: "openapi",
    definitionName: "openapi",
    description: "Default spec",
    resourceGroupName: "contoso-resources",
    serviceName: "contoso",
    title: "OpenAPI",
    versionName: "2023-01-01",
    workspaceName: "default",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

api_definition = azure_native.apicenter.ApiDefinition("apiDefinition",
    api_name="openapi",
    definition_name="openapi",
    description="Default spec",
    resource_group_name="contoso-resources",
    service_name="contoso",
    title="OpenAPI",
    version_name="2023-01-01",
    workspace_name="default")
Copy
resources:
  apiDefinition:
    type: azure-native:apicenter:ApiDefinition
    properties:
      apiName: openapi
      definitionName: openapi
      description: Default spec
      resourceGroupName: contoso-resources
      serviceName: contoso
      title: OpenAPI
      versionName: 2023-01-01
      workspaceName: default
Copy

Create ApiDefinition Resource

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

Constructor syntax

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

@overload
def ApiDefinition(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  api_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  title: Optional[str] = None,
                  version_name: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  definition_name: Optional[str] = None,
                  description: Optional[str] = None)
func NewApiDefinition(ctx *Context, name string, args ApiDefinitionArgs, opts ...ResourceOption) (*ApiDefinition, error)
public ApiDefinition(string name, ApiDefinitionArgs args, CustomResourceOptions? opts = null)
public ApiDefinition(String name, ApiDefinitionArgs args)
public ApiDefinition(String name, ApiDefinitionArgs args, CustomResourceOptions options)

type: azure-native:apicenter:ApiDefinition
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. ApiDefinitionArgs
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. ApiDefinitionArgs
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. ApiDefinitionArgs
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. ApiDefinitionArgs
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. ApiDefinitionArgs
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 apiDefinitionResource = new AzureNative.ApiCenter.ApiDefinition("apiDefinitionResource", new()
{
    ApiName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Title = "string",
    VersionName = "string",
    WorkspaceName = "string",
    DefinitionName = "string",
    Description = "string",
});
Copy
example, err := apicenter.NewApiDefinition(ctx, "apiDefinitionResource", &apicenter.ApiDefinitionArgs{
	ApiName:           pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Title:             pulumi.String("string"),
	VersionName:       pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	DefinitionName:    pulumi.String("string"),
	Description:       pulumi.String("string"),
})
Copy
var apiDefinitionResource = new ApiDefinition("apiDefinitionResource", ApiDefinitionArgs.builder()
    .apiName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .title("string")
    .versionName("string")
    .workspaceName("string")
    .definitionName("string")
    .description("string")
    .build());
Copy
api_definition_resource = azure_native.apicenter.ApiDefinition("apiDefinitionResource",
    api_name="string",
    resource_group_name="string",
    service_name="string",
    title="string",
    version_name="string",
    workspace_name="string",
    definition_name="string",
    description="string")
Copy
const apiDefinitionResource = new azure_native.apicenter.ApiDefinition("apiDefinitionResource", {
    apiName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    title: "string",
    versionName: "string",
    workspaceName: "string",
    definitionName: "string",
    description: "string",
});
Copy
type: azure-native:apicenter:ApiDefinition
properties:
    apiName: string
    definitionName: string
    description: string
    resourceGroupName: string
    serviceName: string
    title: string
    versionName: string
    workspaceName: string
Copy

ApiDefinition 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 ApiDefinition resource accepts the following input properties:

ApiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
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 Azure API Center service.
Title This property is required. string
API definition title.
VersionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
DefinitionName Changes to this property will trigger replacement. string
The name of the API definition.
Description string
API definition description.
ApiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
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 Azure API Center service.
Title This property is required. string
API definition title.
VersionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
DefinitionName Changes to this property will trigger replacement. string
The name of the API definition.
Description string
API definition description.
apiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API.
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 Azure API Center service.
title This property is required. String
API definition title.
versionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
definitionName Changes to this property will trigger replacement. String
The name of the API definition.
description String
API definition description.
apiName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API.
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 Azure API Center service.
title This property is required. string
API definition title.
versionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
definitionName Changes to this property will trigger replacement. string
The name of the API definition.
description string
API definition description.
api_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API.
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 Azure API Center service.
title This property is required. str
API definition title.
version_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API version.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
definition_name Changes to this property will trigger replacement. str
The name of the API definition.
description str
API definition description.
apiName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API.
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 Azure API Center service.
title This property is required. String
API definition title.
versionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API version.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
definitionName Changes to this property will trigger replacement. String
The name of the API definition.
description String
API definition description.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Specification Pulumi.AzureNative.ApiCenter.Outputs.ApiDefinitionPropertiesSpecificationResponse
API specification details.
SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
specification ApiDefinitionPropertiesSpecificationResponse
API specification details.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
specification Property Map
API specification details.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ApiDefinitionPropertiesSpecificationResponse
, ApiDefinitionPropertiesSpecificationResponseArgs

Name string
Specification name.
Version string
Specification version.
Name string
Specification name.
Version string
Specification version.
name String
Specification name.
version String
Specification version.
name string
Specification name.
version string
Specification version.
name str
Specification name.
version str
Specification version.
name String
Specification name.
version String
Specification version.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

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

$ pulumi import azure-native:apicenter:ApiDefinition openapi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native