Compartilhar via


Online Deployments - List

Listar implantações de ponto de extremidade de inferência.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2024-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2024-04-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpointName
path True

string

Nome do ponto de extremidade de inferência.

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.

$orderBy
query

string

Ordenação de lista.

$skip
query

string

Token de continuação para paginação.

$top
query

integer

int32

No topo da lista.

Respostas

Nome Tipo Description
200 OK

OnlineDeploymentTrackedResourceArmPaginatedResult

Êxito

Other Status Codes

ErrorResponse

Erro

Exemplos

List Online Deployments.

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName/deployments?api-version=2024-04-01&$orderBy=string&$top=1

Resposta de exemplo

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "properties": {
          "string": "string"
        },
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "scaleSettings": {
          "scaleType": "Default"
        },
        "requestSettings": {
          "maxQueueWait": "PT5M",
          "requestTimeout": "PT5M",
          "maxConcurrentRequestsPerInstance": 1
        },
        "modelMountPath": "string",
        "appInsightsEnabled": false,
        "livenessProbe": {
          "failureThreshold": 1,
          "successThreshold": 1,
          "timeout": "PT5M",
          "period": "PT5M",
          "initialDelay": "PT5M"
        },
        "provisioningState": "Creating",
        "instanceType": "string",
        "model": "string",
        "endpointComputeType": "Kubernetes",
        "containerResourceRequirements": {
          "containerResourceRequests": {
            "cpu": "\"1\"",
            "memory": "\"2Gi\"",
            "gpu": "\"1\""
          },
          "containerResourceLimits": {
            "cpu": "\"1\"",
            "memory": "\"2Gi\"",
            "gpu": "\"1\""
          }
        }
      },
      "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
      }
    }
  ],
  "nextLink": "string"
}

Definições

Nome Description
CodeConfiguration

Configuração de um ativo de código de pontuação.

Collection
ContainerResourceRequirements

Requisitos de recursos para cada instância de contêiner em uma implantação online.

ContainerResourceSettings
createdByType

O tipo de identidade que criou o recurso.

DataCollectionMode
DataCollector
DefaultScaleSettings
DeploymentProvisioningState

Valores possíveis para DeploymentProvisioningState.

EgressPublicNetworkAccessType

Enumerar para determinar se PublicNetworkAccess está Habilitado ou Desabilitado para saída de uma implantação.

EndpointComputeType

Enumerar para determinar o tipo de computação de ponto de extremidade.

ErrorAdditionalInfo

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

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

KubernetesOnlineDeployment

Propriedades específicas de um KubernetesOnlineDeployment.

ManagedOnlineDeployment

Propriedades específicas de um ManagedOnlineDeployment.

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).

OnlineDeploymentTrackedResource
OnlineDeploymentTrackedResourceArmPaginatedResult

Uma lista paginada de entidades OnlineDeployment.

OnlineRequestSettings

Configuração de solicitações de pontuação de implantação online.

ProbeSettings

Configuração de investigação de disponibilidade/preparação do contêiner de implantação.

RequestLogging
RollingRateType
ScaleType
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.

TargetUtilizationScaleSettings
UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

CodeConfiguration

Configuração de um ativo de código de pontuação.

Nome Tipo Description
codeId

string

ID de recurso do ARM do ativo de código.

scoringScript

string

[Obrigatório] O script a ser executado na inicialização. ex. "score.py"

Collection

Nome Tipo Valor padrão Description
clientId

string

A ID do cliente msi usada para coletar o registro em log no armazenamento de blobs. Se for nulo, o back-end escolherá uma identidade de ponto de extremidade registrada para autenticação.

dataCollectionMode

DataCollectionMode

Disabled

Habilitar ou desabilitar a coleta de dados.

dataId

string

A ID do recurso arm do ativo de dados. O lado do cliente garantirá que o ativo de dados esteja apontando para o armazenamento de blobs e o back-end coletará dados para o armazenamento de blobs.

samplingRate

number

1

A taxa de amostragem da coleção. A taxa de amostragem 1,0 significa que coletamos 100% dos dados por padrão.

ContainerResourceRequirements

Requisitos de recursos para cada instância de contêiner em uma implantação online.

Nome Tipo Description
containerResourceLimits

ContainerResourceSettings

Informações de limite de recursos do contêiner:

containerResourceRequests

ContainerResourceSettings

Informações de solicitação de recurso de contêiner:

ContainerResourceSettings

Nome Tipo Description
cpu

string

Número de solicitações/limite de vCPUs para contêiner. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

