Compartilhar via

Items - List Warehouses

  • Referência
Serviço:
Warehouse
Versão da API:
v1

Retorna uma lista de armazéns do workspace especificado.
Essa API dá suporte a de paginação.

Permissões

O chamador deve ter função de workspace do visualizador ou superior.

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses?continuationToken={continuationToken}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
workspaceId
 path True

string

uuid

A ID do workspace.
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.

Respostas

Nome Tipo Description
200 OK

Warehouses

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidItemType – Tipo de item inválido.

Exemplos

List warehouses in workspace example

Solicitação de exemplo

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Warehouse Name 1",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-09-28T22:52:13.78",
        "lastUpdatedTime": "2023-10-04T22:56:33.283",
        "collationType": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
      }
    },
    {
      "id": "6281bf94-81b9-46b2-b8d3-79bb868fc822",
      "displayName": "Warehouse Name 2",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-11-21T13:14:30.54",
        "lastUpdatedTime": "2023-12-04T20:03:43.110",
        "collationType": "Latin1_General_100_BIN2_UTF8"
      }
    }
  ]
}

Definições

Nome Description
CollationType

Ordenação de armazém. Outros collations podem ser adicionados ao longo do tempo.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemType

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
Warehouse

Um objeto de armazém.
WarehouseProperties

As propriedades do item do warehouse.
Warehouses

Uma lista de armazéns.

CollationType

Enumeração

Ordenação de armazém. Outros collations podem ser adicionados ao longo do tempo.

Valor Description
Latin1_General_100_BIN2_UTF8

O padrão – ordenação CS (diferencia maiúsculas de minúsculas)
Latin1_General_100_CI_AS_KS_WS_SC_UTF8

ordenação de CI (que não diferencia maiúsculas de minúsculas)

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um Reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho do Spark.
Warehouse

Um armazém.

Warehouse

Objeto

Um objeto de armazém.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
properties

WarehouseProperties

As propriedades do armazém.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

WarehouseProperties

Objeto

As propriedades do item do warehouse.

Nome Tipo Description
collationType

CollationType

O tipo de ordenação do armazém.
connectionString

string

A cadeia de conexão SQL conectada ao workspace que contém esse warehouse.
createdDate

string

date-time

A data e a hora em que o armazém foi criado.
lastUpdatedTime

string

date-time

A data e a hora em que o armazém foi atualizado pela última vez

Warehouses

Objeto

Uma lista de armazéns.

Nome Tipo Description
continuationToken

string

O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value

Warehouse[]

Uma lista de armazéns.