Accounts - Create Or Update

Szolgáltatás:

Purview

API-verzió:

2021-12-01

Fiókerőforrás létrehozása vagy frissítése
Fiók létrehozása vagy frissítése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	A fiók neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés azonosítója
api-version	query	True	string	A használni kívánt API-verzió.

Kérelem törzse

Name	Típus	Description
identity	Identity	Identitásadatok a nyomon követett erőforráson
location	string	Lekéri vagy beállítja a helyet.
properties.cloudConnectors	CloudConnectors	Felhőbeli összekötők. A beolvasási konfiguráció részeként használt külső felhőazonosító.
properties.managedEventHubState	managedEventHubState	Lekéri vagy beállítja a felügyelt eventhub állapotát. Ha engedélyezve van a felügyelt eventhub létrehozása, letiltás esetén a felügyelt eventhub el lesz távolítva.
properties.managedResourceGroupName	string	Lekéri vagy beállítja a felügyelt erőforráscsoport nevét
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	Lekéri vagy beállítja a nyilvános hálózati hozzáférést a felügyelt erőforrásokhoz.
properties.publicNetworkAccess	publicNetworkAccess	Lekéri vagy beállítja a nyilvános hálózati hozzáférést.
tags	object	Címkék az Azure-erőforráson.

Válaszok

Name	Típus	Description
200 OK	Account	Siker
201 Created	Account	Siker
Other Status Codes	ErrorResponseModel	A szolgáltatótól kapott hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Accounts_CreateOrUpdate

Mintakérelem

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"
  }
}

Mintaválasz

Állapotkód:

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"
  }
}

Állapotkód:

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"
    }
  }
}

Definíciók

Name	Description
Account	Fiókerőforrás
accountProvisioningState	Lekéri a fiók állapotkódját.
AccountStatus	Lekéri vagy beállítja a fiók állapotát.
CloudConnectors	Külső felhőszolgáltatás-összekötők
createdByType	Az erőforrást létrehozó identitás típusa.
Endpoints	A fiók nyilvános végpontjait képező URI-k.
Error	Lekéri vagy beállítja a hibát.
ErrorDetails	Lekéri a fiókhibák részleteit.
ErrorModel	Alapértelmezett hibamodell
ErrorResponseModel	Alapértelmezett hibaválasz-modell
Identity	Az erőforrás felügyelt identitása
lastModifiedByType	Az erőforrást legutóbb módosító identitás típusa.
managedEventHubState	Lekéri vagy beállítja a felügyelt eventhub állapotát. Ha engedélyezve van a felügyelt eventhub létrehozása, letiltás esetén a felügyelt eventhub el lesz távolítva.
ManagedResources	Lekéri a felügyelt erőforrások erőforrás-azonosítóit.
managedResourcesPublicNetworkAccess	Lekéri vagy beállítja a nyilvános hálózati hozzáférést a felügyelt erőforrásokhoz.
name	Lekéri vagy beállítja a termékváltozat nevét.
PrivateEndpoint	Privát végpontosztály.
PrivateEndpointConnection	Egy privát végpont kapcsolatosztálya.
PrivateLinkServiceConnectionState	A privát kapcsolati szolgáltatás kapcsolati állapota.
provisioningState	Lekéri vagy beállítja a kiépítés állapotát.
publicNetworkAccess	Lekéri vagy beállítja a nyilvános hálózati hozzáférést.
Sku	Lekéri vagy beállítja a termékváltozatot.
status	Az állapot.
SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TrackedResource.SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	Identitástípus
UserAssignedIdentity	Ügyfél-azonosítót és egyszerű azonosítót használ

Account

Objektum

Fiókerőforrás

