Funzioni e clausole OData supportate

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Questo articolo illustra come Analytics supporta diverse funzioni OData. Sono elencate anche le funzioni non supportate. OData (Open Data Protocol) è uno standard OASIS approvato da ISO/IEC che definisce le procedure consigliate per la creazione e l'utilizzo di API REST. Per altre informazioni, vedere la documentazione di OData.

Nota

Il servizio Analytics viene abilitato e supportato automaticamente nell'ambiente di produzione per tutti i Servizi DevOps di Azure. L'integrazione di Power BI e l'accesso al feed OData del servizio di analisi sono disponibili a livello generale. Ti invitiamo a usarlo e a inviare commenti e suggerimenti. I dati disponibili dipendono dalla versione. La versione supportata più recente è v2.0e la versione di anteprima più recente è v4.0-preview. Per altre informazioni, vedere Controllo delle versioni dell'API OData.

Nota

Il servizio Analytics viene installato e supportato automaticamente nell'ambiente di produzione per tutte le nuove raccolte di progetti per Azure DevOps Server 2020 e versioni successive. L'integrazione di Power BI e l'accesso al feed OData del servizio di analisi sono disponibili a livello generale. Ti invitiamo a usarlo e a inviare commenti e suggerimenti. Se è stato eseguito l'aggiornamento da Azure DevOps Server 2019, è possibile installare il servizio Analytics durante l'aggiornamento.

I dati disponibili dipendono dalla versione. La versione supportata più recente è v2.0e la versione di anteprima più recente è v4.0-preview. Per altre informazioni, vedere Controllo delle versioni dell'API OData.

Nota

Il servizio Analytics è disponibile in anteprima per Azure DevOps Server 2019. È possibile abilitarlo o installarlo per una raccolta di progetti. L'integrazione di Power BI e l'accesso al feed OData del servizio di analisi sono disponibili in anteprima. Ti invitiamo a usarlo e a inviare commenti e suggerimenti.

I dati disponibili dipendono dalla versione. La versione supportata più recente è v2.0e la versione di anteprima più recente è v4.0-preview. Per altre informazioni, vedere Controllo delle versioni dell'API OData.

Clausole supportate

  • $apply
  • $compute
  • $count
  • $expand
  • $filter
  • $orderby
  • $select
  • $skip
  • $top

Quando in una query vengono usate più clausole, vengono applicate nell'ordine specificato in precedenza. L'ordine delle clausole nella stringa di query viene ignorato. Nella query seguente, ad esempio, gli elementi di lavoro vengono prima raggruppati e aggregati. Successivamente, i gruppi vengono filtrati. Successivamente, i gruppi filtrati vengono ordinati. Infine, vengono restituiti i primi cinque record. La query restituisce i primi cinque tipi di elemento di lavoro usati almeno 100 volte.

WorkItems?$filter=Count ge 100&$apply=groupby((WorkItemType), aggregate($count as Count))&$orderby=Count&top=5

Supporto delle estensioni di aggregazione

Accetta una sequenza di trasformazioni set, separate da barre per esprimere che vengono applicate consecutivamente. Il risultato di ogni trasformazione è l'input della trasformazione successiva. Nella query seguente, ad esempio, gli elementi di lavoro vengono filtrati e quindi raggruppati per tipo e stato dell'elemento di lavoro. Successivamente, i gruppi vengono filtrati e raggruppati di nuovo.

Nota

Le estensioni di aggregazione OData sono relativamente nuove e non ancora completamente supportate da alcuni strumenti client.

Workitems?$apply=filter(State ne 'Closed')/groupby((WorkItemType, State), aggregate($count as Count))/filter(Count gt 100)/groupby((State),aggregate(Count with max as MaxCount))  

Sono supportate le trasformazioni seguenti:

Trasformazione Note
aggregate Consente l'aggregazione usando uno dei metodi $countseguenti, , averagemax, min,sum
compute Consente di aggiungere proprietà calcolate
expand Consente l'espansione in base alle proprietà specificate
filter Consente di filtrare il set di input. Supporta le stesse espressioni di $filter
groupby Consente il raggruppamento per proprietà

Per altre informazioni, vedere Aggregare i dati di rilevamento del lavoro.

Funzioni supportate

Funzione canonica Descrizione
cast Restituisce l'espressione del cast dell'istanza corrente al tipo specificato.
contains Restituisce true se il secondo valore della stringa di parametro è una sottostringa del primo valore stringa del parametro, in caso contrario restituisce false.
endswith Restituisce true se il primo valore della stringa di parametro termina con il secondo valore della stringa di parametro, in caso contrario restituisce false.
startswith Restituisce true se il primo valore della stringa del parametro inizia con il secondo valore della stringa di parametro, in caso contrario restituisce false.
length Restituisce il numero di caratteri nel valore del parametro.
indexof Restituisce la posizione del carattere in base zero della prima occorrenza del secondo valore del parametro nel primo valore del parametro o -1 se il secondo valore del parametro non si verifica nel primo valore del parametro.
substring Restituisce una sottostringa del primo valore stringa del parametro, a partire dal carattere N e terminando l'ultimo carattere (dove N è il secondo valore intero del parametro).
tolower Restituisce il valore stringa del parametro di input con tutti i caratteri maiuscoli convertiti in lettere minuscole.
toupper Restituisce il valore stringa del parametro di input con tutti i caratteri minuscoli convertiti in maiuscolo.
trim Restituisce il valore stringa del parametro di input con tutti i caratteri di spazi vuoti iniziali e finali.
year Restituisce il componente year del valore del parametro Date o DateTimeOffset.
month Restituisce il componente month del valore del parametro Date o DateTimeOffset.
day Restituisce il componente day del valore del parametro Date o DateTimeOffset.
date Restituisce la parte date del valore del parametro DateTimeOffset.
time Restituisce la parte relativa all'ora del valore del parametro DateTimeOffset.
totaloffsetminutes Restituisce il numero di minuti con segno nella parte relativa alla differenza di fuso orario del valore del parametro DateTimeOffset.
now Restituisce il punto corrente nell'ora (data e ora con fuso orario) come valore DateTimeOffset.
maxdatetime Restituisce l'ultimo punto nel tempo possibile come valore DateTimeOffset.
mindatetime Restituisce il primo punto nel tempo possibile come valore DateTimeOffset.

Le funzioni OData vengono usate in una $filter clausola, ma non in una $select clausola come vengono usate in un'istruzione SQL.

Ad esempio, è possibile specificare:

/WorkItems?$filter=toupper(Title) eq 'HELP' 

Tuttavia, non è possibile immettere la stringa seguente:

/WorkItems?$select=WorkItemId,State,toupper(Title)

Funzionalità non supportate

  • bottomcount
  • bottomsum
  • bottompercent
  • $crossjoin
  • concat
  • countdistinct
  • from
  • isdefined
  • $rollup
  • $search
  • topcount
  • topsum
  • toppercent