Nsp Links - Create Or Update

Usługa:

Network Manager

Wersja interfejsu API:

2023-07-01-preview

Tworzy lub aktualizuje zasób łącza NSP.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links/{linkName}?api-version=2023-07-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
linkName	path	True	string	Nazwa linku NSP.
networkSecurityPerimeterName	path	True	string	Nazwa obwodu zabezpieczeń sieci.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
properties.autoApprovedRemotePerimeterResourceId	string	Identyfikator obwodowej usługi ARM dla zdalnego dostawcy NSP, za pomocą którego łącze jest tworzone w trybie automatycznego zatwierdzania. Należy go użyć, gdy administrator NSP ma uprawnienie Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action w zdalnym zasobie NSP.
properties.description	string	Komunikat przekazany właścicielowi zdalnego zasobu łącza NSP z tym żądaniem połączenia. W przypadku przepływu zatwierdzonego automatycznie domyślnie jest to "Automatycznie zatwierdzone". Ograniczony do 140 znaków.
properties.localInboundProfiles	string[]	Lokalne nazwy profilów przychodzących, do których dozwolony jest ruch przychodzący. Użyj polecenia ['*'], aby zezwolić na ruch przychodzący do wszystkich profilów.
properties.remoteInboundProfiles	string[]	Zdalne nazwy profilów przychodzących, do których dozwolony jest ruch przychodzący. Użyj polecenia ['*'], aby zezwolić na ruch przychodzący do wszystkich profilów. Tę właściwość można zaktualizować tylko w trybie automatycznego zatwierdzania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NspLink	Zaktualizowano — zaktualizowano istniejący zasób NspLink. Zwraca zasób.
201 Created	NspLink	Create — zwraca utworzony zasób NspLink.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

NspLinksPut

Przykładowe żądanie

HTTP

PUT https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1?api-version=2023-07-01-preview

{
  "properties": {
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "localInboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "name": "link1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1",
  "type": "Microsoft.Network/networkSecurityPerimeters/links",
  "properties": {
    "provisioningState": "Succeeded",
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "remotePerimeterGuid": "guid",
    "remotePerimeterLocation": "westus2",
    "localInboundProfiles": [
      "*"
    ],
    "localOutboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ],
    "remoteOutboundProfiles": [
      "*"
    ],
    "description": "Auto Approved",
    "status": "Approved"
  }
}

Kod stanu:

201

{
  "name": "link1",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1",
  "type": "Microsoft.Network/networkSecurityPerimeters/links",
  "properties": {
    "provisioningState": "Succeeded",
    "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
    "remotePerimeterGuid": "guid",
    "remotePerimeterLocation": "westus2",
    "localInboundProfiles": [
      "*"
    ],
    "localOutboundProfiles": [
      "*"
    ],
    "remoteInboundProfiles": [
      "*"
    ],
    "remoteOutboundProfiles": [
      "*"
    ],
    "description": "Auto Approved",
    "status": "Approved"
  }
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi.
NspLink	Zasób łącza obwodowego zabezpieczeń sieci
nspLinkProvisioningState	Stan aprowizacji zasobu łącza NSP.
nspLinkStatus	Stan łącza NSP.

CloudError

Objekt

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

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Objekt

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

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	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.

NspLink

Objekt

Zasób łącza obwodowego zabezpieczeń sieci

Nazwa	Typ	Opis
etag	string	Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.autoApprovedRemotePerimeterResourceId	string	Identyfikator obwodowej usługi ARM dla zdalnego dostawcy NSP, za pomocą którego łącze jest tworzone w trybie automatycznego zatwierdzania. Należy go użyć, gdy administrator NSP ma uprawnienie Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action w zdalnym zasobie NSP.
properties.description	string	Komunikat przekazany właścicielowi zdalnego zasobu łącza NSP z tym żądaniem połączenia. W przypadku przepływu zatwierdzonego automatycznie domyślnie jest to "Automatycznie zatwierdzone". Ograniczony do 140 znaków.
properties.localInboundProfiles	string[]	Lokalne nazwy profilów przychodzących, do których dozwolony jest ruch przychodzący. Użyj polecenia ['*'], aby zezwolić na ruch przychodzący do wszystkich profilów.
properties.localOutboundProfiles	string[]	Lokalne nazwy profilów wychodzących, z których dozwolony jest ruch wychodzący. W bieżącej wersji jest to właściwość readonly i jest ustawiona na wartość ['*'], aby zezwolić na ruch wychodzący ze wszystkich profilów. W nowszej wersji użytkownik będzie mógł go modyfikować.
properties.provisioningState	nspLinkProvisioningState	Stan aprowizacji zasobu łącza NSP.
properties.remoteInboundProfiles	string[]	Zdalne nazwy profilów przychodzących, do których dozwolony jest ruch przychodzący. Użyj polecenia ['*'], aby zezwolić na ruch przychodzący do wszystkich profilów. Tę właściwość można zaktualizować tylko w trybie automatycznego zatwierdzania.
properties.remoteOutboundProfiles	string[]	Zdalne nazwy profilów wychodzących, z których dozwolony jest ruch wychodzący. W bieżącej wersji jest to właściwość readonly i jest ustawiona na wartość ['*'], aby zezwolić na ruch wychodzący ze wszystkich profilów. W nowszej wersji użytkownik będzie mógł go modyfikować.
properties.remotePerimeterGuid	string	Zdalny identyfikator NSP Guid, za pomocą którego zostanie utworzony link.
properties.remotePerimeterLocation	string	Zdalna lokalizacja NSP, z którą jest tworzony link.
properties.status	nspLinkStatus	Stan łącza NSP.
type	string	Typ zasobu.

nspLinkProvisioningState

Wyliczanie

Stan aprowizacji zasobu łącza NSP.

Wartość	Opis
Accepted
Creating
Deleting
Failed
Succeeded
Updating
WaitForRemoteCompletion

nspLinkStatus

Wyliczanie

Stan łącza NSP.

Wartość	Opis
Approved
Disconnected
Pending
Rejected