Name	Típus	Alapértelmezett érték	Description
id	string		Lekéri vagy beállítja az azonosítót.
identity	Identity		Identitásadatok a nyomon követett erőforráson
location	string		Lekéri vagy beállítja a helyet.
name	string		Lekéri vagy beállítja a nevet.
properties.accountStatus	AccountStatus		Lekéri vagy beállítja a fiók állapotát.
properties.cloudConnectors	CloudConnectors		Felhőbeli összekötők. A beolvasási konfiguráció részeként használt külső felhőazonosító.
properties.createdAt	string (date-time)		Lekéri az entitás létrehozásának időpontját.
properties.createdBy	string		Lekéri az entitás létrehozóját.
properties.createdByObjectId	string		Lekéri az entitás objektumazonosítójának létrehozóit.
properties.endpoints	Endpoints		A fiók nyilvános végpontjait képező URI-k.
properties.friendlyName	string		Lekéri vagy beállítja a rövid nevet.
properties.managedEventHubState	managedEventHubState	NotSpecified	Lekéri vagy beállítja a felügyelt eventhub állapotát. Ha engedélyezve van a felügyelt eventhub létrehozása, letiltás esetén a felügyelt eventhub el lesz távolítva.
properties.managedResourceGroupName	string		Lekéri vagy beállítja a felügyelt erőforráscsoport nevét
properties.managedResources	ManagedResources		Lekéri a felügyelt erőforrások erőforrás-azonosítóit.
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Lekéri vagy beállítja a nyilvános hálózati hozzáférést a felügyelt erőforrásokhoz.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lekéri a privát végpont kapcsolatainak adatait.
properties.provisioningState	provisioningState		Lekéri vagy beállítja a kiépítés állapotát.
properties.publicNetworkAccess	publicNetworkAccess	Enabled	Lekéri vagy beállítja a nyilvános hálózati hozzáférést.
sku	Sku		Lekéri vagy beállítja a termékváltozatot.
systemData	TrackedResource.SystemData		Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object		Címkék az Azure-erőforráson.
type	string		Lekéri vagy beállítja a típust.

accountProvisioningState

Enumerálás

Lekéri a fiók állapotkódját.

Érték	Description
Canceled
Creating
Deleting
Failed
Moving
SoftDeleted
SoftDeleting
Succeeded
Unknown
Updating

AccountStatus

Objektum

Lekéri vagy beállítja a fiók állapotát.

Name	Típus	Description
accountProvisioningState	accountProvisioningState	Lekéri a fiók állapotkódját.
errorDetails	ErrorDetails	Lekéri a fiókhibák részleteit.

CloudConnectors

Objektum

Külső felhőszolgáltatás-összekötők

Name	Típus	Description
awsExternalId	string	AWS külső azonosító. Az AWS-ben konfigurálva, hogy engedélyezze a vizsgálathoz használt arn szerepkör használatát

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

Endpoints

Objektum

A fiók nyilvános végpontjait képező URI-k.

Name	Típus	Description
catalog	string	Lekéri a katalógusvégpontot.
guardian	string	Lekéri a gyám végpontot.
scan	string	Lekéri a vizsgálati végpontot.

Error

Objektum

Lekéri vagy beállítja a hibát.

Name	Típus	Description
code	string	Lekéri vagy beállítja a kódot.
details	ErrorModel[]	Lekéri vagy beállítja a részleteket.
message	string	Lekéri vagy beállítja az üzeneteket.
target	string	Lekéri vagy beállítja a célt.

ErrorDetails

Objektum

Lekéri a fiókhibák részleteit.

Name	Típus	Description
code	string	Lekéri vagy beállítja a kódot.
details	ErrorModel[]	Lekéri vagy beállítja a részleteket.
message	string	Lekéri vagy beállítja az üzeneteket.
target	string	Lekéri vagy beállítja a célt.

ErrorModel

Objektum

Alapértelmezett hibamodell

Name	Típus	Description
code	string	Lekéri vagy beállítja a kódot.
details	ErrorModel[]	Lekéri vagy beállítja a részleteket.
message	string	Lekéri vagy beállítja az üzeneteket.
target	string	Lekéri vagy beállítja a célt.

ErrorResponseModel

Objektum

Alapértelmezett hibaválasz-modell

