Ondersteuning voor persoonlijke koppelingen voor bronnen in de API
Met de functie Private Link kunt u persoonlijke eindpunten maken waarmee uw Adobe Experience Platform-bronnen verbinding kunnen maken. Sluit veilig uw bronnen aan een virtueel netwerk aan gebruikend privé IP adressen, die de behoefte aan openbare IPs elimineren en uw aanvalsoppervlakte verminderen. Vereenvoudig uw netwerkopstelling door de behoefte aan complexe firewall of de configuraties van de Vertaling van het Adres van het Netwerk te verwijderen, terwijl het verzekeren van gegevensverkeer slechts de goedgekeurde diensten bereikt.
Lees deze gids om te leren hoe u APIs kunt gebruiken om een privé eindpunt tot stand te brengen en te gebruiken.
Licentiegebruiksrechten voor ondersteuning van persoonlijke koppelingen
De machtigingsgegevens voor het gebruik van licenties voor ondersteuning van persoonlijke koppelingen in bronnen zijn als volgt:
- Klanten hebben recht op maximaal 2 TB per jaar gegevensoverdracht via ondersteunde bronnen (Azure Blob Storage , ADLS Gen2 en Azure File Storage ) voor alle sandboxen en organisaties.
- Elke organisatie kan een maximum van 10 eindpunten voor alle productie zandbakken hebben.
- Elke organisatie kan een maximum van 1 eindpunt voor alle ontwikkelingszandbakken hebben.
Aan de slag
Deze handleiding vereist een goed begrip van de volgende onderdelen van Experience Platform:
- Bronnen: Experience Platform staat gegevens toe om van diverse bronnen worden opgenomen terwijl het voorzien van u van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend de diensten van Experience Platform.
- Sandboxes: Experience Platform verstrekt virtuele zandbakken die één enkele instantie van Experience Platform in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.
Platform-API's gebruiken
Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op begonnen wordt met Platform APIs.
Een privé-eindpunt maken create-private-endpoint
Maak een POST-verzoek aan /privateEndpoints
om een privé-eindpunt te maken.
API formaat
POST /privateEndpoints
Verzoek
Het volgende verzoek leidt tot een privé eindpunt:
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Eigenschap | Beschrijving |
name |
De naam van uw privé eindpunt. |
subscriptionId |
De id die is gekoppeld aan uw Azure -abonnement. Voor meer informatie, lees de Azure gids op het terugwinnen van uw abonnement en huurder IDs van Azure Portal. |
resourceGroupName |
De naam van de bronnengroep op Azure . Een resourcegroep bevat gerelateerde bronnen voor een Azure -oplossing. Voor meer informatie, lees de Azure gids over het leiden middelgroepen. |
resourceName |
De naam van uw bron. In Azure verwijst een bron naar instanties zoals virtuele machines, webapps en databases. Voor meer informatie, lees de Azure gids op die de Azure middelmanagerbegrijpt. |
connectionSpec.id |
De verbindingsspecificatie-id van de bron die u gebruikt. |
connectionSpec.version |
De versie van de verbindingsspecificatie-id die u gebruikt. |
Reactie
Een geslaagde reactie retourneert het volgende:
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Identiteitskaart van uw onlangs gecreeerd privé eindpunt. |
name |
De naam van uw privé eindpunt. |
subscriptionId |
De id die is gekoppeld aan uw Azure -abonnement. Voor meer informatie, lees de Azure gids op het terugwinnen van uw abonnement en huurder IDs van Azure Portal. |
resourceGroupName |
De naam van de bronnengroep op Azure . Een resourcegroep bevat gerelateerde bronnen voor een Azure -oplossing. Voor meer informatie, lees de Azure gids over het leiden middelgroepen. |
resourceName |
De naam van uw bron. In Azure verwijst een bron naar instanties zoals virtuele machines, webapps en databases. Voor meer informatie, lees de Azure gids op die de Azure middelmanagerbegrijpt. |
connectionSpec.id |
De verbindingsspecificatie-id van de bron die u gebruikt. |
connectionSpec.version |
De versie van de verbindingsspecificatie-id die u gebruikt. |
state |
De huidige staat van uw privé eindpunt. Geldige statussen zijn:
|
Een lijst met persoonlijke eindpunten ophalen retrieve-private-endpoints
Als u een lijst met persoonlijke eindpunten van een bepaalde sandbox in uw organisatie wilt ophalen, vraagt u GET om /privateEndpoints
.
API formaat
GET /privateEndpoints
Verzoek
Het volgende verzoek wint een lijst van alle privé eindpunten terug die in uw organisatie bestaan.
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert een lijst van privé eindpunten in uw organisatie terug.
code language-json |
---|
|
Hiermee wordt een lijst met persoonlijke eindpunten voor een bepaalde bron opgehaald retrieve-private-endpoints-by-source
Als u een lijst wilt ophalen met persoonlijke eindpunten die overeenkomen met een specifieke bron, vraagt u GET het /privateEndpoints
-eindpunt aan en geeft u de connectionSpec.id
-bron op.
API formaat
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
Verzoek
Met het volgende verzoek wordt een lijst opgehaald van alle persoonlijke eindpunten die overeenkomen met de bron met de verbindingsspecificatie-id: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-shell |
---|
|
Reactie
Een succesvol antwoord retourneert een lijst met alle persoonlijke eindpunten die overeenkomen met de bron met de verbindingsspecificatie-id: 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-json |
---|
|
Een privé eindpunt ophalen retrieve-specific-private-endpoint
Om een specifiek privé eindpunt terug te winnen, doe een verzoek van GET aan /privateEndpoints
en verstrek identiteitskaart van het privé eindpunt dat u wilt terugwinnen.
API formaat
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Verzoek
Het volgende verzoek wint het privé eindpunt met identiteitskaart terug:2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert het persoonlijke eindpunt met de id: 2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
code language-json |
---|
|
Een privéeindpunt oplossen resolve-private-endpoint
API formaat
GET /privateEndpoints?op=autoResolve
Verzoek
code language-shell |
---|
|
Reactie
code language-json |
---|
|
Interactive Authoring inschakelen enable-interactive-authoring
Interactive Authoring wordt gebruikt voor functies zoals het verkennen van een verbinding of account en het voorvertonen van gegevens. Als u Interactive Authoring wilt inschakelen, moet u een POST-aanvraag indienen bij /privateEndpoints/interactiveAuthoring
en enable
opgeven als een operator in de queryparameters.
API formaat
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
waarde in op enable
.Verzoek
Het volgende verzoek laat Interactive Authoring voor uw privé eindpunt toe en plaatst TTL aan 60 minuten.
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschap | Beschrijving |
autoTerminationMinutes |
De Interactive Authoring TTL (time-to-live) in minuten. Interactive Authoring wordt gebruikt voor functies zoals het verkennen van een verbinding of account en het voorvertonen van gegevens. U kunt een maximum TTL van 120 minuten plaatsen. De standaard TTL is 60 minuten. |
Reactie
Een geslaagde reactie retourneert HTTP-status 202 (geaccepteerd).
Interactive Authoring status ophalen retrieve-interactive-authoring-status
Als u de huidige status van Interactive Authoring voor uw persoonlijke eindpunt wilt weergeven, vraagt u GET om /privateEndpoints/interactiveAuthoring
.
API formaat
GET /privateEndpoints/interactiveAuthoring
Verzoek
Met de volgende aanvraag wordt de status van Interactive Authoring opgehaald:
code language-shell |
---|
|
Reactie
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschap | Beschrijving |
status |
De status van Interactive Authoring . Geldige waarden zijn: disabled , enabling , enabled . |
Persoonlijk eindpunt verwijderen delete-private-endpoint
Om uw privé eindpunt te schrappen, doe een DELETE verzoek aan /privateEndpoints
en verstrek identiteitskaart van het eindpunt dat u wilt schrappen.
API formaat
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Verzoek
Het volgende verzoek verwijdert het persoonlijke eindpunt met de id: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP-status 200 (Voltooid). U kunt de verwijdering controleren door een GET-aanvraag in te dienen en aan /privateEndpoints
een verwijderde id op te geven als een queryparameter.
Flow Service flow-service
Lees de volgende secties voor informatie over hoe u privé eindpunten samen met Flow Service APIkunt gebruiken.
Verbinding maken met een privé-eindpunt create-base-connection
Als u een verbinding wilt maken met een privéeindpunt in Experience Platform, vraagt u een POST-aanvraag naar het /connections
-eindpunt van de Flow Service API.
API formaat
POST /connections/
Verzoek
Het volgende verzoek leidt tot een voor authentiek verklaarde basisverbinding voor Azure Blob Storage, terwijl ook het gebruiken van een privé eindpunt.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
---|---|
Eigenschap | Beschrijving |
name |
De naam van uw basisverbinding. |
description |
(Optioneel) Een beschrijving met aanvullende informatie over de verbinding. |
auth.specName |
De verificatie die wordt gebruikt om uw bron te verbinden met Experience Platform. |
auth.params.connectionString |
De Azure Blob Storage verbindingstekenreeks. Voor meer informatie, lees de Azure Blob Storage API authentificatiegids. |
auth.params.usePrivateLink |
Een booleaanse waarde die bepaalt of u een privé eindpunt gebruikt of niet. Stel deze waarde in op true als u een privé-eindpunt gebruikt. |
connectionSpec.id |
De verbindingsspecificatie-id van Azure Blob Storage . |
connectionSpec.version |
De versie van uw Azure Blob Storage connection spec ID. |
Reactie
Een geslaagde reactie retourneert de zojuist gegenereerde basis verbindings-id en -tag.
code language-json |
---|
|
Hiermee worden verbindingen opgehaald die zijn gekoppeld aan een bepaald privéeindpunt retrieve-connections-by-endpoint
Om verbindingen terug te winnen verbonden aan een bepaald privé eindpunt, doe een verzoek van GET aan het /connections
eindpunt en verstrek identiteitskaart van het privé eindpunt als vraagparameter.
API formaat
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
Verzoek
Het volgende verzoek wint bestaande verbindingen terug die aan privé eindpunt met identiteitskaart worden gebonden: 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert een lijst van verbindingen terug die aan het gevraagde privé eindpunt worden gebonden.
code language-json |
---|
|
Verbindingen ophalen die zijn gekoppeld aan een willekeurig particulier eindpunt retrieve-connections
Als u verbindingen wilt ophalen die aan een willekeurig particulier eindpunt zijn gekoppeld, moet u een GET-aanvraag indienen bij het /connections
-eindpunt en property=auth.params.usePrivateLink==true
opgeven als een queryparameter.
API formaat
GET /connections?property=auth.params.usePrivateLink==true
Verzoek
Het volgende verzoek wint alle verbindingen in uw organisatie terug die privé eindpunten gebruiken.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert alle verbindingen die aan persoonlijke eindpunten zijn gekoppeld.
code language-json |
---|
|
Bijlage
Lees deze sectie voor meer informatie met Azure persoonlijke koppelingen in de API.
Een privé-eindpunt goedkeuren voor Azure Blob en Azure Data Lake Gen2
Als u een aanvraag voor een privéeindpunt voor de bronnen Azure Blob en Azure Data Lake Gen2 wilt goedkeuren, meldt u zich aan bij de map Azure Portal . Selecteer in de linkernavigatie Data storage , ga naar de tab Security + networking en kies Networking . Selecteer vervolgens Private endpoints om een lijst weer te geven met persoonlijke eindpunten die zijn gekoppeld aan uw account en de huidige verbindingsstatussen. Als u een aanvraag in behandeling wilt goedkeuren, selecteert u het gewenste eindpunt en klikt u op Approve .