Data Catalog (Azure Data Catalog REST-API)
Erstellen oder Aktualisieren
Erstellt oder aktualisiert einen Katalog.
Anforderung
PUT https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resouceGroup>/providers/Microsoft.DataCatalog/catalogs/<catalogName>
URI-Parameter
| Name | Beschreibung | Datentyp |
|---|---|---|
| subscriptionId | Abonnement zum Bereitstellen des Katalogs. | String |
| resouceGroup | Alle Ressourcen müssen in eine Gruppe eingefügt werden. Siehe [Ressourcengruppen]. (https://azure.microsoft.com/documentation/articles/resource-group-overview) | String |
| Catalogname | Name des Katalogs. | String |
Header
| Name | Wert |
|---|---|
| Content-Type | Anwendung/json |
Textbeispiel
{
"location" : "North US",
"tags": {
"mykey": "myvalue",
"mykey2": "myvalue2",
}
"properties" : {
"sku" : "Standard",
"units" : 1,
"enableAutomaticUnitAdjustment" : false,
"admins" : [{"upn" : "myupn@microsoft.com", "objectId" : "99999999-…-999999999999"}],
"users" : [{"upn" : "myupn@microsoft.com", "objectId" : "99999999-…-999999999999"}]
}
}
Antwort
Statuscodes
| Code | Beschreibung |
|---|---|
| 200 | OK. Eine vorhandene Anmerkung wurde aktualisiert. Wenn ProvisioningState nicht "Erfolgreich", "Failed" oder "Canceled" ist, ist der Aufruf asynchron und nicht abgeschlossen. Der Aufrufer muss entweder abfragen, indem er eine GET für dieselbe URL ausführt, bis ProvisioningState in einen dieser Werte umgewandelt wird, oder den in Azure-AsyncOperation Header zurückgegebenen Wert überprüfen und diesen Speicherort abfragen. |
| 400 | Ungültige Anforderung. |
Beispielantwortheader
| Name | Wert |
|---|---|
| Access-Control-Allow-Origin | , |
| Cachesteuerung | no-cache,no-cache,no-store |
| Content-Length | 548 |
| Content-Type | application/json; charset=utf-8 |
| Date | Mi,02 Mär 2016 01:42:46 GMT |
| ETag | W/"AAAAAAABQIE=" |
| Läuft ab | -1 |
Eigenschaften für Antworthauptteil
| Name | BESCHREIBUNG |
|---|---|
| Sku | Entweder "Free" oder "Standard" (Fall zählt). Link zu unserer Preisseite, die beschreibt, was dies bedeutet. |
| Einheiten | Granularität der Abrechnung für die Standard-SKU. Eine Einheit stellt 100 zulässige Benutzer dar. Muss auf den Wert größer als 0 festgelegt werden, wenn enableAutomaticUnitAdjustment false ist. Muss auf 0 festgelegt werden, wenn enableAutomaticUnitAdjustment true ist. |
| enableAutomaticUnitAdjustment | Boolesche Einstellung, die bestimmt, ob Einheiten automatisch berechnet werden sollen. Diese Einstellung muss auf true festgelegt werden, um Sicherheitsgruppen in der Administrator- oder Zulassungsliste verwenden zu können. |
| Administratoren | Liste der Katalogadministratoren: - upn: Universeller Prinzipalname des Kontos - objectId: Azure Active Directory-Objekt-ID des Kontos |
| Benutzer | Liste der Katalogbenutzer: - upn/objectId wie oben |
Beispielantworttext
{
"id": "/subscriptions/99999999-9999-…-999999999999/resourceGroups/myRG/providers/Microsoft.DataCatalog/catalogs/ExtractorStore1",
"name": "...",
"type": "Microsoft.DataCatalog/catalogs",
"location": "North US",
"tags": {
"mykey": "myvalue",
"mykey2": "myvalue2",
}
"properties": {
"sku": "Standard",
"units": 1,
"admins": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
],
"successfullyProvisioned": true,
"enableAutomaticUnitAdjustment": false,
"users": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
]
}
}
Löschen
Löscht einen Katalog.
Anforderung
Header
Keine
Textbeispiel
Keine
Beispielantwortheader
| Name | Wert |
|---|---|
| Access-Control-Allow-Origin | , |
| Cachesteuerung | no-cache,no-cache,no-store |
| Content-Length | 0 |
| Content-Type | application/json; charset=utf-8 |
| Date | Mi,02 Mär 2016 01:42:46 GMT |
| Läuft ab | -1 |
Antwort
Statuscodes
| Code | Beschreibung |
|---|---|
| 200 | OK. Eine vorhandene Anmerkung wurde aktualisiert. |
| 204 | Kein Inhalt (nicht vorhanden). |
| 202 | Akzeptiert: Löschen ist asynchron. In diesem Fall muss der Aufrufer den Location-Header lesen, damit eine URL abgerufen werden kann. Diese URL gibt weiterhin 202 zurück, bis der Vorgang abgeschlossen ist. Wenn 202 nicht mehr zurückgegeben wird, ist die Antwort, die zurückgegeben wird, das Ergebnis des DELETE-Vorgangs. |
| 400 | Ungültige Anforderung. |
Herunterladen
Ruft einen Katalog ab.
GET https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resouceGroup>/providers/Microsoft.DataCatalog/catalogs/<catalogName>
URI-Parameter
| Name | Beschreibung | Datentyp |
|---|---|---|
| subscriptionId | Abonnement, in dem der Katalog bereitgestellt werden soll. | String |
| resouceGroup | Alle Ressourcen müssen in einer Gruppe platziert werden. Siehe [Ressourcengruppen]. (https://azure.microsoft.com/documentation/articles/resource-group-overview) | String |
| Catalogname | Name des Katalogs. | String |
Anforderung
Header
| Name | Wert |
|---|---|
| Content-Type | Anwendung/json |
Textbeispiel
Keine
Beispielantwortheader
| Name | Wert |
|---|---|
| Access-Control-Allow-Origin | , |
| Cachesteuerung | no-cache,no-cache,no-store |
| Content-Length | 548 |
| Content-Type | application/json; charset=utf-8 |
| Date | Mi,02. März 2016 01:42:46 GMT |
| ETag | W/"AAAAAAABQIE=" |
| Läuft ab | -1 |
Eigenschaften für Antworthauptteil
| Name | BESCHREIBUNG |
|---|---|
| Sku | Entweder "Free" oder "Standard" (Fall zählt). Link zu unserer Preisseite, die beschreibt, was dies bedeutet. |
| Einheiten | Granularität der Abrechnung für die Standard-SKU. Eine Einheit stellt 100 zulässige Benutzer dar. Muss auf einen Wert größer als 0 festgelegt werden, wenn enableAutomaticUnitAdjustment auf false festgelegt ist. Muss auf 0 festgelegt werden, wenn enableAutomaticUnitAdjustment true ist. |
| enableAutomaticUnitAdjustment | Boolesche Einstellung, die bestimmt, ob Einheiten automatisch berechnet werden sollen. Diese Einstellung muss auf true festgelegt werden, um Sicherheitsgruppen in der Administrator- oder Zulassungsliste verwenden zu können. |
| Administratoren | Liste der Katalogadministratoren: - upn: Universeller Prinzipalname des Kontos – objectId: Azure Active Directory-Objekt-ID des Kontos |
| Benutzer | Liste der Katalogbenutzer: - upn/objectId wie oben |
Beispielantworttext
{
"id": "/subscriptions/99999999-…-999999999999/resourceGroups/myRG/providers/Microsoft.DataCatalog/catalogs/ExtractorStore1",
"name": "ExtractorStore1",
"type": "Microsoft.DataCatalog/catalogs",
"location": "North US",
"tags": {},
"properties": {
"sku": "Standard",
"units": 1,
"admins": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
],
"enableAutomaticUnitAdjustment": false,
"users": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
]
}
}
List
listet alle Kataloge auf.
GET https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resouceGroup>/providers/Microsoft.DataCatalog/catalogs
URI-Parameter
| Name | Beschreibung | Datentyp |
|---|---|---|
| subscriptionId | Abonnement, in dem der Katalog bereitgestellt werden soll. | String |
| resouceGroup | Alle Ressourcen müssen in einer Gruppe platziert werden. Siehe [Ressourcengruppen]. (https://azure.microsoft.com/documentation/articles/resource-group-overview) | String |
Anforderung
Header
| Name | Wert |
|---|---|
| Content-Type | Anwendung/json |
Textbeispiel
Keine
Beispielantwortheader
| Name | Wert |
|---|---|
| Access-Control-Allow-Origin | , |
| Cachesteuerung | no-cache,no-cache,no-store |
| Content-Length | 570 |
| Content-Type | application/json; charset=utf-8 |
| Date | Mi,02. März 2016 01:42:46 GMT |
| Läuft ab | -1 |
Eigenschaften für Antworthauptteil
| Name | BESCHREIBUNG |
|---|---|
| Sku | Entweder "Free" oder "Standard" (Fall zählt). Link zu unserer Preisseite, die beschreibt, was dies bedeutet. |
| Einheiten | Granularität der Abrechnung für die Standard-SKU. Eine Einheit stellt 100 zulässige Benutzer dar. Muss auf einen Wert größer als 0 festgelegt werden, wenn enableAutomaticUnitAdjustment auf false festgelegt ist. Muss auf 0 festgelegt werden, wenn enableAutomaticUnitAdjustment true ist. |
| enableAutomaticUnitAdjustment | Boolesche Einstellung, die bestimmt, ob Einheiten automatisch berechnet werden sollen. Diese Einstellung muss auf true festgelegt werden, um Sicherheitsgruppen in der Administrator- oder Zulassungsliste verwenden zu können. |
| Administratoren | Liste der Katalogadministratoren: - upn: Universeller Prinzipalname des Kontos – objectId: Azure Active Directory-Objekt-ID des Kontos |
| Benutzer | Liste der Katalogbenutzer: - upn/objectId wie oben |
Beispielantworttext
{
"value": [
{
"id": "/subscriptions/99999999-…-999999999999/resourceGroups/myRG/providers/Microsoft.DataCatalog/catalogs/ExtractorStore1",
"name": "ExtractorStore1",
"type": "Microsoft.DataCatalog/catalogs",
"location": "North US",
"tags": {},
"properties": {
"sku": "Standard",
"units": 1,
"admins": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
],
"successfullyProvisioned": true,
"enableAutomaticUnitAdjustment": false,
"users": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
]
}
}
]
}
Aktualisieren
Updates einen Katalog.
PATCH https://management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resouceGroup>/providers/Microsoft.DataCatalog/catalogs/<catalogName>
URI-Parameter
| Name | Beschreibung | Datentyp |
|---|---|---|
| subscriptionId | Abonnement, in dem der Katalog bereitgestellt werden soll. | String |
| resouceGroup | Alle Ressourcen müssen in einer Gruppe platziert werden. Siehe [Ressourcengruppen]. (https://azure.microsoft.com/documentation/articles/resource-group-overview) | String |
| Catalogname | Name des Katalogs. | String |
Anforderung
| Name | Wert |
|---|---|
| Content-Type | Anwendung/json |
Textbeispiel
{
"properties" : {
"admins" : [{"upn" : "myupn@google.com", "objectId" : "99999999-…-999999999999"}],
}
}
Antwort
| Code | Beschreibung |
|---|---|
| 200 | OK. Eine vorhandene Anmerkung wurde aktualisiert. Wenn ProvisioningState nicht "Succeeded", "Failed" oder "Canceled" lautet, ist der Aufruf asynchron und nicht abgeschlossen. Der Aufrufer muss entweder einen GET-Vorgang für dieselbe URL ausführen, bis ProvisioningState in einen dieser Werte umgewandelt wird, oder den in Azure-AsyncOperation-Header zurückgegebenen Wert überprüfen und diesen Speicherort abfragen. |
| 400 | Ungültige Anforderung. |
Beispielantwortheader
| Name | Wert |
|---|---|
| Access-Control-Allow-Origin | , |
| Cachesteuerung | no-cache,no-cache,no-store |
| Content-Length | 548 |
| Content-Type | application/json; charset=utf-8 |
| Date | Mi,02. März 2016 01:42:46 GMT |
| ETag | W/"AAAAAAABQIE=" |
| Läuft ab | -1 |
Eigenschaften für Antworthauptteil
| Name | BESCHREIBUNG |
|---|---|
| Sku | Entweder "Free" oder "Standard" (Fall zählt). Link zu unserer Preisseite, die beschreibt, was dies bedeutet. |
| Einheiten | Granularität der Abrechnung für die Standard-SKU. Eine Einheit stellt 100 zulässige Benutzer dar. Muss auf einen Wert größer als 0 festgelegt werden, wenn enableAutomaticUnitAdjustment auf false festgelegt ist. Muss auf 0 festgelegt werden, wenn enableAutomaticUnitAdjustment true ist. |
| enableAutomaticUnitAdjustment | Boolesche Einstellung, die bestimmt, ob Einheiten automatisch berechnet werden sollen. Diese Einstellung muss auf true festgelegt werden, um Sicherheitsgruppen in der Administrator- oder Zulassungsliste verwenden zu können. |
| Administratoren | Liste der Katalogadministratoren: - upn: Universeller Prinzipalname des Kontos – objectId: Azure Active Directory-Objekt-ID des Kontos |
| Benutzer | Liste der Katalogbenutzer: - upn/objectId wie oben |
Beispielantworttext
{
"id": "/subscriptions/99999999-…-999999999999/resourceGroups/myRG/providers/Microsoft.DataCatalog/catalogs/ExtractorStore1",
"name": "ExtractorStore1",
"type": "Microsoft.DataCatalog/catalogs",
"location": "North US",
"tags": {},
"properties": {
"sku": "Standard",
"units": 1,
"admins": [
{
"upn": "myupn@google.com",
"objectId": "99999999-…-999999999999"
}
],
"successfullyProvisioned": true,
"enableAutomaticUnitAdjustment": false,
"users": [
{
"upn": "myupn@microsoft.com",
"objectId": "99999999-…-999999999999"
}
]
}
}