Private Endpoint Connections - Get

Service:

Azure Data Manager for Agriculture

API-versie:

2023-06-01-preview

Privé-eindpuntverbindingsobject ophalen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-06-01-preview

URI-parameters

Name	In	Vereist	Type	Description
dataManagerForAgricultureResourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Resourcenaam DataManagerForAgriculture.
privateEndpointConnectionName	path	True	string	Naam van privé-eindpuntverbinding.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	PrivateEndpointConnection	Geslaagd
404 Not Found	ErrorResponse	Niet gevonden
Other Status Codes	ErrorResponse	Fout

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

PrivateEndpointConnections_Get

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName?api-version=2023-06-01-preview

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/privateEndpointConnections/privateEndpointConnectionName",
  "name": "privateEndpointConnectionName",
  "type": "Microsoft.AgFoodPlatform/farmBeats/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com",
      "actionsRequired": "None"
    },
    "provisioningState": "Succeeded"
  }
}

Statuscode:

404

{
  "error": {
    "code": "PrivateEndpointConnectionNotFound",
    "message": "Private endpoint connection resource 'privateEndpointConnectionName' for subscriptionId '11111111-2222-3333-4444-555555555555', resource group name 'examples-rg', resource type 'farmBeats' and resource name 'examples-farmbeatsResourceName' not found."
  }
}

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
PrivateEndpoint	De privé-eindpuntresource.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

PrivateEndpoint

Object

De privé-eindpuntresource.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt.

PrivateEndpointConnection

Object

De privé-eindpuntverbindingsresource.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.groupIds	string[]	De groeps-id's voor de privé-eindpuntresource.
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Inventarisatie

De verbindingsstatus van het privé-eindpunt.

Waarde	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.