gpu

string

Número de solicitações/limite de cartões de GPU Nvidia para contêiner. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

memory

string

Solicitação/limite de tamanho de memória para contêiner. Mais informações: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataCollectionMode

Nome Tipo Description
Disabled

string

Enabled

string

DataCollector

Nome Tipo Valor padrão Description
collections

<string,  Collection>

[Obrigatório] A configuração da coleção. Cada coleção tem sua própria configuração para coletar dados de modelo e o nome da coleção pode ser uma cadeia de caracteres arbitrária. O coletor de dados de modelo pode ser usado para registro em log de carga ou registro em log personalizado ou ambos. A solicitação e a resposta da coleção são reservadas para registro em log de carga, outras são para registro em log personalizado.

requestLogging

RequestLogging

A configuração de registro em log de solicitação para mdc inclui configurações avançadas de log para todas as coleções. É opcional.

rollingRate

RollingRateType

Hour

Quando os dados do modelo são coletados no armazenamento de blobs, precisamos rolar os dados para um caminho diferente para evitar o registro em log de todos eles em um único arquivo de blob. Se a taxa de rolagem for de hora, todos os dados serão coletados no caminho do blob /yyyy/MM/dd/HH/. Se for dia, todos os dados serão coletados no caminho do blob /yyyy/MM/dd/. O outro benefício do caminho sem interrupção é que a interface do usuário de monitoramento de modelo é capaz de selecionar um intervalo de tempo de dados muito rapidamente.

DefaultScaleSettings

Nome Tipo Description
scaleType string:

Default

[Obrigatório] Tipo de algoritmo de dimensionamento de implantação

DeploymentProvisioningState

Valores possíveis para DeploymentProvisioningState.

Nome Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

EgressPublicNetworkAccessType

Enumerar para determinar se PublicNetworkAccess está Habilitado ou Desabilitado para saída de uma implantação.

Nome Tipo Description
Disabled

string

Enabled

string

EndpointComputeType

Enumerar para determinar o tipo de computação de ponto de extremidade.

Nome Tipo Description
AzureMLCompute

string

Kubernetes

string

Managed

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.

KubernetesOnlineDeployment

Propriedades específicas de um KubernetesOnlineDeployment.

Nome Tipo Valor padrão Description
appInsightsEnabled

boolean

False

Se for true, habilitará o registro em log do Application Insights.

codeConfiguration

CodeConfiguration

Configuração de código para a implantação do ponto de extremidade.

containerResourceRequirements

ContainerResourceRequirements

Os requisitos de recursos para o contêiner (cpu e memória).

dataCollector

DataCollector

A configuração do mdc, desabilitamos o mdc quando ele é nulo.

description

string

Descrição da implantação do ponto de extremidade.

egressPublicNetworkAccess

EgressPublicNetworkAccessType

Enabled

Se habilitado, permita o acesso à rede pública de saída. Se desabilitado, isso criará uma saída segura. Padrão: habilitado.

endpointComputeType string:

Kubernetes

[Obrigatório] O tipo de computação do ponto de extremidade.

environmentId

string

ID de recurso do ARM ou AssetId da especificação de ambiente para a implantação do ponto de extremidade.

environmentVariables

object

Configuração de variáveis de ambiente para a implantação.

instanceType

string

Tipo de instância de computação.

livenessProbe

ProbeSettings

A investigação de atividade monitora a integridade do contêiner regularmente.

model

string

O caminho do URI para o modelo.

modelMountPath

string

O caminho para montar o modelo no contêiner personalizado.

properties

object

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

provisioningState

DeploymentProvisioningState

Estado de provisionamento para a implantação do ponto de extremidade.

readinessProbe

ProbeSettings

A investigação de preparação valida se o contêiner está pronto para atender ao tráfego. As propriedades e os padrões são os mesmos da investigação de atividade.

requestSettings

OnlineRequestSettings

Solicitar configurações para a implantação.

scaleSettings OnlineScaleSettings:

Configurações de escala para a implantação. Se for nulo ou não for fornecido, o padrão será TargetUtilizationScaleSettings para KubernetesOnlineDeployment e DefaultScaleSettings para ManagedOnlineDeployment.

ManagedOnlineDeployment

Propriedades específicas de um ManagedOnlineDeployment.

Nome Tipo Valor padrão Description
appInsightsEnabled

boolean

False

Se for true, habilitará o registro em log do Application Insights.

codeConfiguration

CodeConfiguration

