Accounts - Create Or Update

Dienst:

Purview

API-Version:

2021-12-01

Erstellen oder Aktualisieren einer Kontoressource
Erstellt oder aktualisiert ein Konto

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}?api-version=2021-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Name des Kontos.
resourceGroupName	path	True	string	Der Ressourcengruppenname.
subscriptionId	path	True	string	Der Abonnementbezeichner
api-version	query	True	string	Die zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
identity	Identity	Identitätsinformationen für die nachverfolgte Ressource
location	string	Dient zum Abrufen oder Festlegen des Speicherorts.
properties.cloudConnectors	CloudConnectors	Cloudconnectors. Externer Cloudbezeichner, der als Teil der Überprüfungskonfiguration verwendet wird.
properties.managedEventHubState	managedEventHubState	Dient zum Abrufen oder Festlegen des Status von verwaltetem EventHub. Wenn aktivierter verwalteter EventHub erstellt wird, wird der verwaltete EventHub entfernt, wenn er deaktiviert ist.
properties.managedResourceGroupName	string	Dient zum Abrufen oder Festlegen des Namens der verwalteten Ressourcengruppe
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	Dient zum Abrufen oder Festlegen des öffentlichen Netzwerkzugriffs für verwaltete Ressourcen.
properties.publicNetworkAccess	publicNetworkAccess	Ruft den Zugriff auf das öffentliche Netzwerk ab oder legt den Zugriff fest.
tags	object	Tags in der Azure-Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	Account	Erfolg
201 Created	Account	Erfolg
Other Status Codes	ErrorResponseModel	Eine vom Anbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Accounts_CreateOrUpdate

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1?api-version=2021-12-01

{
  "location": "West US 2",
  "properties": {
    "managedResourceGroupName": "custom-rgname",
    "managedResourcesPublicNetworkAccess": "Enabled"
  }
}

Beispiel für eine Antwort

Statuscode:

201

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1",
  "name": "account1",
  "type": "Microsoft.Purview/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "properties": {
    "friendlyName": "friendly-account1",
    "provisioningState": "Creating",
    "accountStatus": {
      "accountProvisioningState": "Succeeded",
      "errorDetails": {}
    },
    "endpoints": {
      "catalog": "https://account1.catalog.purview.azure-test.com",
      "scan": "https://account1.scan.purview.azure-test.com",
      "guardian": "https://account1.guardian.purview.azure-test.com"
    },
    "publicNetworkAccess": "Enabled"
  }
}

Statuscode:

200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1",
  "name": "account1",
  "type": "Microsoft.Purview/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "client-name",
    "createdByType": "User",
    "createdAt": "2019-11-22T18:39:58.6929344Z",
    "lastModifiedBy": "client-name",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-16T23:24:34.3430059Z"
  },
  "properties": {
    "friendlyName": "friendly-account1",
    "provisioningState": "Succeeded",
    "accountStatus": {
      "accountProvisioningState": "Succeeded",
      "errorDetails": {}
    },
    "endpoints": {
      "catalog": "https://account1.catalog.purview.azure-test.com",
      "scan": "https://account1.scan.purview.azure-test.com",
      "guardian": "https://account1.guardian.purview.azure-test.com"
    },
    "publicNetworkAccess": "Enabled",
    "managedResourceGroupName": "custom-rgname",
    "managedResourcesPublicNetworkAccess": "Enabled",
    "managedResources": {
      "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname",
      "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr",
      "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"
    }
  }
}

Definitionen

Name	Beschreibung
Account	Kontoressource
accountProvisioningState	Ruft den Kontostatuscode ab.
AccountStatus	Dient zum Abrufen oder Festlegen des Status des Kontos.
CloudConnectors	Connectors für externe Clouddienste
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Endpoints	Die URIs, die die öffentlichen Endpunkte des Kontos sind.
Error	Ruft den Fehler ab oder legt den Fehler fest.
ErrorDetails	Ruft die Kontofehlerdetails ab.
ErrorModel	Standardfehlermodell
ErrorResponseModel	Standardfehlerantwortmodell
Identity	Die verwaltete Identität der Ressource
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
managedEventHubState	Dient zum Abrufen oder Festlegen des Status von verwaltetem EventHub. Wenn aktivierter verwalteter EventHub erstellt wird, wird der verwaltete EventHub entfernt, wenn er deaktiviert ist.
ManagedResources	Ruft die Ressourcenbezeichner der verwalteten Ressourcen ab.
managedResourcesPublicNetworkAccess	Dient zum Abrufen oder Festlegen des öffentlichen Netzwerkzugriffs für verwaltete Ressourcen.
name	Dient zum Abrufen oder Festlegen des Sku-Namens.
PrivateEndpoint	Eine private Endpunktklasse.
PrivateEndpointConnection	Eine private Endpunktverbindungsklasse.
PrivateLinkServiceConnectionState	Der Verbindungsstatus des privaten Verknüpfungsdiensts.
provisioningState	Ruft den Status der Bereitstellung ab oder legt den Status fest.
publicNetworkAccess	Ruft den Zugriff auf das öffentliche Netzwerk ab oder legt den Zugriff fest.
Sku	Ruft die Sku ab oder legt sie fest.
status	Der Status.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TrackedResource.SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	Identitätstyp
UserAssignedIdentity	Verwendet Client-ID und Prinzipal-ID

