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 |
---|---|---|---|---|
endpoint
|
path | True |
string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ |
Nome do ponto de extremidade de inferência do Lote. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
subscription
|
path | True |
string minLength: 1 |
A ID da assinatura de destino. |
workspace
|
path | True |
string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$ |
Nome do workspace do Azure Machine Learning. |
api-version
|
query | True |
string minLength: 1 |
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 onde o recurso reside |
properties | True |
[Obrigatório] Atributos adicionais da entidade. |
|
identity |
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário) |
||
kind |
string |
Metadados usados pelo portal/ferramentas/etc para renderizar diferentes experiências de experiência de experiência de usuário para recursos do mesmo tipo. |
|
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 |
A solicitação de criação ou atualização foi bem-sucedida. |
|
201 Created |
Criado Cabeçalhos
|
|
Other Status Codes |
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 |
---|---|
Batch |
Configuração do ponto de extremidade do lote. |
Batch |
Valores padrão do ponto de extremidade do lote |
Batch |
|
created |
O tipo de identidade que criou o recurso. |
Endpoint |
Chaves para autenticação de ponto de extremidade. |
Endpoint |
Enumeração para determinar o modo de autenticação de ponto de extremidade. |
Endpoint |
Estado do provisionamento de ponto de extremidade. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Managed |
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário) |
Managed |
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). |
Sku |
A definição do modelo de recurso que representa o SKU |
Sku |
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. |
system |
Metadados relativos à criação e última modificação do recurso. |
User |
Propriedades de identidade atribuídas pelo usuário |
BatchEndpoint
Configuração do ponto de extremidade do lote.
Nome | Tipo | Description |
---|---|---|
authMode |
[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 |
Valores padrão para o Ponto de Extremidade do Lote |
|
description |
string |
Descrição do ponto de extremidade de inferência. |
keys |
EndpointAuthKeys a ser definido inicialmente em um ponto de extremidade. Essa propriedade sempre será retornada como nula. Os valores 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 |
Estado de provisionamento para o ponto de extremidade. |
|
scoringUri |
string (uri) |
URI do ponto de extremidade. |
swaggerUri |
string (uri) |
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% 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 |
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário) |
|
kind |
string |
Metadados usados pelo portal/ferramentas/etc para renderizar diferentes experiências de experiência de experiência de usuário para recursos do mesmo tipo. |
location |
string |
A localização geográfica onde o recurso reside |
name |
string |
O nome do recurso |
properties |
[Obrigatório] Atributos adicionais da entidade. |
|
sku |
Detalhes de SKU necessários para o contrato do ARM para dimensionamento automático. |
|
systemData |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. |
|
tags |
object |
Marcas de recurso. |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
createdByType
O tipo de identidade que criou o recurso.
Valor | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
EndpointAuthKeys
Chaves para autenticação de ponto de extremidade.
Nome | Tipo | Description |
---|---|---|
primaryKey |
string |
A chave primária. |
secondaryKey |
string |
A chave secundária. |
EndpointAuthMode
Enumeração para determinar o modo de autenticação de ponto de extremidade.
Valor | Description |
---|---|
AADToken | |
AMLToken | |
Key |
EndpointProvisioningState
Estado do provisionamento de ponto de extremidade.
Valor | Description |
---|---|
Canceled | |
Creating | |
Deleting | |
Failed | |
Succeeded | |
Updating |
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
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
ManagedServiceIdentity
Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)
Nome | Tipo | Description |
---|---|---|
principalId |
string (uuid) |
A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema. |
tenantId |
string (uuid) |
A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema. |
type |
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos). |
|
userAssignedIdentities |
<string,
User |
Identidades de User-Assigned |
ManagedServiceIdentityType
Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).
Valor | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned,UserAssigned | |
UserAssigned |
Sku
A definição do modelo de recurso que representa o SKU
Nome | Tipo | Description |
---|---|---|
capacity |
integer (int32) |
Se o SKU der suporte a expansão/entrada, o inteiro de capacidade deverá ser incluído. Se a escala horizontal/in não for possível para o recurso, isso poderá ser omitido. |
family |
string |
Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui. |
name |
string |
O nome da SKU. Ex - P3. Normalmente, é um código letter+number |
size |
string |
O tamanho da SKU. Quando o campo de nome é a combinação de camada e algum outro valor, esse seria o código autônomo. |
tier |
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.
Valor | Description |
---|---|
Basic | |
Free | |
Premium | |
Standard |
systemData
Metadados relativos à criação e última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string (date-time) |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
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 (uuid) |
A ID do cliente da identidade atribuída. |
principalId |
string (uuid) |
A ID da entidade de segurança da identidade atribuída. |