Compartilhar via


Batch Endpoints - Create Or Update

Cria um ponto de extremidade de inferência em lote (assíncrono).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}?api-version=2024-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpointName
path True

string

Nome do ponto de extremidade de inferência do Lote.

Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

workspaceName
path True

string

Nome do workspace do Azure Machine Learning.

Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

A localização geográfica em que o recurso reside

properties True

BatchEndpoint

[Obrigatório] Atributos adicionais da entidade.

identity

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

kind

string

Metadados usados pelo portal/ferramentas/etc para renderizar experiências de experiência de usuário diferentes para recursos do mesmo tipo.

sku

Sku

Detalhes de SKU necessários para o contrato do ARM para dimensionamento automático.

tags

object

Marcas de recurso.

Respostas

Nome Tipo Description
200 OK

BatchEndpointTrackedResource

Create ou a solicitação de atualização foi bem-sucedida.

201 Created

BatchEndpointTrackedResource

Criado

Cabeçalhos

  • x-ms-async-operation-timeout: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Erro

Exemplos

CreateOrUpdate Workspace Batch Endpoint.

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName?api-version=2024-04-01

{
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    }
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Resposta de exemplo

{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "principalId": "00000000-1111-2222-3333-444444444444",
        "clientId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}
{
  "id": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "scoringUri": "https://www.contoso.com/example",
    "swaggerUri": "https://www.contoso.com/example",
    "authMode": "AMLToken",
    "defaults": {
      "deploymentName": "string"
    },
    "provisioningState": "Updating"
  },
  "systemData": {
    "createdAt": "2020-01-01T12:34:56.999Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-01-01T12:34:56.999Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444",
    "userAssignedIdentities": {
      "string": {
        "principalId": "00000000-1111-2222-3333-444444444444",
        "clientId": "00000000-1111-2222-3333-444444444444"
      }
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Definições

Nome Description
BatchEndpoint

Configuração do ponto de extremidade do lote.

BatchEndpointDefaults

Valores padrão do ponto de extremidade do lote

BatchEndpointTrackedResource
createdByType

O tipo de identidade que criou o recurso.

EndpointAuthKeys

Chaves para autenticação de ponto de extremidade.

EndpointAuthMode

Enumeração para determinar o modo de autenticação de ponto de extremidade.

EndpointProvisioningState

Estado do provisionamento de ponto de extremidade.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

Sku

A definição do modelo de recurso que representa o SKU

SkuTier

Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

systemData

Metadados relativos à criação e à última modificação do recurso.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

BatchEndpoint

Configuração do ponto de extremidade do lote.

Nome Tipo Description
authMode

EndpointAuthMode

[Obrigatório] Use 'Key' para autenticação baseada em chave e 'AMLToken' para autenticação baseada em token do Azure Machine Learning. 'Key' não expira, mas 'AMLToken' expira.

defaults

BatchEndpointDefaults

Valores padrão para o Ponto de Extremidade do Lote

description

string

Descrição do ponto de extremidade de inferência.

keys

EndpointAuthKeys

EndpointAuthKeys a ser definido inicialmente em um ponto de extremidade. Essa propriedade sempre será retornada como nula. Os valores de AuthKey devem ser recuperados usando a API ListKeys.

properties

object

Dicionário de propriedades. As propriedades podem ser adicionadas, mas não removidas ou alteradas.

provisioningState

EndpointProvisioningState

Estado de provisionamento para o ponto de extremidade.

scoringUri

string

URI do ponto de extremidade.

swaggerUri

string

URI do Swagger do ponto de extremidade.

BatchEndpointDefaults

Valores padrão do ponto de extremidade do lote

Nome Tipo Description
deploymentName

string

Nome da implantação que será padrão para o ponto de extremidade. Essa implantação acabará recebendo 100% de tráfego quando a URL de pontuação do ponto de extremidade for invocada.

BatchEndpointTrackedResource

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

kind

string

Metadados usados pelo portal/ferramentas/etc para renderizar experiências de experiência de usuário diferentes para recursos do mesmo tipo.

location

string

A localização geográfica em que o recurso reside

name

string

O nome do recurso

properties

BatchEndpoint

[Obrigatório] Atributos adicionais da entidade.

sku

Sku

Detalhes de SKU necessários para o contrato do ARM para dimensionamento automático.

systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

tags

object

Marcas de recurso.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

EndpointAuthKeys

Chaves para autenticação de ponto de extremidade.

Nome Tipo Description
primaryKey

string

A chave principal.

secondaryKey

string

A chave secundária.

EndpointAuthMode

Enumeração para determinar o modo de autenticação de ponto de extremidade.

Nome Tipo Description
AADToken

string

AMLToken

string

Key

string

EndpointProvisioningState

Estado do provisionamento de ponto de extremidade.

Nome Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou atribuídas pelo usuário)

Nome Tipo Description
principalId

string

A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId

string

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades User-Assigned
O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada (em que os tipos SystemAssigned e UserAssigned são permitidos).

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

Sku

A definição do modelo de recurso que representa o SKU

Nome Tipo Description
capacity

integer

Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se expansão/redução não for possível para o recurso, isso poderá ser omitido.

family

string

Se o serviço tiver gerações diferentes de hardware, para a mesma SKU, isso poderá ser capturado aqui.

name

string

O nome da SKU. Ex - P3. Normalmente, é um código de letra+número

size

string

O tamanho do SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo.

tier

SkuTier

Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

SkuTier

Esse campo deverá ser implementado pelo Provedor de Recursos se o serviço tiver mais de uma camada, mas não for necessário em um PUT.

Nome Tipo Description
Basic

string

Free

string

Premium

string

Standard

string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome Tipo Description
clientId

string

A ID do cliente da identidade atribuída.

principalId

string

A ID da entidade de segurança da identidade atribuída.