1. Packages
  2. Azure Native v1
  3. API Docs
  4. machinelearningservices
  5. BatchEndpoint
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.machinelearningservices.BatchEndpoint

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

API Version: 2021-03-01-preview.

Example Usage

CreateOrUpdate Batch Endpoint.

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

return await Deployment.RunAsync(() => 
{
    var batchEndpoint = new AzureNative.MachineLearningServices.BatchEndpoint("batchEndpoint", new()
    {
        EndpointName = "testBatchEndpoint",
        Identity = new AzureNative.MachineLearningServices.Inputs.ResourceIdentityArgs
        {
            Type = "UserAssigned",
            UserAssignedIdentities = 
            {
                { "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity", new AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityMetaArgs
                {
                    ClientId = "string",
                    PrincipalId = "string",
                } },
            },
        },
        Kind = "string",
        Location = "string",
        Properties = new AzureNative.MachineLearningServices.Inputs.BatchEndpointArgs
        {
            AuthMode = "AMLToken",
            Description = "string",
            Keys = new AzureNative.MachineLearningServices.Inputs.EndpointAuthKeysArgs
            {
                PrimaryKey = "string",
                SecondaryKey = "string",
            },
            Properties = 
            {
                { "additionalProp1", "string" },
                { "additionalProp2", "string" },
                { "additionalProp3", "string" },
            },
            Traffic = 
            {
                { "myDeployment1", 0 },
                { "myDeployment2", 1 },
            },
        },
        ResourceGroupName = "resourceGroup-1234",
        Tags = 
        {
            { "additionalProp1", "string" },
            { "additionalProp2", "string" },
            { "additionalProp3", "string" },
        },
        WorkspaceName = "testworkspace",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := machinelearningservices.NewBatchEndpoint(ctx, "batchEndpoint", &machinelearningservices.BatchEndpointArgs{
			EndpointName: pulumi.String("testBatchEndpoint"),
			Identity: machinelearningservices.ResourceIdentityResponse{
				Type: pulumi.String("UserAssigned"),
				UserAssignedIdentities: machinelearningservices.UserAssignedIdentityMetaMap{
					"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": &machinelearningservices.UserAssignedIdentityMetaArgs{
						ClientId:    pulumi.String("string"),
						PrincipalId: pulumi.String("string"),
					},
				},
			},
			Kind:     pulumi.String("string"),
			Location: pulumi.String("string"),
			Properties: machinelearningservices.BatchEndpointResponse{
				AuthMode:    pulumi.String("AMLToken"),
				Description: pulumi.String("string"),
				Keys: &machinelearningservices.EndpointAuthKeysArgs{
					PrimaryKey:   pulumi.String("string"),
					SecondaryKey: pulumi.String("string"),
				},
				Properties: pulumi.StringMap{
					"additionalProp1": pulumi.String("string"),
					"additionalProp2": pulumi.String("string"),
					"additionalProp3": pulumi.String("string"),
				},
				Traffic: pulumi.IntMap{
					"myDeployment1": pulumi.Int(0),
					"myDeployment2": pulumi.Int(1),
				},
			},
			ResourceGroupName: pulumi.String("resourceGroup-1234"),
			Tags: pulumi.StringMap{
				"additionalProp1": pulumi.String("string"),
				"additionalProp2": pulumi.String("string"),
				"additionalProp3": pulumi.String("string"),
			},
			WorkspaceName: pulumi.String("testworkspace"),
		})
		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.machinelearningservices.BatchEndpoint;
import com.pulumi.azurenative.machinelearningservices.BatchEndpointArgs;
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 batchEndpoint = new BatchEndpoint("batchEndpoint", BatchEndpointArgs.builder()        
            .endpointName("testBatchEndpoint")
            .identity(Map.ofEntries(
                Map.entry("type", "UserAssigned"),
                Map.entry("userAssignedIdentities", Map.of("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity", Map.ofEntries(
                    Map.entry("clientId", "string"),
                    Map.entry("principalId", "string")
                )))
            ))
            .kind("string")
            .location("string")
            .properties(Map.ofEntries(
                Map.entry("authMode", "AMLToken"),
                Map.entry("description", "string"),
                Map.entry("keys", Map.ofEntries(
                    Map.entry("primaryKey", "string"),
                    Map.entry("secondaryKey", "string")
                )),
                Map.entry("properties", Map.ofEntries(
                    Map.entry("additionalProp1", "string"),
                    Map.entry("additionalProp2", "string"),
                    Map.entry("additionalProp3", "string")
                )),
                Map.entry("traffic", Map.ofEntries(
                    Map.entry("myDeployment1", 0),
                    Map.entry("myDeployment2", 1)
                ))
            ))
            .resourceGroupName("resourceGroup-1234")
            .tags(Map.ofEntries(
                Map.entry("additionalProp1", "string"),
                Map.entry("additionalProp2", "string"),
                Map.entry("additionalProp3", "string")
            ))
            .workspaceName("testworkspace")
            .build());

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

const batchEndpoint = new azure_native.machinelearningservices.BatchEndpoint("batchEndpoint", {
    endpointName: "testBatchEndpoint",
    identity: {
        type: "UserAssigned",
        userAssignedIdentities: {
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": {
                clientId: "string",
                principalId: "string",
            },
        },
    },
    kind: "string",
    location: "string",
    properties: {
        authMode: "AMLToken",
        description: "string",
        keys: {
            primaryKey: "string",
            secondaryKey: "string",
        },
        properties: {
            additionalProp1: "string",
            additionalProp2: "string",
            additionalProp3: "string",
        },
        traffic: {
            myDeployment1: 0,
            myDeployment2: 1,
        },
    },
    resourceGroupName: "resourceGroup-1234",
    tags: {
        additionalProp1: "string",
        additionalProp2: "string",
        additionalProp3: "string",
    },
    workspaceName: "testworkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

batch_endpoint = azure_native.machinelearningservices.BatchEndpoint("batchEndpoint",
    endpoint_name="testBatchEndpoint",
    identity=azure_native.machinelearningservices.ResourceIdentityResponseArgs(
        type="UserAssigned",
        user_assigned_identities={
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity": azure_native.machinelearningservices.UserAssignedIdentityMetaArgs(
                client_id="string",
                principal_id="string",
            ),
        },
    ),
    kind="string",
    location="string",
    properties=azure_native.machinelearningservices.BatchEndpointResponseArgs(
        auth_mode="AMLToken",
        description="string",
        keys=azure_native.machinelearningservices.EndpointAuthKeysArgs(
            primary_key="string",
            secondary_key="string",
        ),
        properties={
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string",
        },
        traffic={
            "myDeployment1": 0,
            "myDeployment2": 1,
        },
    ),
    resource_group_name="resourceGroup-1234",
    tags={
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string",
    },
    workspace_name="testworkspace")
Copy
resources:
  batchEndpoint:
    type: azure-native:machinelearningservices:BatchEndpoint
    properties:
      endpointName: testBatchEndpoint
      identity:
        type: UserAssigned
        userAssignedIdentities:
          ? /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuseridentity
          : clientId: string
            principalId: string
      kind: string
      location: string
      properties:
        authMode: AMLToken
        description: string
        keys:
          primaryKey: string
          secondaryKey: string
        properties:
          additionalProp1: string
          additionalProp2: string
          additionalProp3: string
        traffic:
          myDeployment1: 0
          myDeployment2: 1
      resourceGroupName: resourceGroup-1234
      tags:
        additionalProp1: string
        additionalProp2: string
        additionalProp3: string
      workspaceName: testworkspace
Copy

Create BatchEndpoint Resource

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

Constructor syntax

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

@overload
def BatchEndpoint(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  properties: Optional[BatchEndpointArgs] = None,
                  resource_group_name: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  endpoint_name: Optional[str] = None,
                  identity: Optional[ResourceIdentityArgs] = None,
                  kind: Optional[str] = None,
                  location: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewBatchEndpoint(ctx *Context, name string, args BatchEndpointArgs, opts ...ResourceOption) (*BatchEndpoint, error)
public BatchEndpoint(string name, BatchEndpointArgs args, CustomResourceOptions? opts = null)
public BatchEndpoint(String name, BatchEndpointArgs args)
public BatchEndpoint(String name, BatchEndpointArgs args, CustomResourceOptions options)
type: azure-native:machinelearningservices:BatchEndpoint
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. BatchEndpointArgs
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. BatchEndpointInitArgs
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. BatchEndpointArgs
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. BatchEndpointArgs
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. BatchEndpointArgs
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 batchEndpointResource = new AzureNative.Machinelearningservices.BatchEndpoint("batchEndpointResource", new()
{
    Properties = 
    {
        { "authMode", "string" },
        { "description", "string" },
        { "keys", 
        {
            { "primaryKey", "string" },
            { "secondaryKey", "string" },
        } },
        { "properties", 
        {
            { "string", "string" },
        } },
        { "traffic", 
        {
            { "string", 0 },
        } },
    },
    ResourceGroupName = "string",
    WorkspaceName = "string",
    EndpointName = "string",
    Identity = 
    {
        { "type", "string" },
        { "userAssignedIdentities", 
        {
            { "string", 
            {
                { "clientId", "string" },
                { "principalId", "string" },
            } },
        } },
    },
    Kind = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := machinelearningservices.NewBatchEndpoint(ctx, "batchEndpointResource", &machinelearningservices.BatchEndpointArgs{
	Properties: map[string]interface{}{
		"authMode":    "string",
		"description": "string",
		"keys": map[string]interface{}{
			"primaryKey":   "string",
			"secondaryKey": "string",
		},
		"properties": map[string]interface{}{
			"string": "string",
		},
		"traffic": map[string]interface{}{
			"string": 0,
		},
	},
	ResourceGroupName: "string",
	WorkspaceName:     "string",
	EndpointName:      "string",
	Identity: map[string]interface{}{
		"type": "string",
		"userAssignedIdentities": map[string]interface{}{
			"string": map[string]interface{}{
				"clientId":    "string",
				"principalId": "string",
			},
		},
	},
	Kind:     "string",
	Location: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var batchEndpointResource = new BatchEndpoint("batchEndpointResource", BatchEndpointArgs.builder()
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .workspaceName("string")
    .endpointName("string")
    .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .kind("string")
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
batch_endpoint_resource = azure_native.machinelearningservices.BatchEndpoint("batchEndpointResource",
    properties={
        authMode: string,
        description: string,
        keys: {
            primaryKey: string,
            secondaryKey: string,
        },
        properties: {
            string: string,
        },
        traffic: {
            string: 0,
        },
    },
    resource_group_name=string,
    workspace_name=string,
    endpoint_name=string,
    identity={
        type: string,
        userAssignedIdentities: {
            string: {
                clientId: string,
                principalId: string,
            },
        },
    },
    kind=string,
    location=string,
    tags={
        string: string,
    })
Copy
const batchEndpointResource = new azure_native.machinelearningservices.BatchEndpoint("batchEndpointResource", {
    properties: {
        authMode: "string",
        description: "string",
        keys: {
            primaryKey: "string",
            secondaryKey: "string",
        },
        properties: {
            string: "string",
        },
        traffic: {
            string: 0,
        },
    },
    resourceGroupName: "string",
    workspaceName: "string",
    endpointName: "string",
    identity: {
        type: "string",
        userAssignedIdentities: {
            string: {
                clientId: "string",
                principalId: "string",
            },
        },
    },
    kind: "string",
    location: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:machinelearningservices:BatchEndpoint
properties:
    endpointName: string
    identity:
        type: string
        userAssignedIdentities:
            string:
                clientId: string
                principalId: string
    kind: string
    location: string
    properties:
        authMode: string
        description: string
        keys:
            primaryKey: string
            secondaryKey: string
        properties:
            string: string
        traffic:
            string: 0
    resourceGroupName: string
    tags:
        string: string
    workspaceName: string
Copy

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

Properties This property is required. Pulumi.AzureNative.MachineLearningServices.Inputs.BatchEndpoint
[Required] Additional attributes of the entity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Azure Machine Learning workspace.
EndpointName Changes to this property will trigger replacement. string
Name for the Batch inference endpoint.
Identity Pulumi.AzureNative.MachineLearningServices.Inputs.ResourceIdentity
Service identity associated with a resource.
Kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
Properties This property is required. BatchEndpointTypeArgs
[Required] Additional attributes of the entity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Azure Machine Learning workspace.
EndpointName Changes to this property will trigger replacement. string
Name for the Batch inference endpoint.
Identity ResourceIdentityArgs
Service identity associated with a resource.
Kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
properties This property is required. BatchEndpoint
[Required] Additional attributes of the entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Azure Machine Learning workspace.
endpointName Changes to this property will trigger replacement. String
Name for the Batch inference endpoint.
identity ResourceIdentity
Service identity associated with a resource.
kind String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
properties This property is required. BatchEndpoint
[Required] Additional attributes of the entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Azure Machine Learning workspace.
endpointName Changes to this property will trigger replacement. string
Name for the Batch inference endpoint.
identity ResourceIdentity
Service identity associated with a resource.
kind string
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
properties This property is required. BatchEndpointArgs
[Required] Additional attributes of the entity.
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.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
Name of Azure Machine Learning workspace.
endpoint_name Changes to this property will trigger replacement. str
Name for the Batch inference endpoint.
identity ResourceIdentityArgs
Service identity associated with a resource.
kind str
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
properties This property is required. Property Map
[Required] Additional attributes of the entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Azure Machine Learning workspace.
endpointName Changes to this property will trigger replacement. String
Name for the Batch inference endpoint.
identity Property Map
Service identity associated with a resource.
kind String
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the BatchEndpoint 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.MachineLearningServices.Outputs.SystemDataResponse
System data associated with resource provider
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
System data associated with resource provider
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
System data associated with resource provider
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
System data associated with resource provider
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
System data associated with resource provider
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
System data associated with resource provider
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

BatchEndpoint
, BatchEndpointArgs

AuthMode string | Pulumi.AzureNative.MachineLearningServices.EndpointAuthMode
[Required] Inference endpoint authentication mode type
Description string
Description of the inference endpoint.
Keys Pulumi.AzureNative.MachineLearningServices.Inputs.EndpointAuthKeys
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
Properties Dictionary<string, string>
Property dictionary. Properties can be added, but not removed or altered.
Traffic Dictionary<string, int>
Traffic rules on how the traffic will be routed across deployments.
AuthMode string | EndpointAuthMode
[Required] Inference endpoint authentication mode type
Description string
Description of the inference endpoint.
Keys EndpointAuthKeys
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
Properties map[string]string
Property dictionary. Properties can be added, but not removed or altered.
Traffic map[string]int
Traffic rules on how the traffic will be routed across deployments.
authMode String | EndpointAuthMode
[Required] Inference endpoint authentication mode type
description String
Description of the inference endpoint.
keys EndpointAuthKeys
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
properties Map<String,String>
Property dictionary. Properties can be added, but not removed or altered.
traffic Map<String,Integer>
Traffic rules on how the traffic will be routed across deployments.
authMode string | EndpointAuthMode
[Required] Inference endpoint authentication mode type
description string
Description of the inference endpoint.
keys EndpointAuthKeys
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
properties {[key: string]: string}
Property dictionary. Properties can be added, but not removed or altered.
traffic {[key: string]: number}
Traffic rules on how the traffic will be routed across deployments.
auth_mode str | EndpointAuthMode
[Required] Inference endpoint authentication mode type
description str
Description of the inference endpoint.
keys EndpointAuthKeys
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
properties Mapping[str, str]
Property dictionary. Properties can be added, but not removed or altered.
traffic Mapping[str, int]
Traffic rules on how the traffic will be routed across deployments.
authMode String | "AMLToken" | "Key" | "AADToken"
[Required] Inference endpoint authentication mode type
description String
Description of the inference endpoint.
keys Property Map
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
properties Map<String>
Property dictionary. Properties can be added, but not removed or altered.
traffic Map<Number>
Traffic rules on how the traffic will be routed across deployments.

BatchEndpointResponse
, BatchEndpointResponseArgs

ScoringUri This property is required. string
Endpoint URI.
SwaggerUri This property is required. string
Endpoint Swagger URI.
AuthMode string
[Required] Inference endpoint authentication mode type
Description string
Description of the inference endpoint.
Properties Dictionary<string, string>
Property dictionary. Properties can be added, but not removed or altered.
Traffic Dictionary<string, int>
Traffic rules on how the traffic will be routed across deployments.
ScoringUri This property is required. string
Endpoint URI.
SwaggerUri This property is required. string
Endpoint Swagger URI.
AuthMode string
[Required] Inference endpoint authentication mode type
Description string
Description of the inference endpoint.
Properties map[string]string
Property dictionary. Properties can be added, but not removed or altered.
Traffic map[string]int
Traffic rules on how the traffic will be routed across deployments.
scoringUri This property is required. String
Endpoint URI.
swaggerUri This property is required. String
Endpoint Swagger URI.
authMode String
[Required] Inference endpoint authentication mode type
description String
Description of the inference endpoint.
properties Map<String,String>
Property dictionary. Properties can be added, but not removed or altered.
traffic Map<String,Integer>
Traffic rules on how the traffic will be routed across deployments.
scoringUri This property is required. string
Endpoint URI.
swaggerUri This property is required. string
Endpoint Swagger URI.
authMode string
[Required] Inference endpoint authentication mode type
description string
Description of the inference endpoint.
properties {[key: string]: string}
Property dictionary. Properties can be added, but not removed or altered.
traffic {[key: string]: number}
Traffic rules on how the traffic will be routed across deployments.
scoring_uri This property is required. str
Endpoint URI.
swagger_uri This property is required. str
Endpoint Swagger URI.
auth_mode str
[Required] Inference endpoint authentication mode type
description str
Description of the inference endpoint.
properties Mapping[str, str]
Property dictionary. Properties can be added, but not removed or altered.
traffic Mapping[str, int]
Traffic rules on how the traffic will be routed across deployments.
scoringUri This property is required. String
Endpoint URI.
swaggerUri This property is required. String
Endpoint Swagger URI.
authMode String
[Required] Inference endpoint authentication mode type
description String
Description of the inference endpoint.
properties Map<String>
Property dictionary. Properties can be added, but not removed or altered.
traffic Map<Number>
Traffic rules on how the traffic will be routed across deployments.

EndpointAuthKeys
, EndpointAuthKeysArgs

PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
primaryKey String
The primary key.
secondaryKey String
The secondary key.
primaryKey string
The primary key.
secondaryKey string
The secondary key.
primary_key str
The primary key.
secondary_key str
The secondary key.
primaryKey String
The primary key.
secondaryKey String
The secondary key.

EndpointAuthMode
, EndpointAuthModeArgs

AMLToken
AMLToken
Key
Key
AADToken
AADToken
EndpointAuthModeAMLToken
AMLToken
EndpointAuthModeKey
Key
EndpointAuthModeAADToken
AADToken
AMLToken
AMLToken
Key
Key
AADToken
AADToken
AMLToken
AMLToken
Key
Key
AADToken
AADToken
AML_TOKEN
AMLToken
KEY
Key
AAD_TOKEN
AADToken
"AMLToken"
AMLToken
"Key"
Key
"AADToken"
AADToken

ResourceIdentity
, ResourceIdentityArgs

Type string | Pulumi.AzureNative.MachineLearningServices.ResourceIdentityAssignment
Defines values for a ResourceIdentity's type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityMeta>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
Type string | ResourceIdentityAssignment
Defines values for a ResourceIdentity's type.
UserAssignedIdentities map[string]UserAssignedIdentityMeta
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
type String | ResourceIdentityAssignment
Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<String,UserAssignedIdentityMeta>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
type string | ResourceIdentityAssignment
Defines values for a ResourceIdentity's type.
userAssignedIdentities {[key: string]: UserAssignedIdentityMeta}
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
type str | ResourceIdentityAssignment
Defines values for a ResourceIdentity's type.
user_assigned_identities Mapping[str, UserAssignedIdentityMeta]
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
type String | "SystemAssigned" | "UserAssigned" | "SystemAssigned,UserAssigned" | "None"
Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<Property Map>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

ResourceIdentityAssignment
, ResourceIdentityAssignmentArgs

SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
ResourceIdentityAssignmentSystemAssigned
SystemAssigned
ResourceIdentityAssignmentUserAssigned
UserAssigned
ResourceIdentityAssignment_SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
ResourceIdentityAssignmentNone
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SYSTEM_ASSIGNED
SystemAssigned
USER_ASSIGNED
UserAssigned
SYSTEM_ASSIGNED_USER_ASSIGNED
SystemAssigned,UserAssigned
NONE
None
"SystemAssigned"
SystemAssigned
"UserAssigned"
UserAssigned
"SystemAssigned,UserAssigned"
SystemAssigned,UserAssigned
"None"
None

ResourceIdentityResponse
, ResourceIdentityResponseArgs

PrincipalId This property is required. string
Client ID that is used when authenticating.
TenantId This property is required. string
AAD Tenant where this identity lives.
Type string
Defines values for a ResourceIdentity's type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityMetaResponse>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
PrincipalId This property is required. string
Client ID that is used when authenticating.
TenantId This property is required. string
AAD Tenant where this identity lives.
Type string
Defines values for a ResourceIdentity's type.
UserAssignedIdentities map[string]UserAssignedIdentityMetaResponse
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
principalId This property is required. String
Client ID that is used when authenticating.
tenantId This property is required. String
AAD Tenant where this identity lives.
type String
Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<String,UserAssignedIdentityMetaResponse>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
principalId This property is required. string
Client ID that is used when authenticating.
tenantId This property is required. string
AAD Tenant where this identity lives.
type string
Defines values for a ResourceIdentity's type.
userAssignedIdentities {[key: string]: UserAssignedIdentityMetaResponse}
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
principal_id This property is required. str
Client ID that is used when authenticating.
tenant_id This property is required. str
AAD Tenant where this identity lives.
type str
Defines values for a ResourceIdentity's type.
user_assigned_identities Mapping[str, UserAssignedIdentityMetaResponse]
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.
principalId This property is required. String
Client ID that is used when authenticating.
tenantId This property is required. String
AAD Tenant where this identity lives.
type String
Defines values for a ResourceIdentity's type.
userAssignedIdentities Map<Property Map>
Dictionary of the user assigned identities, key is ARM resource ID of the UAI.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC)
CreatedBy string
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for 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
An identifier for the identity that last modified the resource
lastModifiedByType String
The type of identity that last modified the resource

UserAssignedIdentityMeta
, UserAssignedIdentityMetaArgs

ClientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
ClientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId String
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
client_id str
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principal_id str
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId String
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

UserAssignedIdentityMetaResponse
, UserAssignedIdentityMetaResponseArgs

ClientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
ClientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
PrincipalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId String
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId string
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId string
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
client_id str
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principal_id str
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.
clientId String
Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning.
principalId String
The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource.

Import

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

$ pulumi import azure-native:machinelearningservices:BatchEndpoint testBatchEndpoint /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/batchEndpoints/testBatchEndpoint 
Copy

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

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi