Private Endpoint Connections - Create Or Update

Tjänst:: Service Bus

API-version:: 2024-01-01

Skapar eller uppdaterar PrivateEndpointAnslutningar av tjänstens namnområde.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Namnområdesnamnet
privateEndpointConnectionName	path	True	string	PrivateEndpointConnection-namnet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	EndPointProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.

Svar

Name	Typ	Description
200 OK	PrivateEndpointConnection	Status för PrivateEndPoint-anslutning har skapats.
201 Created	PrivateEndpointConnection	Begäran om att uppdatera Status för PrivateEndPoint-anslutning accepterad.
202 Accepted	PrivateEndpointConnection	Begäran om att uppdatera Status för PrivateEndPoint-anslutning accepterad.
Other Status Codes	ErrorResponse	ServiceBus-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

NameSpacePrivateEndPointConnectionCreate

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Exempelsvar

Statuskod:: 200

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Statuskod:: 201

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Statuskod:: 202

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Definitioner

Name	Description
ConnectionState	ConnectionState-information.
createdByType	Den typ av identitet som skapade resursen.
EndPointProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
Error	Felobjektet.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Svar på resurshanteringsfel.
PrivateEndpoint	PrivateEndpoint-information.
PrivateEndpointConnection	Egenskaper för PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status för anslutningen.
systemData	Metadata som rör skapande och senaste ändring av resursen.

ConnectionState

Objekt

ConnectionState-information.

Name	Typ	Description
description	string	Beskrivning av anslutningstillståndet.
status	PrivateLinkConnectionStatus	Status för anslutningen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

EndPointProvisioningState

Uppräkning

Etableringstillstånd för den privata slutpunktsanslutningen.

Värde	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

Error

Objekt

Felobjektet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorResponse

Objekt

Svar på resurshanteringsfel.

Name	Typ	Description
error	Error	Felobjektet.

PrivateEndpoint

Objekt

PrivateEndpoint-information.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Objekt

Egenskaper för PrivateEndpointConnection.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	EndPointProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
type	string	Resurstypen. Till exempel "Microsoft.EventHub/Namespaces" eller "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Uppräkning

Status för anslutningen.

Värde	Description
Pending
Approved
Rejected
Disconnected

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Den typ av identitet som senast ändrade resursen.
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Private Endpoint Connections - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

NameSpacePrivateEndPointConnectionCreate

Exempelbegäran

Exempelsvar

Definitioner

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

systemData