Account

Objekt

Kontoressource

Name	Typ	Standardwert	Beschreibung
id	string		Dient zum Abrufen oder Festlegen des Bezeichners.
identity	Identity		Identitätsinformationen für die nachverfolgte Ressource
location	string		Dient zum Abrufen oder Festlegen des Speicherorts.
name	string		Ruft den Namen ab oder legt den Namen fest.
properties.accountStatus	AccountStatus		Dient zum Abrufen oder Festlegen des Status des Kontos.
properties.cloudConnectors	CloudConnectors		Cloudconnectors. Externer Cloudbezeichner, der als Teil der Überprüfungskonfiguration verwendet wird.
properties.createdAt	string (date-time)		Ruft den Zeitpunkt ab, zu dem die Entität erstellt wurde.
properties.createdBy	string		Ruft den Ersteller der Entität ab.
properties.createdByObjectId	string		Ruft die Ersteller der Objekt-ID der Entität ab.
properties.endpoints	Endpoints		Die URIs, die die öffentlichen Endpunkte des Kontos sind.
properties.friendlyName	string		Ruft den Anzeigenamen ab oder legt den Anzeigenamen fest.
properties.managedEventHubState	managedEventHubState	NotSpecified	Dient zum Abrufen oder Festlegen des Status von verwaltetem EventHub. Wenn aktivierter verwalteter EventHub erstellt wird, wird der verwaltete EventHub entfernt, wenn er deaktiviert ist.
properties.managedResourceGroupName	string		Dient zum Abrufen oder Festlegen des Namens der verwalteten Ressourcengruppe
properties.managedResources	ManagedResources		Ruft die Ressourcenbezeichner der verwalteten Ressourcen ab.
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Dient zum Abrufen oder Festlegen des öffentlichen Netzwerkzugriffs für verwaltete Ressourcen.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Ruft die Informationen zu privaten Endpunktverbindungen ab.
properties.provisioningState	provisioningState		Ruft den Status der Bereitstellung ab oder legt den Status fest.
properties.publicNetworkAccess	publicNetworkAccess	Enabled	Ruft den Zugriff auf das öffentliche Netzwerk ab oder legt den Zugriff fest.
sku	Sku		Ruft die Sku ab oder legt sie fest.
systemData	TrackedResource.SystemData		Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object		Tags in der Azure-Ressource.
type	string		Dient zum Abrufen oder Festlegen des Typs.

accountProvisioningState

Enumeration

Ruft den Kontostatuscode ab.

Wert	Beschreibung
Unknown
Creating
Updating
Moving
Deleting
SoftDeleting
SoftDeleted
Failed
Succeeded
Canceled

AccountStatus

Objekt

Dient zum Abrufen oder Festlegen des Status des Kontos.

Name	Typ	Beschreibung
accountProvisioningState	accountProvisioningState	Ruft den Kontostatuscode ab.
errorDetails	ErrorDetails	Ruft die Kontofehlerdetails ab.

CloudConnectors

Objekt

Connectors für externe Clouddienste

Name	Typ	Beschreibung
awsExternalId	string	EXTERNEr AWS-Bezeichner. Konfiguriert in AWS, um die Verwendung der rolle zuzulassen, die für das Scannen verwendet wird

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

Endpoints

Objekt

Die URIs, die die öffentlichen Endpunkte des Kontos sind.

Name	Typ	Beschreibung
catalog	string	Ruft den Katalogendpunkt ab.
guardian	string	Ruft den Guardian-Endpunkt ab.
scan	string	Ruft den Scanendpunkt ab.

Error

Objekt

Ruft den Fehler ab oder legt den Fehler fest.

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt diese fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorDetails

Objekt

