Private Endpoint Connection - Update

Aktualizuje właściwości istniejącego połączenia prywatnego punktu końcowego.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-06-01

Parametry identyfikatora URI

Name In Required Type Description
accountName
path True
  • string

Nazwa konta usługi Batch.

Regex pattern: ^[a-zA-Z0-9]+$

privateEndpointConnectionName
path True
  • string

Nazwa połączenia prywatnego punktu końcowego. Musi to być unikatowe w ramach konta.

Regex pattern: ^[a-zA-Z0-9_-]+\.?[a-fA-F0-9-]*$

resourceGroupName
path True
  • string

Nazwa grupy zasobów zawierającej konto usługi Batch.

subscriptionId
path True
  • string

Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000)

api-version
query True
  • string

Wersja interfejsu API, która ma być używana z żądaniem HTTP.

Nagłówek żądania

Name Required Type Description
If-Match
  • string

Wersja stanu (ETag) połączenia prywatnego punktu końcowego do aktualizacji. Tę wartość można pominąć lub ustawić na "*", aby zastosować operację bezwarunkowo.

Treść żądania

Name Type Description
properties.privateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym.
Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

Odpowiedzi

Name Type Description
200 OK

Operacja zakończyła się pomyślnie. Odpowiedź zawiera element PrivateEndpointConnection.

202 Accepted

Operacja została zaakceptowana i zostanie wykonana w tle.

Headers

  • Location: string
  • Retry-After: integer
204 No Content

Operacja zakończyła się pomyślnie.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

UpdatePrivateEndpointConnection

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0?api-version=2022-06-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}

Sample Response

ETag: W/"0x8D4EDFEBFADF4AB"
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
  "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
    },
    "groupIds": [
      "batchAccount"
    ],
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by xyz.abc@company.com"
    }
  }
}
Retry-After: 15
Location: https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2022-01-01

Definicje

CloudError

Odpowiedź na błąd z usługi Batch.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

PrivateEndpoint

Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

PrivateEndpointConnection

Zawiera informacje o zasobie łącza prywatnego.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego usługi Batch

CloudError

Odpowiedź na błąd z usługi Batch.

Name Type Description
error

Treść odpowiedzi o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

Name Type Description
code
  • string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

Lista dodatkowych szczegółów dotyczących błędu.

message
  • string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target
  • string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

PrivateEndpoint

Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

Name Type Description
id
  • string

Identyfikator zasobu usługi ARM prywatnego punktu końcowego. Jest to formularz /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Zawiera informacje o zasobie łącza prywatnego.

Name Type Description
etag
  • string

Element ETag zasobu używany na potrzeby instrukcji współbieżności.

id
  • string

Identyfikator zasobu.

name
  • string

Nazwa zasobu.

properties.groupIds
  • string[]

Identyfikator grupy połączenia prywatnego punktu końcowego.
Wartość ma jeden i tylko jeden identyfikator grupy.

properties.privateEndpoint

Identyfikator zasobu usługi ARM prywatnego punktu końcowego.
Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

properties.privateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym.
Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

properties.provisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

type
  • string

Typ zasobu.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Name Type Description
Cancelled
  • string

Użytkownik anulował tworzenie połączenia.

Creating
  • string

Trwa tworzenie połączenia.

Deleting
  • string

Połączenie jest usuwane.

Failed
  • string

Użytkownik zażądał, aby połączenie zostało zaktualizowane i nie powiodło się. Możesz ponowić próbę wykonania operacji aktualizacji.

Succeeded
  • string

Stan połączenia jest końcowy i jest gotowy do użycia, jeśli stan to Zatwierdzone.

Updating
  • string

Użytkownik zażądał zaktualizowania stanu połączenia, ale operacja aktualizacji nie została jeszcze ukończona. Nie można odwoływać się do połączenia podczas nawiązywania połączenia z kontem usługi Batch.

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

Name Type Description
actionRequired
  • string

Akcja wymagana w stanie połączenia prywatnego

description
  • string

Opis stanu połączenia prywatnego

status

Stan połączenia prywatnego punktu końcowego konta usługi Batch

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego usługi Batch

Name Type Description
Approved
  • string

Połączenie prywatnego punktu końcowego jest zatwierdzone i może służyć do uzyskiwania dostępu do konta usługi Batch

Disconnected
  • string

Połączenie prywatnego punktu końcowego jest rozłączone i nie można go użyć do uzyskiwania dostępu do konta usługi Batch

Pending
  • string

Połączenie prywatnego punktu końcowego oczekuje i nie może być używane do uzyskiwania dostępu do konta usługi Batch

Rejected
  • string

Połączenie prywatnego punktu końcowego jest odrzucane i nie można go użyć do uzyskiwania dostępu do konta usługi Batch