Get SdnApiEndpoint

Get-SdnApiEndpoint

SYNOPSIS

Used to construct the URI endpoint for Network Controller NB API

SYNTAX

ResourceName

Get-SdnApiEndpoint -NcUri <Uri> [-ApiVersion <String>] -ResourceName <String> [-OperationId <String>]
 [<CommonParameters>]

ResourceRef

Get-SdnApiEndpoint -NcUri <Uri> [-ApiVersion <String>] -ResourceRef <String> [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SdnApiEndpoint -NcUri $NcUri.AbsoluteUri -ResourceName 'VirtualNetworks'

EXAMPLE 2

Get-SdnApiEndpoint -NcUri $NcUri.AbsoluteUri -ResourceName '/virtualnetworks/contoso-vnet01'

PARAMETERS

-NcUri

Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.

Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ApiVersion

The API version to use when invoking against the NC REST API endpoint. By default, reads from $Global:SdnDiagnostics.EnvironmentInfo.RestApiVersion which defaults to 'v1' unless explicity overwritten, or 'Get-SdnInfrastructureInfo' is called.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $Global:SdnDiagnostics.EnvironmentInfo.RestApiVersion
Accept pipeline input: False
Accept wildcard characters: False

-ResourceName

Network Controller resource exposed via NB API interface of Network Controller, as defined under https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-ncnbi/6dbabf43-0fcd-439c-81e2-7eb794f7c140.

Type: String
Parameter Sets: ResourceName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperationId

Operation ID for diagnostics operation. This is optional and only used for certain resources.

Type: String
Parameter Sets: ResourceName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceRef

The exact resource reference in format of /resourceName/{resourceId}/childObject/{resourceId}

Type: String
Parameter Sets: ResourceRef
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS