Nsp Links - Create Or Update

服務:

Network Manager

API 版本:

2023-07-01-preview

建立或更新 NSP 鏈接資源。

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

URI 參數

名稱	位於	必要	類型	Description
linkName	path	True	string	NSP 連結的名稱。
networkSecurityPerimeterName	path	True	string	網路安全性周邊的名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
properties.autoApprovedRemotePerimeterResourceId	string	遠端 NSP 的周邊 ARM 識別碼，連結會以自動核准模式建立。 當 NSP 系統管理員具有遠端 NSP 資源的 Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action 許可權時，應該使用它。
properties.description	string	傳遞至遠端 NSP 鏈接資源擁有者的訊息，其中包含此連線要求。 如果是自動核准的流程，預設為「自動核准」。 限制為140個字元。
properties.localInboundProfiles	string[]	允許輸入的本機輸入配置檔名稱。 使用 ['*'] 允許所有配置檔的輸入。
properties.remoteInboundProfiles	string[]	允許輸入的遠端輸入設定檔名稱。 使用 ['*'] 允許所有配置檔的輸入。 此屬性只能在自動核准模式中更新。

回應

名稱	類型	Description
200 OK	NspLink	已更新 - 現有的 NspLink 資源已更新。 傳回資源。
201 Created	NspLink	建立 - 傳回建立的 NspLink 資源。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

NspLinksPut

範例要求

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": [
      "*"
    ]
  }
}

範例回覆

狀態碼:

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"
  }
}

狀態碼:

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"
  }
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
NspLink	網路安全性周邊鏈接資源
nspLinkProvisioningState	NSP Link 資源的布建狀態。
nspLinkStatus	NSP 連結狀態。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

NspLink

Object

網路安全性周邊鏈接資源

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	資源名稱。
properties.autoApprovedRemotePerimeterResourceId	string	遠端 NSP 的周邊 ARM 識別碼，連結會以自動核准模式建立。 當 NSP 系統管理員具有遠端 NSP 資源的 Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action 許可權時，應該使用它。
properties.description	string	傳遞至遠端 NSP 鏈接資源擁有者的訊息，其中包含此連線要求。 如果是自動核准的流程，預設為「自動核准」。 限制為140個字元。
properties.localInboundProfiles	string[]	允許輸入的本機輸入配置檔名稱。 使用 ['*'] 允許所有配置檔的輸入。
properties.localOutboundProfiles	string[]	允許輸出的本機輸出配置檔名稱。 在目前的版本中，它是只讀屬性，且其值為 ['*'] 以允許所有配置文件的輸出。 在更新版本中，用戶將能夠修改它。
properties.provisioningState	nspLinkProvisioningState	NSP Link 資源的布建狀態。
properties.remoteInboundProfiles	string[]	允許輸入的遠端輸入設定檔名稱。 使用 ['*'] 允許所有配置檔的輸入。 此屬性只能在自動核准模式中更新。
properties.remoteOutboundProfiles	string[]	允許輸出的遠端輸出配置檔名稱。 在目前的版本中，它是只讀屬性，且其值為 ['*'] 以允許所有配置文件的輸出。 在更新版本中，用戶將能夠修改它。
properties.remotePerimeterGuid	string	建立連結的遠端 NSP Guid。
properties.remotePerimeterLocation	string	建立連結的遠端 NSP 位置。
properties.status	nspLinkStatus	NSP 連結狀態。
type	string	資源類型。

nspLinkProvisioningState

列舉型別

NSP Link 資源的布建狀態。

值	Description
Accepted
Creating
Deleting
Failed
Succeeded
Updating
WaitForRemoteCompletion

nspLinkStatus

列舉型別

NSP 連結狀態。

值	Description
Approved
Disconnected
Pending
Rejected