Workload Networks - Get Gateway

Get a gateway by id in a private cloud workload network.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}?api-version=2022-05-01

URI Parameters

Name In Required Type Description
gatewayId
path True
  • string

NSX Gateway identifier. Generally the same as the Gateway's display name

privateCloudName
path True
  • string

Name of the private cloud

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

successful operation

Other Status Codes

Error response describing why the operation failed

Security

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 impersonate your user account

Examples

WorkloadNetworks_GetGateway

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/gateways/gateway1?api-version=2022-05-01

Sample Response

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/gateways/gateway1",
  "name": "gateway1",
  "properties": {
    "displayName": "gateway1",
    "path": "/infra/tier-1s/gateway1"
  },
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/gateways"
}

Definitions

CloudError

API error response

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

WorkloadNetworkGateway

NSX Gateway.

CloudError

API error response

Name Type Description
error

Error Response
An error returned by the API

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorResponse

Error Response

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

WorkloadNetworkGateway

NSX Gateway.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.displayName
  • string

Display name of the DHCP entity.

properties.path
  • string

NSX Gateway Path.

type
  • string

Resource type.