SphereDeploymentCollection.Get(String, CancellationToken) Method

Definition

Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
  • Operation Id: Deployments_Get
  • Default Api Version: 2024-04-01
  • Resource: SphereDeploymentResource
public virtual Azure.Response<Azure.ResourceManager.Sphere.SphereDeploymentResource> Get (string deploymentName, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sphere.SphereDeploymentResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sphere.SphereDeploymentResource>
Public Overridable Function Get (deploymentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SphereDeploymentResource)

Parameters

deploymentName
String

Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

deploymentName is null.

Applies to