UIP ou dossiers

Syntaxe et options pour `uip ou folders`, qui gère les conteneurs de dossiers hiérarchiques qui s'appliquent aux ressources et aux autorisations d'Orchestrator.

uip or folders gère les dossiers Orchestrator — les conteneurs hiérarchiques qui s'appliquent aux processus, aux tâches, aux ressources, aux files d'attente et aux autorisations des utilisateurs. Les verbes couvrent la liste, la création, le déplacement, la modification et la suppression de dossiers, ainsi qu'une commande runtimes qui signale l'affectation du runtime de la machine dans un dossier.

Synthèse

uip or folders <verb> [options]

Verbes

Verbe	Objectif
list	Dressez la liste des dossiers. Par défaut: dossiers auxquels l'utilisateur actuel peut accéder; avec --all, chaque dossier du locataire.
create	Créez un dossier, éventuellement imbriqué sous un parent.
get	Récupérez un dossier par clé ou chemin.
delete	Supprimez un dossier par clé ou chemin.
move	Associez un dossier ou déplacez-le vers la racine.
update (alias edit)	Mettez à jour le nom complet et/ou la description.
runtimes	Afficher l'affectation du runtime (total/connecté/disponible) par type de runtime pour un dossier.

liste d’IU ou de dossiers

Dressez la liste des dossiers. La vue par défaut utilise GetAllForCurrentUser - dossiers auxquels l'appelant a accès. Avec --all, le verbe bascule vers le point de terminaison Folders complet (dossiers Standard et Solution dans le locataire); avec --type personal, il bascule vers le point de terminaison PersonalWorkspaces . Le filtrage et le tri des indicateurs (--name, --path, --type, --top-level, --sort-by) nécessitent --all.

Options

Short	Long	Valeur (Value)	Default	Description
-a	--all	Drapeau	désactivé	Répertorie tous les dossiers du locataire; requis pour activer le filtre et les indicateurs de tri ci-dessous.
-n	--name	text	—	Contient une correspondance sur le nom complet. Nécessite --all.
—	--path	Préfixe de chemin	—	Filtrez par préfixe du chemin de dossier (par exemple, Shared correspond à Shared et tout ce qui suit). Nécessite --all.
—	--type	ENUM	—	standard, solution ou personal Nécessite --all. personal bascule vers le point de terminaison des espaces de travail personnels.
—	--top-level	Drapeau	désactivé	Uniquement les dossiers racine (aucun parent). Nécessite --all. Non pris en charge avec --type personal.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	—	Tri OData (par exemple, Name asc). Nécessite --all.
—	--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton qui déclenche une actualisation de la pré-requête.

Exemples

# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --sort-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal

Format des données (--sortie json)

{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}

Avec --all, les éléments incluent également FeedType et PermissionModel. Avec --type personal, la charge utile est { Key, Name, OwnerName, OwnerKey, LastLogin }.

création d’IU ou de dossiers

Créez un dossier, éventuellement imbriqué sous un parent. --parent accepte soit un GUID de dossier, soit un chemin (Shared, Production/EU).

Arguments

Nom	Requis	Objectif
<name>	oui	Nom complet du dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-d	--description	text	—	Description du dossier.
-p	--parent	clé ou chemin	—	Dossier parent par GUID ou chemin. Omit pour un dossier racine.
—	--feed-type	ENUM	Processes	Processes, Libraries, FolderHierarchy
—	--permission-model	ENUM	FineGrained	FineGrained ou InheritFromTenant.
—	--provision-type	ENUM	Automatic	Automatic ou Manual.

Exemples

uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant

Format des données (--sortie json)

{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}

uip ou dossiers obtenir

Récupérez un dossier par clé ou chemin. L'argument de position détecte automatiquement: l'entrée UUID est traitée comme une clé, sinon comme un chemin.

Arguments

Nom	Requis	Objectif
<folder-key-or-path>	oui	GUID ou chemin d'accès du dossier.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'

Format des données (--sortie json)

{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}

suppression d’IU ou de dossiers

Supprimez un dossier par clé ou chemin. Échoue si le dossier contient des entités ou des associations d’utilisateurs — supprimez ou déplacez d’abord le contenu.

Arguments

Nom	Requis	Objectif
<folder-key-or-path>	oui	GUID ou chemin d'accès du dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Requis. Confirme cette opération irréversible — la CLI ne s'affiche jamais.

Exemples

uip or folders delete "Shared/Staging" --yes
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010 --yes
uip or folders delete "Shared/Staging" --yes --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}

uip ou dossiers déplacés

Déplacez un dossier vers un nouveau parent ou jusqu'à la racine. Vous devez fournir exactement l'une des --parent ou --root.

Arguments

Nom	Requis	Objectif
<folder-key-or-path>	oui	GUID ou chemin du dossier à déplacer.

Options

Short	Long	Valeur (Value)	Default	Description
-p	--parent	clé ou chemin	—	Nouveau dossier parent. Obligatoire si --root n'est pas défini.
—	--root	Drapeau	désactivé	Déplacer vers le niveau supérieur (aucun parent).

Exemples

uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'

Format des données (--sortie json)

{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}

--root définit TargetParentPath sur (root).

mise à jour de l’IU ou des dossiers

Mettez à jour le nom complet et/ou la description. Au moins une des propriétés --name ou --description doit être fournie.

edit est un alias enregistré pour ce verbe - uip or folders edit fonctionne de manière identique à uip or folders update.

Arguments

Nom	Requis	Objectif
<folder-key-or-path>	oui	GUID ou chemin d'accès du dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-n	--name	text	—	Nouveau nom complet.
-d	--description	text	—	Nouvelle description.

Exemples

uip or folders update a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders update "Shared/Staging" --description "Pre-prod runs"
uip or folders update "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}

runtimes uip ou dossiers

Répertorier l’affectation du runtime pour un dossier — pour chaque type de runtime, combien d’emplacements sont au total, connectés et disponibles. Utile pour vérifier la capacité avant de commencer les tâches.

Arguments

Nom	Requis	Objectif
<folder-key-or-path>	oui	GUID ou chemin d'accès du dossier.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"

Format des données (--sortie json)

{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}

Codes de sortie

Voir Codes de sortie. Aucun remplacement spécifique au verbe.

Commandes associées

• uip or processes — liaisons de processus à l'échelle du dossier.
• uip or machines — en particulier machines assign / unassign pour l'appartenance à un dossier.
• uip or users — users list-in-folder, users assign, users unassign.
• uip or roles — attributions de rôles au niveau dossier.

Voir également

• Options globales.
• Sessions — résolution du contexte du locataire et du dossier.