azure-native.machinelearningservices.ConnectionDeployment
Explore with Pulumi AI
Azure REST API version: 2024-04-01-preview.
Other available API versions: 2024-07-01-preview, 2024-10-01-preview.
Example Usage
Create Azure OpenAI Connection Deployment
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var connectionDeployment = new AzureNative.MachineLearningServices.ConnectionDeployment("connectionDeployment", new()
    {
        ConnectionName = "testConnection",
        DeploymentName = "text-davinci-003",
        Properties = new AzureNative.MachineLearningServices.Inputs.EndpointDeploymentResourcePropertiesArgs
        {
            Model = new AzureNative.MachineLearningServices.Inputs.EndpointDeploymentModelArgs
            {
                Format = "OpenAI",
                Name = "text-davinci-003",
                Version = "1",
            },
            VersionUpgradeOption = AzureNative.MachineLearningServices.DeploymentModelVersionUpgradeOption.OnceNewDefaultVersionAvailable,
        },
        ResourceGroupName = "resourceGroup-1",
        WorkspaceName = "testworkspace",
    });
});
package main
import (
	machinelearningservices "github.com/pulumi/pulumi-azure-native-sdk/machinelearningservices/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := machinelearningservices.NewConnectionDeployment(ctx, "connectionDeployment", &machinelearningservices.ConnectionDeploymentArgs{
			ConnectionName: pulumi.String("testConnection"),
			DeploymentName: pulumi.String("text-davinci-003"),
			Properties: &machinelearningservices.EndpointDeploymentResourcePropertiesArgs{
				Model: &machinelearningservices.EndpointDeploymentModelArgs{
					Format:  pulumi.String("OpenAI"),
					Name:    pulumi.String("text-davinci-003"),
					Version: pulumi.String("1"),
				},
				VersionUpgradeOption: pulumi.String(machinelearningservices.DeploymentModelVersionUpgradeOptionOnceNewDefaultVersionAvailable),
			},
			ResourceGroupName: pulumi.String("resourceGroup-1"),
			WorkspaceName:     pulumi.String("testworkspace"),
		})
		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.machinelearningservices.ConnectionDeployment;
