DeviceManagementClient.DeleteGroupAsync(String, RequestContext) Methode

Referenz

Definition

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Paket:: Azure.IoT.DeviceUpdate v1.0.0

Quelle:: DeviceManagementClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Löscht eine Gerätegruppe. Diese Gruppe wird automatisch erstellt, wenn ein Gerät, das geräteupdatefähig ist, mit dem Hub verbunden ist, und seine Eigenschaften meldet. Gruppen, Untergruppen und Bereitstellungen werden nicht automatisch bereinigt, sondern zu Verlaufszwecken beibehalten. Benutzer können diese Methode aufrufen, um eine Gruppe zu löschen, wenn sie den Verlauf der Gruppe nicht beibehalten und nicht mehr benötigen. Wenn ein Gerät jemals wieder mit dieser Gruppe verbunden ist, nachdem die Gruppe gelöscht wurde, wird es automatisch neu erstellt, aber es gibt keinen Verlauf.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteGroupAsync (string groupId, Azure.RequestContext context = default);

abstract member DeleteGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteGroupAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteGroupAsync (groupId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameter

groupId: String

Gruppen-ID.

context: RequestContext

Der Anforderungskontext, der das Standardverhalten der Clientpipeline pro Aufruf außer Kraft setzen kann.

Gibt zurück

Task<Response>

Die vom Dienst zurückgegebene Antwort.

Ausnahmen

ArgumentNullException

groupId ist NULL.

ArgumentException

groupId ist eine leere Zeichenfolge und wurde erwartet, dass sie nicht leer ist.

RequestFailedException

Der Dienst hat einen nicht erfolgreichen status Code zurückgegeben.

Beispiele

In diesem Beispiel wird gezeigt, wie DeleteGroupAsync mit den erforderlichen Parametern aufgerufen wird.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceManagementClient(endpoint, "<instanceId>", credential);

Response response = await client.DeleteGroupAsync("<groupId>");
Console.WriteLine(response.Status);

Hinweise

Schema für Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [Error],
                innererror: {
                  code: string,
                  message: string,
                  errorDetail: string,
                  innerError: InnerError
                },
                occurredDateTime: string (ISO 8601 Format)
              }
            }

Gilt für:

Freigeben über