Ruft die Kontofehlerdetails ab.

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt diese fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorModel

Objekt

Standardfehlermodell

Name	Typ	Beschreibung
code	string	Ruft den Code ab oder legt den Code fest.
details	ErrorModel[]	Ruft die Details ab oder legt diese fest.
message	string	Ruft die Nachrichten ab oder legt sie fest.
target	string	Ruft das Ziel ab oder legt es fest.

ErrorResponseModel

Objekt

Standardfehlerantwortmodell

Name	Typ	Beschreibung
error	Error	Ruft den Fehler ab oder legt den Fehler fest.

Identity

Objekt

Die verwaltete Identität der Ressource

Name	Typ	Beschreibung
principalId	string	Dienstprinzipalobjekt-ID
tenantId	string	Mandanten-ID
type	type	Identitätstyp
userAssignedIdentities	<string,  UserAssignedIdentity>	Benutzer zugewiesene Identitäten

lastModifiedByType

Enumeration

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

managedEventHubState

Enumeration

Dient zum Abrufen oder Festlegen des Status von verwaltetem EventHub. Wenn aktivierter verwalteter EventHub erstellt wird, wird der verwaltete EventHub entfernt, wenn er deaktiviert ist.

Wert	Beschreibung
NotSpecified
Disabled
Enabled

ManagedResources

Objekt

Ruft die Ressourcenbezeichner der verwalteten Ressourcen ab.

Name	Typ	Beschreibung
eventHubNamespace	string	Ruft den Ressourcenbezeichner des verwalteten Event Hub-Namespaces ab.
resourceGroup	string	Ruft den Ressourcenbezeichner der verwalteten Ressourcengruppe ab. Diese Ressourcengruppe hosten Ressourcenabhängigkeiten für das Konto.
storageAccount	string	Ruft den Ressourcenbezeichner des verwalteten Speicherkontos ab.

managedResourcesPublicNetworkAccess

Enumeration

Dient zum Abrufen oder Festlegen des öffentlichen Netzwerkzugriffs für verwaltete Ressourcen.

Wert	Beschreibung
NotSpecified
Enabled
Disabled

name

Enumeration

Dient zum Abrufen oder Festlegen des Sku-Namens.

Wert	Beschreibung
Standard

PrivateEndpoint

Objekt

Eine private Endpunktklasse.

Name	Typ	Beschreibung
id	string	Der private Endpunktbezeichner.

PrivateEndpointConnection

Objekt

Eine private Endpunktverbindungsklasse.

Name	Typ	Beschreibung
id	string	Dient zum Abrufen oder Festlegen des Bezeichners.
name	string	Ruft den Namen ab oder legt den Namen fest.
properties.privateEndpoint	PrivateEndpoint	Die Informationen zum privaten Endpunkt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der Verbindungsstatus des privaten Verknüpfungsdiensts.
properties.provisioningState	string	Der Bereitstellungsstatus.
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Dient zum Abrufen oder Festlegen des Typs.

PrivateLinkServiceConnectionState

Objekt

Der Verbindungsstatus des privaten Verknüpfungsdiensts.

Name	Typ	Beschreibung
actionsRequired	string	Die erforderlichen Aktionen.
description	string	Die Beschreibung.
status	status	Der Status.

provisioningState

Enumeration

Ruft den Status der Bereitstellung ab oder legt den Status fest.

Wert	Beschreibung
Unknown
Creating
Moving
Deleting
SoftDeleting
SoftDeleted
Failed
Succeeded
Canceled

publicNetworkAccess

Enumeration

Ruft den Zugriff auf das öffentliche Netzwerk ab oder legt den Zugriff fest.

Wert	Beschreibung
NotSpecified
Enabled
Disabled

Sku

Objekt

Ruft die Sku ab oder legt sie fest.

Name	Typ	Beschreibung
capacity	integer (int32)	Ruft die SKU-Kapazität ab oder legt sie fest.
name	name	Dient zum Abrufen oder Festlegen des Sku-Namens.

status

Enumeration

Der Status.

Wert	Beschreibung
Unknown
Pending
Approved
Rejected
Disconnected

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TrackedResource.SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

type

Enumeration

Identitätstyp

Wert	Beschreibung
None
SystemAssigned
UserAssigned

UserAssignedIdentity

Objekt

Verwendet Client-ID und Prinzipal-ID

Name	Typ	Beschreibung
clientId	string	Dient zum Abrufen oder Festlegen der Client-ID
principalId	string	Dient zum Abrufen oder Festlegen der Prinzipal-ID.