Items - Update Environment
Atualiza as propriedades do ambiente especificado.
Permissões
O chamador deve ter permissões de leitura e gravação para o ambiente.
Escopos delegados necessários
Environment.ReadWrite.All ou Item.ReadWrite.All
Identidades suportadas pelo Microsoft Entra
Esta API suporta as identidades do Microsoft listadas nesta secção.
| Identidade | Suporte |
|---|---|
| Utilizador | Sim |
| da entidade de serviço e identidades gerenciadas | Sim |
Interfaz
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}Parâmetros URI
| Nome | Em | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
environment
|
path | True |
string (uuid) |
O ID do ambiente. |
|
workspace
|
path | True |
string (uuid) |
O ID do espaço de trabalho. |
Órgão do Pedido
| Nome | Tipo | Descrição |
|---|---|---|
| description |
string |
A descrição do ambiente. O comprimento máximo é de 256 caracteres. |
| displayName |
string |
O nome de exibição do ambiente. |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK |
Pedido concluído com sucesso. |
|
| Other Status Codes |
Códigos de erro comuns:
|
Exemplos
Update a environment example
Pedido de exemplo
PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715
{
"displayName": "Environment_New_Name",
"description": "A new description for environment."
}
Resposta de exemplo
{
"displayName": "Environment_New_Name",
"description": "A new description for environment.",
"type": "Environment",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
}Definições
| Nome | Descrição |
|---|---|
|
Component |
Publique informações para cada componente no ambiente. |
| Environment |
Um item Ambiente. |
|
Environment |
Propriedades do ambiente. |
|
Environment |
Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo. |
|
Error |
O objeto de detalhes do recurso relacionado ao erro. |
|
Error |
A resposta de erro. |
|
Error |
Os detalhes da resposta de erro. |
|
Item |
Representa uma tag aplicada em um item. |
|
Item |
O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo. |
|
Publish |
Detalhes da operação de publicação. |
|
Spark |
Bibliotecas Spark. |
|
Spark |
Configurações de faísca. |
|
Update |
Solicitação de atualização do ambiente. |
ComponentPublishInfo
Publique informações para cada componente no ambiente.
| Nome | Tipo | Descrição |
|---|---|---|
| sparkLibraries |
As bibliotecas do Spark publicam informações. |
|
| sparkSettings |
As configurações do Spark publicam informações. |
Environment
Um item Ambiente.
| Nome | Tipo | Descrição |
|---|---|---|
| description |
string |
A descrição do item. |
| displayName |
string |
O nome de exibição do item. |
| folderId |
string (uuid) |
O ID da pasta. |
| id |
string (uuid) |
O ID do item. |
| properties |
As propriedades do ambiente. |
|
| tags |
Item |
Lista de tags aplicadas. |
| type |
O tipo de item. |
|
| workspaceId |
string (uuid) |
O ID do espaço de trabalho. |
EnvironmentProperties
Propriedades do ambiente.
| Nome | Tipo | Descrição |
|---|---|---|
| publishDetails |
Ambiente publicar detalhes da operação. |
EnvironmentPublishState
Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo.
| Valor | Descrição |
|---|---|
| Success |
A publicação do ambiente está em estado de sucesso. |
| Cancelled |
A publicação do ambiente está em estado cancelado. |
| Failed |
A publicação do ambiente está em estado de falha. |
| Cancelling |
A publicação do ambiente está em estado de cancelamento. |
| Running |
A publicação do ambiente está em estado de execução. |
| Waiting |
A publicação do ambiente está em estado de espera. |
ErrorRelatedResource
O objeto de detalhes do recurso relacionado ao erro.
| Nome | Tipo | Descrição |
|---|---|---|
| resourceId |
string |
A ID do recurso envolvida no erro. |
| resourceType |
string |
O tipo de recurso envolvido no erro. |
ErrorResponse
A resposta de erro.
| Nome | Tipo | Descrição |
|---|---|---|
| errorCode |
string |
Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários. |
| message |
string |
Uma representação legível por humanos do erro. |
| moreDetails |
Lista de detalhes de erro adicionais. |
|
| relatedResource |
Os detalhes do recurso relacionados ao erro. |
|
| requestId |
string |
ID da solicitação associada ao erro. |
ErrorResponseDetails
Os detalhes da resposta de erro.
| Nome | Tipo | Descrição |
|---|---|---|
| errorCode |
string |
Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários. |
| message |
string |
Uma representação legível por humanos do erro. |
| relatedResource |
Os detalhes do recurso relacionados ao erro. |
ItemTag
Representa uma tag aplicada em um item.
| Nome | Tipo | Descrição |
|---|---|---|
| displayName |
string |
O nome da tag. |
| id |
string (uuid) |
O ID da tag. |
ItemType
O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
| Valor | Descrição |
|---|---|
| Dashboard |
Painel do PowerBI. |
| Report |
Relatório do PowerBI. |
| SemanticModel |
Modelo semântico do PowerBI. |
| PaginatedReport |
Relatório paginado do PowerBI. |
| Datamart |
Datamart do PowerBI. |
| Lakehouse |
Uma casa no lago. |
| Eventhouse |
Uma casa de eventos. |
| Environment |
Um ambiente. |
| KQLDatabase |
Um banco de dados KQL. |
| KQLQueryset |
Um conjunto de consultas KQL. |
| KQLDashboard |
Um painel KQL. |
| DataPipeline |
Um pipeline de dados. |
| Notebook |
Um caderno. |
| SparkJobDefinition |
Uma definição de trabalho de faísca. |
| MLExperiment |
Uma experiência de aprendizagem automática. |
| MLModel |
Um modelo de aprendizagem automática. |
| Warehouse |
Um armazém. |
| Eventstream |
Um fluxo de eventos. |
| SQLEndpoint |
Um ponto de extremidade SQL. |
| MirroredWarehouse |
Um armazém espelhado. |
| MirroredDatabase |
Um banco de dados espelhado. |
| Reflex |
Um reflexo. |
| GraphQLApi |
Uma API para o item GraphQL. |
| MountedDataFactory |
Um MountedDataFactory. |
| SQLDatabase |
Um SQLDatabase. |
| CopyJob |
Um trabalho de cópia. |
| VariableLibrary |
Uma VariableLibrary. |
| Dataflow |
Um fluxo de dados. |
| ApacheAirflowJob |
Um ApacheAirflowJob. |
| WarehouseSnapshot |
Um instantâneo do Warehouse. |
| DigitalTwinBuilder |
Um DigitalTwinBuilder. |
| DigitalTwinBuilderFlow |
Um fluxo de construtor de gêmeos digitais. |
| MirroredAzureDatabricksCatalog |
Um catálogo de databricks azure espelhado. |
| Map |
Um mapa. |
| AnomalyDetector |
Um detetor de anomalias. |
| UserDataFunction |
Uma função de dados do usuário. |
| GraphModel |
Um GraphModel. |
| GraphQuerySet |
Um Graph QuerySet. |
| SnowflakeDatabase |
Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake. |
| OperationsAgent |
Um Agente de Operações. |
| CosmosDBDatabase |
Uma base de dados Cosmos DB. |
| Ontology |
Uma ontologia. |
| EventSchemaSet |
Um EventoSchemaSet. |
PublishDetails
Detalhes da operação de publicação.
| Nome | Tipo | Descrição |
|---|---|---|
| componentPublishInfo |
Componente Ambiente publicar informações. |
|
| endTime |
string (date-time) |
Hora de término da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ . |
| startTime |
string (date-time) |
Hora de início da operação de publicação em UTC, usando o formato AAAA-MM-DDTHH:mm:ss.ssssssssZ . |
| state |
Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo. |
|
| targetVersion |
string (uuid) |
Target verion a ser publicado. |
SparkLibraries
Bibliotecas Spark.
| Nome | Tipo | Descrição |
|---|---|---|
| state |
Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo. |
SparkSettings
Configurações de faísca.
| Nome | Tipo | Descrição |
|---|---|---|
| state |
Estado de publicação. Tipos de estado adicionais podem ser adicionados ao longo do tempo. |
UpdateEnvironmentRequest
Solicitação de atualização do ambiente.
| Nome | Tipo | Descrição |
|---|---|---|
| description |
string |
A descrição do ambiente. O comprimento máximo é de 256 caracteres. |
| displayName |
string |
O nome de exibição do ambiente. |