Gerencie o ambiente por meio de APIs públicas

A API REST do Microsoft Fabric fornece um ponto de extremidade de serviço para as operações de criação, leitura, atualização e exclusão (CRUD) de um item do Fabric. Este artigo descreve as APIs REST do ambiente disponíveis e seu uso.

Migrar as APIs do ambiente para sua versão estável do GA

Importante

A versão do GA inclui atualizações no contrato de solicitação/resposta de APIs existentes, descontinuações de API e novas APIs. Você pode encontrar os detalhes nas seções a seguir.
Um novo parâmetro beta de consulta é introduzido para facilitar a transição de alterações de contrato de solicitação/resposta. O parâmetro de consulta beta tem como valor padrão True até 31 de março de 2026, permitindo que os contratos de visualização continuem disponíveis. Defina o valor para False e comece a usar a versão estável Release dos contratos.
Preview O parâmetro de consulta foi substituído por beta. Para compatibilidade retroativa, a pré-visualização continua a ser suportada e comporta-se da mesma forma que a beta.
As APIs a serem descontinuadas continuarão a ser suportadas até 31 de março de 2026. Por favor, utilize as APIs recém-introduzidas para as substituir assim que possível.

APIs com atualização de contrato de solicitação/resposta

Categoria	API	Descrição	Observações	Versão de pré-visualização do Swagger	Versão de lançamento Swagger
Operação do item	Ambiente de publicação	Inicie a operação de publicação do ambiente com as alterações pendentes atuais.	Atualização no contrato de prestação de resposta.	Ambiente de publicação (Pré-visualização)	Ambiente de publicação
Preparação	Listar bibliotecas de teste	Obtenha a lista completa da biblioteca de encenação. Esta lista inclui as bibliotecas publicadas e pendentes.	Atualização no contrato de prestação de resposta.	Listar bibliotecas intermediárias (Pré-visualização)	Listar bibliotecas de preparo
Preparação	Computação de encenação de lista do Spark	Obtenha as configurações completas de computação de teste. As configurações de preparo incluem as configurações de computação publicadas e pendentes.	Atualização no contrato de prestação de resposta.	Computação do Spark de preparo de lista (Visualização)	Cálculo do Spark de preparo de lista
Preparação	Atualizar a computação do Spark	Atualize as configurações de computação e as propriedades do Spark para um ambiente.	Atualização nos contratos de solicitação e resposta.	Atualizar computação do Spark (Visualização)	Atualizar a computação do Spark
Publicado	Listar bibliotecas publicadas	Obtenha as bibliotecas que são publicadas e ativas nas sessões do Spark.	Atualização no contrato de prestação de resposta.	Listar bibliotecas publicadas (Prévia)	Listar bibliotecas publicadas
Publicado	Lista de cálculos Spark publicados	Obtenha as configurações de computação do Spark e as propriedades do Spark publicadas e efetivas nas sessões do Spark.	Atualização no contrato de prestação de resposta.	Listar bibliotecas publicadas (Prévia)	Listar bibliotecas publicadas

O beta padrão do parâmetro é True até 31 de março de 2026, ou seja, o sistema considera o parâmetro como True se a solicitação estivesse sendo enviada, sem especificar esse parâmetro até a data de preterição. É altamente recomendável migrar suas implementações para a versão estável, definindo explicitamente o beta parâmetro para False o mais rápido possível.

Usando List staging libraries API como exemplo, que tem uma atualização na resposta da API.

Ao enviar a solicitação com beta parâmetro como True

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

Exemplo de resposta:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

Ao enviar a solicitação com preview parâmetro como False

Pedido de amostra

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

Exemplo de resposta:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

APIs a serem preteridas

Importante

As APIs a serem descontinuadas continuarão a ter suporte até 31 de março de 2026. É altamente recomendável usar APIs recém-introduzidas para substituir suas implementações o mais rápido possível.

Categoria	API	Descrição	Nota
Preparação	Carregar bibliotecas de ensaio	Adicione uma biblioteca personalizada ou uma/várias bibliotecas públicas no ambiente.	Suporte até 31 de março de 2026, por favor, use as APIs recém-introduzidas `Import external libraries`/`Upload custom library` para substituição.
Preparação	Excluir bibliotecas de staging	Exclua uma biblioteca personalizada de teste ou todas as bibliotecas públicas.	Suporte até 31 de março de 2026, por favor, use as APIs recém-introduzidas `Remove external library`/`Delete custom library` para substituição.