Name	Típus	Description
error	Error	Lekéri vagy beállítja a hibát.

Identity

Objektum

Az erőforrás felügyelt identitása

Name	Típus	Description
principalId	string	Szolgáltatásnév objektumazonosítója
tenantId	string	Bérlőazonosító
type	type	Identitástípus
userAssignedIdentities	<string,  UserAssignedIdentity>	Felhasználó által hozzárendelt identitások

lastModifiedByType

Enumerálás

Az erőforrást legutóbb módosító identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

managedEventHubState

Enumerálás

Lekéri vagy beállítja a felügyelt eventhub állapotát. Ha engedélyezve van a felügyelt eventhub létrehozása, letiltás esetén a felügyelt eventhub el lesz távolítva.

Érték	Description
Disabled
Enabled
NotSpecified

ManagedResources

Objektum

Lekéri a felügyelt erőforrások erőforrás-azonosítóit.

Name	Típus	Description
eventHubNamespace	string	Lekéri a felügyelt eseményközpont névterének erőforrás-azonosítóját.
resourceGroup	string	Lekéri a felügyelt erőforráscsoport erőforrás-azonosítóját. Ez az erőforráscsoport a fiók erőforrásfüggőségeit fogja üzemeltetni.
storageAccount	string	Lekéri a felügyelt tárfiók erőforrás-azonosítót.

managedResourcesPublicNetworkAccess

Enumerálás

Lekéri vagy beállítja a nyilvános hálózati hozzáférést a felügyelt erőforrásokhoz.

Érték	Description
Disabled
Enabled
NotSpecified

name

Enumerálás

Lekéri vagy beállítja a termékváltozat nevét.

Érték	Description
Standard

PrivateEndpoint

Objektum

Privát végpontosztály.

Name	Típus	Description
id	string	A privát végpont azonosítója.

PrivateEndpointConnection

Objektum

Egy privát végpont kapcsolatosztálya.

Name	Típus	Description
id	string	Lekéri vagy beállítja az azonosítót.
name	string	Lekéri vagy beállítja a nevet.
properties.privateEndpoint	PrivateEndpoint	A privát végpont adatai.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát kapcsolati szolgáltatás kapcsolati állapota.
properties.provisioningState	string	A kiépítési állapot.
systemData	SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Lekéri vagy beállítja a típust.

PrivateLinkServiceConnectionState

Objektum

A privát kapcsolati szolgáltatás kapcsolati állapota.

Name	Típus	Description
actionsRequired	string	A szükséges műveletek.
description	string	A leírás.
status	status	Az állapot.

provisioningState

Enumerálás

Lekéri vagy beállítja a kiépítés állapotát.

Érték	Description
Canceled
Creating
Deleting
Failed
Moving
SoftDeleted
SoftDeleting
Succeeded
Unknown

publicNetworkAccess

Enumerálás

Lekéri vagy beállítja a nyilvános hálózati hozzáférést.

Érték	Description
Disabled
Enabled
NotSpecified

Sku

Objektum

Lekéri vagy beállítja a termékváltozatot.

Name	Típus	Description
capacity	integer (int32)	Lekéri vagy beállítja a termékváltozat kapacitását.
name	name	Lekéri vagy beállítja a termékváltozat nevét.

status

Enumerálás

Az állapot.

Érték	Description
Approved
Disconnected
Pending
Rejected
Unknown

SystemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC).
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	lastModifiedByType	Az erőforrást legutóbb módosító identitás típusa.

TrackedResource.SystemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC).
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	lastModifiedByType	Az erőforrást legutóbb módosító identitás típusa.

type

Enumerálás

Identitástípus

Érték	Description
None
SystemAssigned
UserAssigned

UserAssignedIdentity

Objektum

Ügyfél-azonosítót és egyszerű azonosítót használ

Name	Típus	Description
clientId	string	Ügyfél-azonosító lekérdezi vagy beállítja
principalId	string	Egyszerű azonosító lekérdezés vagy beállítás