Configuração de código para a implantação do ponto de extremidade.

dataCollector

DataCollector

A configuração do mdc, desabilitamos o mdc quando ele é nulo.

description

string

Descrição da implantação do ponto de extremidade.

egressPublicNetworkAccess

EgressPublicNetworkAccessType

Enabled

Se habilitado, permita o acesso à rede pública de saída. Se desabilitado, isso criará uma saída segura. Padrão: habilitado.

endpointComputeType string:

Managed

[Obrigatório] O tipo de computação do ponto de extremidade.

environmentId

string

ID de recurso do ARM ou AssetId da especificação de ambiente para a implantação do ponto de extremidade.

environmentVariables

object

Configuração de variáveis de ambiente para a implantação.

instanceType

string

Tipo de instância de computação.

livenessProbe

ProbeSettings

A investigação de atividade monitora a integridade do contêiner regularmente.

model

string

O caminho do URI para o modelo.

modelMountPath

string

O caminho para montar o modelo no contêiner personalizado.

properties

object

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

provisioningState

DeploymentProvisioningState

Estado de provisionamento para a implantação do ponto de extremidade.

readinessProbe

ProbeSettings

A investigação de preparação valida se o contêiner está pronto para atender ao tráfego. As propriedades e os padrões são os mesmos da investigação de atividade.

requestSettings

OnlineRequestSettings

Solicitar configurações para a implantação.

scaleSettings OnlineScaleSettings:

Configurações de escala para a implantação. Se for nulo ou não for fornecido, o padrão será TargetUtilizationScaleSettings para KubernetesOnlineDeployment e DefaultScaleSettings para ManagedOnlineDeployment.

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

OnlineDeploymentTrackedResource

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 OnlineDeployment:

[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"

OnlineDeploymentTrackedResourceArmPaginatedResult

Uma lista paginada de entidades OnlineDeployment.

Nome Tipo Description
nextLink

string

O link para a próxima página de objetos OnlineDeployment. Se for nulo, não haverá páginas adicionais.

value

OnlineDeploymentTrackedResource[]

Uma matriz de objetos do tipo OnlineDeployment.

OnlineRequestSettings

Configuração de solicitações de pontuação de implantação online.

Nome Tipo Valor padrão Description
maxConcurrentRequestsPerInstance

integer

1

O número máximo de solicitações simultâneas por nó permitidas por implantação. O valor padrão é 1.

maxQueueWait

string

PT0.5S

(Preterido para pontos de extremidade online gerenciados) A quantidade máxima de tempo que uma solicitação permanecerá na fila no formato ISO 8601. O padrão é 500ms. (Agora, aumente request_timeout_ms para considerar os atrasos de rede/fila)

requestTimeout

string

PT5S

O tempo limite de pontuação no formato ISO 8601. O padrão é 5000ms.

ProbeSettings

Configuração de investigação de disponibilidade/preparação do contêiner de implantação.

Nome Tipo Valor padrão Description
failureThreshold

integer

30

O número de falhas a serem permitidas antes de retornar um status não íntegro.

initialDelay

string

O atraso antes da primeira investigação no formato ISO 8601.

period

string

PT10S

O período de tempo entre investigações no formato ISO 8601.

successThreshold

integer

1

O número de investigações bem-sucedidas antes de retornar um status íntegro.

timeout

string

PT2S

O tempo limite da investigação no formato ISO 8601.

RequestLogging

Nome Tipo Description
captureHeaders

string[]

Para o registro em log de carga, coletamos conteúdo por padrão. Se os clientes também quiserem coletar os cabeçalhos especificados, eles poderão defini-los em captureHeaders para que o back-end colete esses cabeçalhos junto com a carga.

RollingRateType

Nome Tipo Description
Day

string

Hour

string

Minute

string

Month

string

Year

string

ScaleType

Nome Tipo Description
Default

string

TargetUtilization

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.

TargetUtilizationScaleSettings

Nome Tipo Valor padrão Description
maxInstances

integer

1

O número máximo de instâncias ao qual a implantação pode escalar. A cota será reservada para max_instances.

minInstances

integer

1

O número mínimo de instâncias sempre presentes.

pollingInterval

string

PT1S

O intervalo de sondagem no formato ISO 8691. Só dá suporte à duração com precisão tão baixa quanto Seconds.

scaleType string:

TargetUtilization

[Obrigatório] Tipo de algoritmo de dimensionamento de implantação

targetUtilizationPercentage

integer

70

Uso de CPU de destino para o dimensionador automático.

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.