Abaixo estão alguns exemplos que abrangem os cenários na gestão de bibliotecas de pré-produção.

Adicionar as bibliotecas públicas em seu ambiente

Anteriormente, você pode usar Upload staging libraries a API para carregar o arquivo YAML atualizado, e agora você pode usar Import external libraries a API para importar o YAML atualizado.
Excluir uma biblioteca pública no seu ambiente

Anteriormente, você pode usar Upload staging libraries a API para carregar o arquivo YAML atualizado, e agora você pode usar Remove external library a API para removê-lo.
Excluir toda a biblioteca pública em seu ambiente

Anteriormente, você pode usar Delete staging libraries a API para excluir todas as bibliotecas públicas, e agora você pode usar Remove external library a API para remover as bibliotecas públicas uma a uma ou usar Import external libraries para carregar um arquivo YAML vazio para obter as mesmas funcionalidades.

Novas APIs

Categoria	API	Descrição	Nota
Operação do item	Criar ambiente com definição	Crie um novo ambiente com definição.	Nova API.
Operação do item	Obter definição de ambiente	Obtenha a definição de um ambiente.	Nova API.
Operação do item	Atualizar definição de ambiente	Atualizar a definição de um ambiente.	Nova API.
Preparação	Importar bibliotecas externas	Carregue bibliotecas externas como um arquivo environment.yml no ambiente. Ele substitui a lista de bibliotecas externas existentes em um ambiente.	Nova API.
Preparação	Exportar bibliotecas externas	Obtenha as bibliotecas externas completas como um arquivo environment.yml .	Nova API.
Preparação	Remover biblioteca externa	Exclua uma biblioteca externa de um ambiente. Esta API aceita uma biblioteca de cada vez.	Nova API.
Preparação	Carregar biblioteca personalizada	Faça o upload de um pacote personalizado no ambiente. Esta API permite o carregamento de um ficheiro de cada vez. Os formatos de ficheiro suportados são .jar, .py, .whl e .tar.gz.	Nova API.
Preparação	Excluir biblioteca personalizada	Exclua um pacote personalizado do ambiente. Coloque o nome completo do pacote personalizado com a extensão na solicitação de API para removê-lo.	Nova API.
Publicado	Exportar bibliotecas externas	Obtenha as bibliotecas externas publicadas como um arquivo environment.yml .	Nova API.

APIs sem atualização

Categoria	API	Descrição
Operação do item	Criar ambiente	Crie um novo ambiente vazio no espaço de trabalho.
Operação do item	Obter ambiente	Obtenha os metadados de um ambiente. A resposta inclui o estado do ambiente.
Operação do item	Excluir ambiente	Exclua um ambiente existente.
Operação do item	Ambiente de lista	Obtenha a lista de ambientes em um espaço de trabalho.
Operação do item	Ambiente de atualização	Atualize os metadados de um ambiente, como nome e descrição.
Operação do item	Cancelar ambiente de publicação	Cancelar uma operação de publicação do ambiente em andamento.

Para saber mais sobre as APIs públicas do ambiente, consulte APIs de item - Ambiente.

Casos de uso da API pública do ambiente

Importante

Esta secção é apresentada com a versão de lançamento estável das APIs.

Esta seção demonstra como usar as APIs para alcançar cenários específicos ao gerenciar o Ambiente. Você pode substituir as {WORKSPACE_ID} propriedades e {ARTIFACT_ID} nos exemplos a seguir por valores apropriados.

Criar um novo ambiente

Para criar um novo ambiente vazio, use a seguinte API.

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

Gerenciar bibliotecas de preparo

Você pode usar as APIs para carregamento e eliminação de bibliotecas de preparação para gerenciar a seção de biblioteca dentro do ambiente.

Verifique o ambiente nas bibliotecas publicadas

Antes de adicionar ou excluir uma biblioteca, use a API Obter bibliotecas publicadas para verificar quais bibliotecas estão em vigor no momento.

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

Resposta da amostra

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Importar bibliotecas públicas ou carregar bibliotecas personalizadas

