1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. ApiVersion
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apicenter.ApiVersion

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.37.0 published on Monday, Apr 15, 2024 by Pulumi

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

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

    Example Usage

    ApiVersions_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var apiVersion = new AzureNative.ApiCenter.ApiVersion("apiVersion", new()
        {
            ApiName = "echo-api",
            LifecycleStage = AzureNative.ApiCenter.LifecycleStage.Production,
            ResourceGroupName = "contoso-resources",
            ServiceName = "contoso",
            Title = "2023-01-01",
            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.NewApiVersion(ctx, "apiVersion", &apicenter.ApiVersionArgs{
    			ApiName:           pulumi.String("echo-api"),
    			LifecycleStage:    pulumi.String(apicenter.LifecycleStageProduction),
    			ResourceGroupName: pulumi.String("contoso-resources"),
    			ServiceName:       pulumi.String("contoso"),
    			Title:             pulumi.String("2023-01-01"),
    			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.ApiVersion;
    import com.pulumi.azurenative.apicenter.ApiVersionArgs;
    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 apiVersion = new ApiVersion("apiVersion", ApiVersionArgs.builder()        
                .apiName("echo-api")
                .lifecycleStage("production")
                .resourceGroupName("contoso-resources")
                .serviceName("contoso")
                .title("2023-01-01")
                .versionName("2023-01-01")
                .workspaceName("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    api_version = azure_native.apicenter.ApiVersion("apiVersion",
        api_name="echo-api",
        lifecycle_stage=azure_native.apicenter.LifecycleStage.PRODUCTION,
        resource_group_name="contoso-resources",
        service_name="contoso",
        title="2023-01-01",
        version_name="2023-01-01",
        workspace_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const apiVersion = new azure_native.apicenter.ApiVersion("apiVersion", {
        apiName: "echo-api",
        lifecycleStage: azure_native.apicenter.LifecycleStage.Production,
        resourceGroupName: "contoso-resources",
        serviceName: "contoso",
        title: "2023-01-01",
        versionName: "2023-01-01",
        workspaceName: "default",
    });
    
    resources:
      apiVersion:
        type: azure-native:apicenter:ApiVersion
        properties:
          apiName: echo-api
          lifecycleStage: production
          resourceGroupName: contoso-resources
          serviceName: contoso
          title: 2023-01-01
          versionName: 2023-01-01
          workspaceName: default
    

    Create ApiVersion Resource

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

    Constructor syntax

    new ApiVersion(name: string, args: ApiVersionArgs, opts?: CustomResourceOptions);
    @overload
    def ApiVersion(resource_name: str,
                   args: ApiVersionArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiVersion(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_name: Optional[str] = None,
                   lifecycle_stage: Optional[Union[str, LifecycleStage]] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   title: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   version_name: Optional[str] = None)
    func NewApiVersion(ctx *Context, name string, args ApiVersionArgs, opts ...ResourceOption) (*ApiVersion, error)
    public ApiVersion(string name, ApiVersionArgs args, CustomResourceOptions? opts = null)
    public ApiVersion(String name, ApiVersionArgs args)
    public ApiVersion(String name, ApiVersionArgs args, CustomResourceOptions options)
    
    type: azure-native:apicenter:ApiVersion
    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 ApiVersionArgs
    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 ApiVersionArgs
    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 ApiVersionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiVersionArgs
    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 apiVersionResource = new AzureNative.ApiCenter.ApiVersion("apiVersionResource", new()
    {
        ApiName = "string",
        LifecycleStage = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Title = "string",
        WorkspaceName = "string",
        VersionName = "string",
    });
    
    example, err := apicenter.NewApiVersion(ctx, "apiVersionResource", &apicenter.ApiVersionArgs{
    ApiName: pulumi.String("string"),
    LifecycleStage: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    Title: pulumi.String("string"),
    WorkspaceName: pulumi.String("string"),
    VersionName: pulumi.String("string"),
    })
    
    var apiVersionResource = new ApiVersion("apiVersionResource", ApiVersionArgs.builder()        
        .apiName("string")
        .lifecycleStage("string")
        .resourceGroupName("string")
        .serviceName("string")
        .title("string")
        .workspaceName("string")
        .versionName("string")
        .build());
    
    api_version_resource = azure_native.apicenter.ApiVersion("apiVersionResource",
        api_name="string",
        lifecycle_stage="string",
        resource_group_name="string",
        service_name="string",
        title="string",
        workspace_name="string",
        version_name="string")
    
    const apiVersionResource = new azure_native.apicenter.ApiVersion("apiVersionResource", {
        apiName: "string",
        lifecycleStage: "string",
        resourceGroupName: "string",
        serviceName: "string",
        title: "string",
        workspaceName: "string",
        versionName: "string",
    });
    
    type: azure-native:apicenter:ApiVersion
    properties:
        apiName: string
        lifecycleStage: string
        resourceGroupName: string
        serviceName: string
        title: string
        versionName: string
        workspaceName: string
    

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

    ApiName string
    The name of the API.
    LifecycleStage string | Pulumi.AzureNative.ApiCenter.LifecycleStage
    Current lifecycle stage 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 version title.
    WorkspaceName string
    The name of the workspace.
    VersionName string
    The name of the API version.
    ApiName string
    The name of the API.
    LifecycleStage string | LifecycleStage
    Current lifecycle stage 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 version title.
    WorkspaceName string
    The name of the workspace.
    VersionName string
    The name of the API version.
    apiName String
    The name of the API.
    lifecycleStage String | LifecycleStage
    Current lifecycle stage 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 version title.
    workspaceName String
    The name of the workspace.
    versionName String
    The name of the API version.
    apiName string
    The name of the API.
    lifecycleStage string | LifecycleStage
    Current lifecycle stage 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 version title.
    workspaceName string
    The name of the workspace.
    versionName string
    The name of the API version.
    api_name str
    The name of the API.
    lifecycle_stage str | LifecycleStage
    Current lifecycle stage 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 version title.
    workspace_name str
    The name of the workspace.
    version_name str
    The name of the API version.
    apiName String
    The name of the API.
    lifecycleStage String | "design" | "development" | "testing" | "preview" | "production" | "deprecated" | "retired"
    Current lifecycle stage 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 version title.
    workspaceName String
    The name of the workspace.
    versionName String
    The name of the API version.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    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
    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
    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
    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
    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
    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

    LifecycleStage, LifecycleStageArgs

    Design
    designdesign stage
    Development
    developmentdevelopment stage
    Testing
    testingtesting stage
    Preview
    previewIn preview
    Production
    productionIn production
    Deprecated
    deprecateddeprecated stage
    Retired
    retiredRetired stage
    LifecycleStageDesign
    designdesign stage
    LifecycleStageDevelopment
    developmentdevelopment stage
    LifecycleStageTesting
    testingtesting stage
    LifecycleStagePreview
    previewIn preview
    LifecycleStageProduction
    productionIn production
    LifecycleStageDeprecated
    deprecateddeprecated stage
    LifecycleStageRetired
    retiredRetired stage
    Design
    designdesign stage
    Development
    developmentdevelopment stage
    Testing
    testingtesting stage
    Preview
    previewIn preview
    Production
    productionIn production
    Deprecated
    deprecateddeprecated stage
    Retired
    retiredRetired stage
    Design
    designdesign stage
    Development
    developmentdevelopment stage
    Testing
    testingtesting stage
    Preview
    previewIn preview
    Production
    productionIn production
    Deprecated
    deprecateddeprecated stage
    Retired
    retiredRetired stage
    DESIGN
    designdesign stage
    DEVELOPMENT
    developmentdevelopment stage
    TESTING
    testingtesting stage
    PREVIEW
    previewIn preview
    PRODUCTION
    productionIn production
    DEPRECATED
    deprecateddeprecated stage
    RETIRED
    retiredRetired stage
    "design"
    designdesign stage
    "development"
    developmentdevelopment stage
    "testing"
    testingtesting stage
    "preview"
    previewIn preview
    "production"
    productionIn production
    "deprecated"
    deprecateddeprecated stage
    "retired"
    retiredRetired stage

    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:ApiVersion 2023-01-01 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName} 
    

    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.37.0 published on Monday, Apr 15, 2024 by Pulumi