import com.pulumi.azurenative.machinelearningservices.ConnectionDeploymentArgs;
import com.pulumi.azurenative.machinelearningservices.inputs.EndpointDeploymentResourcePropertiesArgs;
import com.pulumi.azurenative.machinelearningservices.inputs.EndpointDeploymentModelArgs;
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 connectionDeployment = new ConnectionDeployment("connectionDeployment", ConnectionDeploymentArgs.builder()
            .connectionName("testConnection")
            .deploymentName("text-davinci-003")
            .properties(EndpointDeploymentResourcePropertiesArgs.builder()
                .model(EndpointDeploymentModelArgs.builder()
                    .format("OpenAI")
                    .name("text-davinci-003")
                    .version("1")
                    .build())
                .versionUpgradeOption("OnceNewDefaultVersionAvailable")
                .build())
            .resourceGroupName("resourceGroup-1")
            .workspaceName("testworkspace")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const connectionDeployment = new azure_native.machinelearningservices.ConnectionDeployment("connectionDeployment", {
    connectionName: "testConnection",
    deploymentName: "text-davinci-003",
    properties: {
        model: {
            format: "OpenAI",
            name: "text-davinci-003",
            version: "1",
        },
        versionUpgradeOption: azure_native.machinelearningservices.DeploymentModelVersionUpgradeOption.OnceNewDefaultVersionAvailable,
    },
    resourceGroupName: "resourceGroup-1",
    workspaceName: "testworkspace",
});
import pulumi
import pulumi_azure_native as azure_native
connection_deployment = azure_native.machinelearningservices.ConnectionDeployment("connectionDeployment",
    connection_name="testConnection",
    deployment_name="text-davinci-003",
    properties={
        "model": {
            "format": "OpenAI",
            "name": "text-davinci-003",
            "version": "1",
        },
        "version_upgrade_option": azure_native.machinelearningservices.DeploymentModelVersionUpgradeOption.ONCE_NEW_DEFAULT_VERSION_AVAILABLE,
    },
    resource_group_name="resourceGroup-1",
    workspace_name="testworkspace")
resources:
  connectionDeployment:
    type: azure-native:machinelearningservices:ConnectionDeployment
    properties:
      connectionName: testConnection
      deploymentName: text-davinci-003
      properties:
        model:
          format: OpenAI
          name: text-davinci-003
          version: '1'
        versionUpgradeOption: OnceNewDefaultVersionAvailable
      resourceGroupName: resourceGroup-1
      workspaceName: testworkspace
Create ConnectionDeployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConnectionDeployment(name: string, args: ConnectionDeploymentArgs, opts?: CustomResourceOptions);@overload
def ConnectionDeployment(resource_name: str,
                         args: ConnectionDeploymentArgs,
                         opts: Optional[ResourceOptions] = None)
@overload
def ConnectionDeployment(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         connection_name: Optional[str] = None,
                         properties: Optional[EndpointDeploymentResourcePropertiesArgs] = None,
                         resource_group_name: Optional[str] = None,
                         workspace_name: Optional[str] = None,
                         deployment_name: Optional[str] = None,
                         sku: Optional[CognitiveServicesSkuArgs] = None)func NewConnectionDeployment(ctx *Context, name string, args ConnectionDeploymentArgs, opts ...ResourceOption) (*ConnectionDeployment, error)public ConnectionDeployment(string name, ConnectionDeploymentArgs args, CustomResourceOptions? opts = null)
public ConnectionDeployment(String name, ConnectionDeploymentArgs args)
public ConnectionDeployment(String name, ConnectionDeploymentArgs args, CustomResourceOptions options)
type: azure-native:machinelearningservices:ConnectionDeployment
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 ConnectionDeploymentArgs
- 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 ConnectionDeploymentArgs
- 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 ConnectionDeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionDeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionDeploymentArgs
- 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 connectionDeploymentResource = new AzureNative.MachineLearningServices.ConnectionDeployment("connectionDeploymentResource", new()
{
    ConnectionName = "string",
    Properties = new AzureNative.MachineLearningServices.Inputs.EndpointDeploymentResourcePropertiesArgs
    {
        Model = new AzureNative.MachineLearningServices.Inputs.EndpointDeploymentModelArgs
        {
            Format = "string",
            Name = "string",
            Source = "string",
            Version = "string",
        },
        RaiPolicyName = "string",
        VersionUpgradeOption = "string",
    },
    ResourceGroupName = "string",
    WorkspaceName = "string",
    DeploymentName = "string",
    Sku = new AzureNative.MachineLearningServices.Inputs.CognitiveServicesSkuArgs
    {
        Capacity = 0,
        Family = "string",
        Name = "string",
        Size = "string",
        Tier = "string",
    },
});
example, err := machinelearningservices.NewConnectionDeployment(ctx, "connectionDeploymentResource", &machinelearningservices.ConnectionDeploymentArgs{
	ConnectionName: pulumi.String("string"),
	Properties: &machinelearningservices.EndpointDeploymentResourcePropertiesArgs{
		Model: &machinelearningservices.EndpointDeploymentModelArgs{
			Format:  pulumi.String("string"),
			Name:    pulumi.String("string"),
			Source:  pulumi.String("string"),
			Version: pulumi.String("string"),
		},
		RaiPolicyName:        pulumi.String("string"),
		VersionUpgradeOption: pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	DeploymentName:    pulumi.String("string"),
	Sku: &machinelearningservices.CognitiveServicesSkuArgs{
		Capacity: pulumi.Int(0),
		Family:   pulumi.String("string"),
		Name:     pulumi.String("string"),
		Size:     pulumi.String("string"),
		Tier:     pulumi.String("string"),
	},
})
var connectionDeploymentResource = new ConnectionDeployment("connectionDeploymentResource", ConnectionDeploymentArgs.builder()
    .connectionName("string")
    .properties(EndpointDeploymentResourcePropertiesArgs.builder()
        .model(EndpointDeploymentModelArgs.builder()
            .format("string")
            .name("string")
            .source("string")
            .version("string")
            .build())
        .raiPolicyName("string")
        .versionUpgradeOption("string")
        .build())
    .resourceGroupName("string")
    .workspaceName("string")
    .deploymentName("string")
    .sku(CognitiveServicesSkuArgs.builder()
        .capacity(0)
        .family("string")
        .name("string")
        .size("string")
        .tier("string")
        .build())
    .build());
connection_deployment_resource = azure_native.machinelearningservices.ConnectionDeployment("connectionDeploymentResource",
    connection_name="string",
    properties={
        "model": {
            "format": "string",
            "name": "string",
            "source": "string",
            "version": "string",
        },
        "rai_policy_name": "string",
        "version_upgrade_option": "string",
    },
    resource_group_name="string",
    workspace_name="string",
    deployment_name="string",
    sku={
        "capacity": 0,
        "family": "string",
        "name": "string",
        "size": "string",
        "tier": "string",
    })
const connectionDeploymentResource = new azure_native.machinelearningservices.ConnectionDeployment("connectionDeploymentResource", {
    connectionName: "string",
    properties: {
        model: {
            format: "string",
            name: "string",
            source: "string",
            version: "string",
        },
        raiPolicyName: "string",
        versionUpgradeOption: "string",
    },
    resourceGroupName: "string",
    workspaceName: "string",
    deploymentName: "string",
    sku: {
        capacity: 0,
        family: "string",
        name: "string",
        size: "string",
        tier: "string",
    },
});
type: azure-native:machinelearningservices:ConnectionDeployment
properties:
    connectionName: string
    deploymentName: string
    properties:
        model:
            format: string
            name: string
            source: string
            version: string
        raiPolicyName: string
        versionUpgradeOption: string
    resourceGroupName: string
    sku:
        capacity: 0
        family: string
        name: string
        size: string
        tier: string
    workspaceName: string
ConnectionDeployment 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 ConnectionDeployment resource accepts the following input properties:
- ConnectionName string
- Friendly name of the workspace connection
- Properties
Pulumi.Azure Native. Machine Learning Services. Inputs. Endpoint Deployment Resource Properties 
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- WorkspaceName string
- Azure Machine Learning Workspace Name
- DeploymentName string
- Name of the deployment resource
- Sku
Pulumi.Azure Native. Machine Learning Services. Inputs. Cognitive Services Sku 
- ConnectionName string
- Friendly name of the workspace connection
- Properties
EndpointDeployment Resource Properties Args 
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- WorkspaceName string
- Azure Machine Learning Workspace Name
- DeploymentName string
- Name of the deployment resource
- Sku
CognitiveServices Sku Args 
- connectionName String
- Friendly name of the workspace connection
- properties
EndpointDeployment Resource Properties 
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- workspaceName String
- Azure Machine Learning Workspace Name
- deploymentName String
- Name of the deployment resource
- sku
CognitiveServices Sku 
- connectionName string
- Friendly name of the workspace connection
- properties
EndpointDeployment Resource Properties 
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- workspaceName string
- Azure Machine Learning Workspace Name
- deploymentName string
- Name of the deployment resource
- sku
CognitiveServices Sku 
- connection_name str
- Friendly name of the workspace connection
- properties
EndpointDeployment Resource Properties Args 
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- workspace_name str
- Azure Machine Learning Workspace Name
- deployment_name str
- Name of the deployment resource
- sku
CognitiveServices Sku Args 
- connectionName String
- Friendly name of the workspace connection
- properties Property Map
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- workspaceName String
- Azure Machine Learning Workspace Name
- deploymentName String
- Name of the deployment resource
- sku Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the ConnectionDeployment 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.Azure Native. Machine Learning Services. Outputs. System Data Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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 SystemData Response 
- 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
CognitiveServicesSku, CognitiveServicesSkuArgs      
CognitiveServicesSkuResponse, CognitiveServicesSkuResponseArgs        
DeploymentModelVersionUpgradeOption, DeploymentModelVersionUpgradeOptionArgs          
- OnceNew Default Version Available 
- OnceNewDefaultVersionAvailable
- OnceCurrent Version Expired 
- OnceCurrentVersionExpired
- NoAuto Upgrade 
- NoAutoUpgrade
- DeploymentModel Version Upgrade Option Once New Default Version Available 
- OnceNewDefaultVersionAvailable
- DeploymentModel Version Upgrade Option Once Current Version Expired 
- OnceCurrentVersionExpired
- DeploymentModel Version Upgrade Option No Auto Upgrade 
- NoAutoUpgrade
- OnceNew Default Version Available 
- OnceNewDefaultVersionAvailable
- OnceCurrent Version Expired 
- OnceCurrentVersionExpired
- NoAuto Upgrade 
- NoAutoUpgrade
- OnceNew Default Version Available 
- OnceNewDefaultVersionAvailable
- OnceCurrent Version Expired 
- OnceCurrentVersionExpired
- NoAuto Upgrade 
- NoAutoUpgrade
- ONCE_NEW_DEFAULT_VERSION_AVAILABLE
- OnceNewDefaultVersionAvailable
- ONCE_CURRENT_VERSION_EXPIRED
- OnceCurrentVersionExpired
- NO_AUTO_UPGRADE
- NoAutoUpgrade
- "OnceNew Default Version Available" 
- OnceNewDefaultVersionAvailable
- "OnceCurrent Version Expired" 
- OnceCurrentVersionExpired
- "NoAuto Upgrade" 
- NoAutoUpgrade
EndpointDeploymentModel, EndpointDeploymentModelArgs      
EndpointDeploymentModelResponse, EndpointDeploymentModelResponseArgs        
EndpointDeploymentResourceProperties, EndpointDeploymentResourcePropertiesArgs        
- Model
Pulumi.Azure Native. Machine Learning Services. Inputs. Endpoint Deployment Model 
- Model used for the endpoint deployment.
- RaiPolicy stringName 
- The name of RAI policy.
- VersionUpgrade string | Pulumi.Option Azure Native. Machine Learning Services. Deployment Model Version Upgrade Option 
- Deployment model version upgrade option.
- Model
EndpointDeployment Model 
- Model used for the endpoint deployment.
- RaiPolicy stringName 
- The name of RAI policy.
- VersionUpgrade string | DeploymentOption Model Version Upgrade Option 
- Deployment model version upgrade option.
- model
EndpointDeployment Model 
- Model used for the endpoint deployment.
- raiPolicy StringName 
- The name of RAI policy.
- versionUpgrade String | DeploymentOption Model Version Upgrade Option 
- Deployment model version upgrade option.
- model
EndpointDeployment Model 
- Model used for the endpoint deployment.
- raiPolicy stringName 
- The name of RAI policy.
- versionUpgrade string | DeploymentOption Model Version Upgrade Option 
- Deployment model version upgrade option.
- model
EndpointDeployment Model 
- Model used for the endpoint deployment.
- rai_policy_ strname 
- The name of RAI policy.
- version_upgrade_ str | Deploymentoption Model Version Upgrade Option 
- Deployment model version upgrade option.
- model Property Map
- Model used for the endpoint deployment.
- raiPolicy StringName 
- The name of RAI policy.
- versionUpgrade String | "OnceOption New Default Version Available" | "Once Current Version Expired" | "No Auto Upgrade" 
- Deployment model version upgrade option.
EndpointDeploymentResourcePropertiesResponse, EndpointDeploymentResourcePropertiesResponseArgs          
- Model
Pulumi.Azure Native. Machine Learning Services. Inputs. Endpoint Deployment Model Response 
- Model used for the endpoint deployment.
- ProvisioningState string
- Read-only provision state status property.
- RaiPolicy stringName 
- The name of RAI policy.
- VersionUpgrade stringOption 
- Deployment model version upgrade option.
- Model
EndpointDeployment Model Response 
- Model used for the endpoint deployment.
- ProvisioningState string
- Read-only provision state status property.
- RaiPolicy stringName 
- The name of RAI policy.
- VersionUpgrade stringOption 
- Deployment model version upgrade option.
- model
EndpointDeployment Model Response 
- Model used for the endpoint deployment.
- provisioningState String
- Read-only provision state status property.
- raiPolicy StringName 
- The name of RAI policy.
- versionUpgrade StringOption 
- Deployment model version upgrade option.
- model
EndpointDeployment Model Response 
- Model used for the endpoint deployment.
- provisioningState string
- Read-only provision state status property.
- raiPolicy stringName 
- The name of RAI policy.
- versionUpgrade stringOption 
- Deployment model version upgrade option.
- model
EndpointDeployment Model Response 
- Model used for the endpoint deployment.
- provisioning_state str
- Read-only provision state status property.
- rai_policy_ strname 
- The name of RAI policy.
- version_upgrade_ stroption 
- Deployment model version upgrade option.
- model Property Map
- Model used for the endpoint deployment.
- provisioningState String
- Read-only provision state status property.
- raiPolicy StringName 
- The name of RAI policy.
- versionUpgrade StringOption 
- Deployment model version upgrade option.
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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:machinelearningservices:ConnectionDeployment text-davinci-003 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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