SphereCatalogResource.GetSphereImageAsync(String, CancellationToken) Method

Definition

Get a Image

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
  • Operation Id: Images_Get
  • Default Api Version: 2024-04-01
  • Resource: SphereImageResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sphere.SphereImageResource>> GetSphereImageAsync (string imageName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSphereImageAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sphere.SphereImageResource>>
override this.GetSphereImageAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Sphere.SphereImageResource>>
Public Overridable Function GetSphereImageAsync (imageName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SphereImageResource))

Parameters

imageName
String

Image name. Use an image GUID for GA versions of the API.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

imageName is null.

imageName is an empty string, and was expected to be non-empty.

Applies to