Você pode usar Importar bibliotecas externas e Carregar APIs de bibliotecas personalizadas para adicionar novas bibliotecas públicas/personalizadas ao seu ambiente. A API de importação de bibliotecas externas aceita environment.yml arquivo enquanto os tipos de arquivo suportados são .whl, .jar, .tar.gz.py para carregar a API de biblioteca personalizada.

Nota

Para manipular a biblioteca pública de forma mais eficiente, recomendamos que você componha todas as bibliotecas esperadas do PyPI e Conda em um arquivo environment.yml .

A API de upload permite até um arquivo de 200 MB em uma solicitação. Uma biblioteca que excede esse limite de tamanho atualmente não é suportada em APIs públicas.

Pedidos de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Excluir a biblioteca personalizada

Ao especificar o nome completo do arquivo da biblioteca com o sufixo de tipo, você pode excluir uma biblioteca personalizada de cada vez.

Nota

Se você quiser remover um subconjunto das bibliotecas públicas existentes ou todas elas, importe um arquivo YAML atualizado por meio Import public libraries da API.

Pedidos de amostra

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Gerenciar computação do Spark de preparo

Você pode usar a computação do Spark de preparo de atualização para gerenciar a computação do Spark.

Verifique a computação do Spark publicada para o ambiente

Antes de alterar as configurações do ambiente, use a API Get Published Spark Compute para verificar quais configurações de computação do Spark são atualmente eficazes.

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

Resposta da amostra

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Atualizar as configurações de computação

Você pode atualizar o tempo de execução do Spark, alternar para outro pool, refinar a configuração de computação e adicionar ou remover propriedades do Spark editando o corpo da solicitação desta API.

Você pode alternar o pool anexado especificando o nome do pool e o pool. Especifique o nome do pool como Starter Pool para definir o pool nas configurações padrão. Para obter a lista completa dos pools personalizados disponíveis do espaço de trabalho pela API REST, consulte Pools personalizados - Listar pools personalizados do espaço de trabalho.

Se desejar remover uma propriedade Spark existente, especifique o valor como null com a chave que deseja remover.

Pedido de amostra

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

Fazer com que as alterações entrem em vigor

Use os seguintes conjuntos de APIs para publicar as alterações.

Preparar para uma operação de publicação

O ambiente pode aceitar uma operação de publicação de cada vez. Antes de publicar seu ambiente, valide o status do ambiente e faça uma revisão final das alterações de preparação. Depois que o ambiente é publicado com êxito, todas as configurações no estado de preparo se tornam efetivas.

1º Passo: Obtenha os metadados do ambiente.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
No corpo da resposta, é possível determinar com clareza a condição do ambiente. Certifique-se de que nenhuma operação de publicação está em andamento antes de passar para a próxima etapa.

2º Passo: Obtenha as bibliotecas de preparação/computação do Spark para ter uma revisão final.

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

Acionar a operação de publicação do ambiente

As alterações feitas nas bibliotecas de preparo e na computação do Spark são armazenadas em cache, mas exigem publicação para entrar em vigor. Use o próximo exemplo para disparar a operação de publicação. A resposta está seguindo o padrão de operações de longa duração (LRO) e o código de resposta HTTP 202 pode ser retornado.

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

Resposta da amostra

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Durante a operação de publicação, você também pode chamar a seguinte API para cancelá-la.

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

Feedback

Esta página foi útil?

Last updated on 2025-10-09

Partilhar via

Gerencie o ambiente por meio de APIs públicas

Migrar as APIs do ambiente para sua versão estável do GA

APIs com atualização de contrato de solicitação/resposta

APIs a serem preteridas

Novas APIs

APIs sem atualização

Casos de uso da API pública do ambiente

Criar um novo ambiente

Gerenciar bibliotecas de preparo

Verifique o ambiente nas bibliotecas publicadas

Importar bibliotecas públicas ou carregar bibliotecas personalizadas

Excluir a biblioteca personalizada

Gerenciar computação do Spark de preparo

Verifique a computação do Spark publicada para o ambiente

Atualizar as configurações de computação

Fazer com que as alterações entrem em vigor

Preparar para uma operação de publicação

Acionar a operação de publicação do ambiente

Conteúdos relacionados

Feedback

Recursos adicionais