1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. Deployment
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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.apicenter.Deployment

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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

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

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

    Example Usage

    Deployments_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var deployment = new AzureNative.ApiCenter.Deployment("deployment", new()
        {
            ApiName = "echo-api",
            DefinitionId = "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
            DeploymentName = "production",
            Description = "Public cloud production deployment.",
            EnvironmentId = "/workspaces/default/environments/production",
            ResourceGroupName = "contoso-resources",
            Server = new AzureNative.ApiCenter.Inputs.DeploymentServerArgs
            {
                RuntimeUri = new[]
                {
                    "https://api.contoso.com",
                },
            },
            ServiceName = "contoso",
            State = AzureNative.ApiCenter.DeploymentState.Active,
            Title = "Production deployment",
            WorkspaceName = "default",
        });
    
    });
    
    package main
    
    import (
    	apicenter "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.NewDeployment(ctx, "deployment", &apicenter.DeploymentArgs{
    			ApiName:           pulumi.String("echo-api"),
    			DefinitionId:      pulumi.String("/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi"),
    			DeploymentName:    pulumi.String("production"),
    			Description:       pulumi.String("Public cloud production deployment."),
    			EnvironmentId:     pulumi.String("/workspaces/default/environments/production"),
    			ResourceGroupName: pulumi.String("contoso-resources"),
    			Server: &apicenter.DeploymentServerArgs{
    				RuntimeUri: pulumi.StringArray{
    					pulumi.String("https://api.contoso.com"),
    				},
    			},
    			ServiceName:   pulumi.String("contoso"),
    			State:         pulumi.String(apicenter.DeploymentStateActive),
    			Title:         pulumi.String("Production deployment"),
    			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.Deployment;
    import com.pulumi.azurenative.apicenter.DeploymentArgs;
    import com.pulumi.azurenative.apicenter.inputs.DeploymentServerArgs;
    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 deployment = new Deployment("deployment", DeploymentArgs.builder()
                .apiName("echo-api")
                .definitionId("/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi")
                .deploymentName("production")
                .description("Public cloud production deployment.")
                .environmentId("/workspaces/default/environments/production")
                .resourceGroupName("contoso-resources")
                .server(DeploymentServerArgs.builder()
                    .runtimeUri("https://api.contoso.com")
                    .build())
                .serviceName("contoso")
                .state("active")
                .title("Production deployment")
                .workspaceName("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    deployment = azure_native.apicenter.Deployment("deployment",
        api_name="echo-api",
        definition_id="/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
        deployment_name="production",
        description="Public cloud production deployment.",
        environment_id="/workspaces/default/environments/production",
        resource_group_name="contoso-resources",
        server={
            "runtimeUri": ["https://api.contoso.com"],
        },
        service_name="contoso",
        state=azure_native.apicenter.DeploymentState.ACTIVE,
        title="Production deployment",
        workspace_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const deployment = new azure_native.apicenter.Deployment("deployment", {
        apiName: "echo-api",
        definitionId: "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi",
        deploymentName: "production",
        description: "Public cloud production deployment.",
        environmentId: "/workspaces/default/environments/production",
        resourceGroupName: "contoso-resources",
        server: {
            runtimeUri: ["https://api.contoso.com"],
        },
        serviceName: "contoso",
        state: azure_native.apicenter.DeploymentState.Active,
        title: "Production deployment",
        workspaceName: "default",
    });
    
    resources:
      deployment:
        type: azure-native:apicenter:Deployment
        properties:
          apiName: echo-api
          definitionId: /workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi
          deploymentName: production
          description: Public cloud production deployment.
          environmentId: /workspaces/default/environments/production
          resourceGroupName: contoso-resources
          server:
            runtimeUri:
              - https://api.contoso.com
          serviceName: contoso
          state: active
          title: Production deployment
          workspaceName: default
    

    Create Deployment Resource

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

    Constructor syntax

    new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
    @overload
    def Deployment(resource_name: str,
                   args: DeploymentArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Deployment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   custom_properties: Optional[Any] = None,
                   definition_id: Optional[str] = None,
                   deployment_name: Optional[str] = None,
                   description: Optional[str] = None,
                   environment_id: Optional[str] = None,
                   server: Optional[DeploymentServerArgs] = None,
                   state: Optional[Union[str, DeploymentState]] = None,
                   title: Optional[str] = None)
    func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
    public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
    public Deployment(String name, DeploymentArgs args)
    public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
    
    type: azure-native:apicenter:Deployment
    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 DeploymentArgs
    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 DeploymentArgs
    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 DeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentArgs
    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 deploymentResource = new AzureNative.ApiCenter.Deployment("deploymentResource", new()
    {
        ApiName = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        WorkspaceName = "string",
        CustomProperties = "any",
        DefinitionId = "string",
        DeploymentName = "string",
        Description = "string",
        EnvironmentId = "string",
        Server = new AzureNative.ApiCenter.Inputs.DeploymentServerArgs
        {
            RuntimeUri = new[]
            {
                "string",
            },
        },
        State = "string",
        Title = "string",
    });
    
    example, err := apicenter.NewDeployment(ctx, "deploymentResource", &apicenter.DeploymentArgs{
    	ApiName:           pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	ServiceName:       pulumi.String("string"),
    	WorkspaceName:     pulumi.String("string"),
    	CustomProperties:  pulumi.Any("any"),
    	DefinitionId:      pulumi.String("string"),
    	DeploymentName:    pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	EnvironmentId:     pulumi.String("string"),
    	Server: &apicenter.DeploymentServerArgs{
    		RuntimeUri: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	State: pulumi.String("string"),
    	Title: pulumi.String("string"),
    })
    
    var deploymentResource = new Deployment("deploymentResource", DeploymentArgs.builder()
        .apiName("string")
        .resourceGroupName("string")
        .serviceName("string")
        .workspaceName("string")
        .customProperties("any")
        .definitionId("string")
        .deploymentName("string")
        .description("string")
        .environmentId("string")
        .server(DeploymentServerArgs.builder()
            .runtimeUri("string")
            .build())
        .state("string")
        .title("string")
        .build());
    
    deployment_resource = azure_native.apicenter.Deployment("deploymentResource",
        api_name="string",
        resource_group_name="string",
        service_name="string",
        workspace_name="string",
        custom_properties="any",
        definition_id="string",
        deployment_name="string",
        description="string",
        environment_id="string",
        server={
            "runtimeUri": ["string"],
        },
        state="string",
        title="string")
    
    const deploymentResource = new azure_native.apicenter.Deployment("deploymentResource", {
        apiName: "string",
        resourceGroupName: "string",
        serviceName: "string",
        workspaceName: "string",
        customProperties: "any",
        definitionId: "string",
        deploymentName: "string",
        description: "string",
        environmentId: "string",
        server: {
            runtimeUri: ["string"],
        },
        state: "string",
        title: "string",
    });
    
    type: azure-native:apicenter:Deployment
    properties:
        apiName: string
        customProperties: any
        definitionId: string
        deploymentName: string
        description: string
        environmentId: string
        resourceGroupName: string
        server:
            runtimeUri:
                - string
        serviceName: string
        state: string
        title: string
        workspaceName: string
    

    Deployment 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 Deployment 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.
    WorkspaceName string
    The name of the workspace.
    CustomProperties object
    The custom metadata defined for API catalog entities.
    DefinitionId string
    API center-scoped definition resource ID.
    DeploymentName string
    The name of the API deployment.
    Description string
    Description of the deployment.
    EnvironmentId string
    API center-scoped environment resource ID.
    Server Pulumi.AzureNative.ApiCenter.Inputs.DeploymentServer
    The deployment server
    State string | Pulumi.AzureNative.ApiCenter.DeploymentState
    State of API deployment.
    Title string
    API deployment title
    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.
    WorkspaceName string
    The name of the workspace.
    CustomProperties interface{}
    The custom metadata defined for API catalog entities.
    DefinitionId string
    API center-scoped definition resource ID.
    DeploymentName string
    The name of the API deployment.
    Description string
    Description of the deployment.
    EnvironmentId string
    API center-scoped environment resource ID.
    Server DeploymentServerArgs
    The deployment server
    State string | DeploymentStateEnum
    State of API deployment.
    Title string
    API deployment title
    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.
    workspaceName String
    The name of the workspace.
    customProperties Object
    The custom metadata defined for API catalog entities.
    definitionId String
    API center-scoped definition resource ID.
    deploymentName String
    The name of the API deployment.
    description String
    Description of the deployment.
    environmentId String
    API center-scoped environment resource ID.
    server DeploymentServer
    The deployment server
    state String | DeploymentState
    State of API deployment.
    title String
    API deployment title
    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.
    workspaceName string
    The name of the workspace.
    customProperties any
    The custom metadata defined for API catalog entities.
    definitionId string
    API center-scoped definition resource ID.
    deploymentName string
    The name of the API deployment.
    description string
    Description of the deployment.
    environmentId string
    API center-scoped environment resource ID.
    server DeploymentServer
    The deployment server
    state string | DeploymentState
    State of API deployment.
    title string
    API deployment title
    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.
    workspace_name str
    The name of the workspace.
    custom_properties Any
    The custom metadata defined for API catalog entities.
    definition_id str
    API center-scoped definition resource ID.
    deployment_name str
    The name of the API deployment.
    description str
    Description of the deployment.
    environment_id str
    API center-scoped environment resource ID.
    server DeploymentServerArgs
    The deployment server
    state str | DeploymentState
    State of API deployment.
    title str
    API deployment title
    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.
    workspaceName String
    The name of the workspace.
    customProperties Any
    The custom metadata defined for API catalog entities.
    definitionId String
    API center-scoped definition resource ID.
    deploymentName String
    The name of the API deployment.
    description String
    Description of the deployment.
    environmentId String
    API center-scoped environment resource ID.
    server Property Map
    The deployment server
    state String | "active" | "inactive"
    State of API deployment.
    title String
    API deployment title

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Deployment 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

    DeploymentServer, DeploymentServerArgs

    RuntimeUri List<string>
    Base runtime URLs for this deployment.
    RuntimeUri []string
    Base runtime URLs for this deployment.
    runtimeUri List<String>
    Base runtime URLs for this deployment.
    runtimeUri string[]
    Base runtime URLs for this deployment.
    runtime_uri Sequence[str]
    Base runtime URLs for this deployment.
    runtimeUri List<String>
    Base runtime URLs for this deployment.

    DeploymentServerResponse, DeploymentServerResponseArgs

    RuntimeUri List<string>
    Base runtime URLs for this deployment.
    RuntimeUri []string
    Base runtime URLs for this deployment.
    runtimeUri List<String>
    Base runtime URLs for this deployment.
    runtimeUri string[]
    Base runtime URLs for this deployment.
    runtime_uri Sequence[str]
    Base runtime URLs for this deployment.
    runtimeUri List<String>
    Base runtime URLs for this deployment.

    DeploymentState, DeploymentStateArgs

    Active
    activeActive State
    Inactive
    inactiveInactive State
    DeploymentStateActive
    activeActive State
    DeploymentStateInactive
    inactiveInactive State
    Active
    activeActive State
    Inactive
    inactiveInactive State
    Active
    activeActive State
    Inactive
    inactiveInactive State
    ACTIVE
    activeActive State
    INACTIVE
    inactiveInactive State
    "active"
    activeActive State
    "inactive"
    inactiveInactive State

    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:Deployment production /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName} 
    

    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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi