1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. ApiDefinition
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi

azure-native.apicenter.ApiDefinition

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi

    API definition entity. Azure REST API version: 2024-03-01.

    Other available API versions: 2024-03-15-preview.

    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",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/apicenter/v2"
    	"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
    	})
    }
    
    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());
    
        }
    }
    
    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")
    
    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",
    });
    
    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
    

    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 string
    The unique name of the resource.
    args ApiDefinitionArgs
    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 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 string
    The unique name of the resource.
    args ApiDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiDefinitionArgs
    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 apiDefinitionResource = new AzureNative.ApiCenter.ApiDefinition("apiDefinitionResource", new()
    {
        ApiName = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Title = "string",
        VersionName = "string",
        WorkspaceName = "string",
        DefinitionName = "string",
        Description = "string",
    });
    
    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"),
    })
    
    var apiDefinitionResource = new ApiDefinition("apiDefinitionResource", ApiDefinitionArgs.builder()        
        .apiName("string")
        .resourceGroupName("string")
        .serviceName("string")
        .title("string")
        .versionName("string")
        .workspaceName("string")
        .definitionName("string")
        .description("string")
        .build());
    
    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")
    
    const apiDefinitionResource = new azure_native.apicenter.ApiDefinition("apiDefinitionResource", {
        apiName: "string",
        resourceGroupName: "string",
        serviceName: "string",
        title: "string",
        versionName: "string",
        workspaceName: "string",
        definitionName: "string",
        description: "string",
    });
    
    type: azure-native:apicenter:ApiDefinition
    properties:
        apiName: string
        definitionName: string
        description: string
        resourceGroupName: string
        serviceName: string
        title: string
        versionName: string
        workspaceName: string
    

    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

    The ApiDefinition resource accepts the following input properties:

    ApiName string
    The name of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    Title string
    API definition title.
    VersionName string
    The name of the API version.
    WorkspaceName string
    The name of the workspace.
    DefinitionName string
    The name of the API definition.
    Description string
    API definition description.
    ApiName string
    The name of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    Title string
    API definition title.
    VersionName string
    The name of the API version.
    WorkspaceName string
    The name of the workspace.
    DefinitionName string
    The name of the API definition.
    Description string
    API definition description.
    apiName String
    The name of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    title String
    API definition title.
    versionName String
    The name of the API version.
    workspaceName String
    The name of the workspace.
    definitionName String
    The name of the API definition.
    description String
    API definition description.
    apiName string
    The name of the API.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of Azure API Center service.
    title string
    API definition title.
    versionName string
    The name of the API version.
    workspaceName string
    The name of the workspace.
    definitionName string
    The name of the API definition.
    description string
    API definition description.
    api_name str
    The name of the API.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of Azure API Center service.
    title str
    API definition title.
    version_name str
    The name of the API version.
    workspace_name str
    The name of the workspace.
    definition_name str
    The name of the API definition.
    description str
    API definition description.
    apiName String
    The name of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    title String
    API definition title.
    versionName String
    The name of the API version.
    workspaceName String
    The name of the workspace.
    definitionName 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:

    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"
    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"
    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"
    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"
    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"
    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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi