Freigeben über


Kanal: Archiv

Namespace: microsoft.graph

Archiv eines Kanals in einem Team. Wenn ein Kanal archiviert wird, können Benutzer keine neuen Nachrichten senden oder auf vorhandene Nachrichten im Kanal reagieren, die Kanaleinstellungen bearbeiten oder andere Änderungen am Kanal vornehmen.

Sie können einen archivierten Kanal löschen oder Mitglieder hinzufügen und daraus entfernen. Wenn Sie ein Team archivieren, werden auch seine Kanäle archiviert.

Die Archivierung ist ein asynchroner Vorgang. Ein Kanal wird archiviert, nachdem der asynchrone Archivierungsvorgang erfolgreich abgeschlossen wurde. Dies kann auftreten, nachdem die Antwort zurückgegeben wurde.

Ein Kanal ohne Besitzer oder ein Kanal, der zu einer Gruppe ohne Besitzer gehört, kann nicht archiviert werden.

Um einen Kanal aus seinem archivierten Zustand wiederherzustellen, verwenden Sie die Methode channel: unarchive . Ein Kanal kann nicht archiviert oder nicht archiviert werden, wenn sein Team archiviert ist.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) ChannelSettings.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application ChannelSettings.ReadWrite.All Nicht verfügbar.

Hinweis: Diese API unterstützt Administratorberechtigungen. Benutzer mit der Rolle "Globaler Administrator" oder "Microsoft Teams-Dienstadministrator" können auf Teams zugreifen, denen sie nicht angehören.

HTTP-Anforderung

POST /teams/{team-id}/channels/{channel-id}/archive
POST /groups/{team-id}/team/channels/{channel-id}/archive

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Optional.

Anforderungstext

Im Anforderungstext können Sie optional ein JSON-Objekt mit dem folgenden Parameter bereitstellen.

Parameter Typ Beschreibung
shouldSetSpoSiteReadOnlyForMembers Boolean Definiert, ob Berechtigungen für Kanalmitglieder für schreibgeschützt auf der SharePoint Online-Website festgelegt werden sollen, die dem Team zugeordnet ist. Wenn Sie ihn auf false festlegen oder den Parameter weglassen, wird dieser Schritt übersprungen.

Das folgende Beispiel zeigt den Anforderungstext, bei dem shouldSetSpoSiteReadOnlyForMembers auf festgelegt ist true.

{
  "shouldSetSpoSiteReadOnlyForMembers": true
}

Antwort

Wenn die Archivierung erfolgreich gestartet wird, gibt diese Methode eine 202 Accepted Antwortcode. Die Antwort enthält einen Location Header, der den Speicherort der teamsAsyncOperation angibt, die für die Archivierung des Kanals in einem Team erstellt wurde. Überprüfen Sie den Status des Archivierungsvorgangs, indem Sie eine GET-Anforderung an diesen Speicherort stellen.

Beispiele

Beispiel 1: Archiv eines Kanals

Das folgende Beispiel zeigt eine Anforderung zum Archivieren eines Kanals.

Anforderung

POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 202 Accepted
Location: /teams/16dc05c0-2259-4540-a970-3580ff459721/operations/b7ee702a-d87f-4cc6-82b9-e731c16d3aba
Content-Type: text/plain
Content-Length: 0

Beispiel 2: Archiv eines Kanals, wenn das Team archiviert wird

Das folgende Beispiel zeigt eine Anforderung zum Archivieren eines Kanals, die fehlschlägt, weil das Team archiviert ist. Das Team muss aktiv sein, um einen Kanal zu archivieren oder die Archivierung aufzuheben.

Anforderung

POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive

Antwort

Das folgende Beispiel zeigt den 400 Bad Request Antwortcode mit einer entsprechenden Fehlermeldung.

http/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 193

{
    "error": {
        "code": "BadRequest",
        "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
        "innerError": {
            "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
            "code": "Unknown",
            "innerError": {},
            "date": "2023-12-11T04:26:35",
            "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
            "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
        }
    }
}