SphereDeviceResource.GenerateCapabilityImageAsync Method

Definition

Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage
  • Operation Id: Devices_GenerateCapabilityImage
  • Default Api Version: 2024-04-01
  • Resource: SphereDeviceResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sphere.Models.SignedCapabilityImageResponse>> GenerateCapabilityImageAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Sphere.Models.GenerateCapabilityImageContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member GenerateCapabilityImageAsync : Azure.WaitUntil * Azure.ResourceManager.Sphere.Models.GenerateCapabilityImageContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sphere.Models.SignedCapabilityImageResponse>>
override this.GenerateCapabilityImageAsync : Azure.WaitUntil * Azure.ResourceManager.Sphere.Models.GenerateCapabilityImageContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sphere.Models.SignedCapabilityImageResponse>>
Public Overridable Function GenerateCapabilityImageAsync (waitUntil As WaitUntil, content As GenerateCapabilityImageContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of SignedCapabilityImageResponse))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content
GenerateCapabilityImageContent

Generate capability image request body.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to