New-PSUEndpointDocumentation

SYNOPSIS

Crée une nouvelle définition de documentation de terminal.

SYNTAXE

New-PSUEndpointDocumentation -Name <String> [-Description <String>] [-Authentication] [-Role <String[]>]
 [-Definition <ScriptBlock>] -Url <String> [-ContactName <String>] [-ContactEmail <String>]
 [-ContactUrl <String>] [-Version <String>] [-LicenseUrl <String>] [-LicenseName <String>]
 [-TermsOfServiceUrl <String>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

DESCRIPTION

Crée une nouvelle définition de documentation de terminal.

EXEMPLES

Exemple 1

PS C:\> New-PSUEndpointDocumentation -Name 'PSUHelp' -Url '/psuhelp'

Crée une définition d'aide à /psuhelp.

PARAMÈTRES

-AppToken

Un jeton d'appli pour accéder à l'API UA.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Authentication

Indique si l'authentification est requise pour accéder à cette définition de documentation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

L'adresse HTTP du serveur de l'API REST UA.

Type: String
Parameter Sets: (All)
Aliases: Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Definition

Classes définies pour les types d'entrée et de sortie de cette documentation de terminal.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Une description de la documentation.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Integrated

Exécute la commande en interne plutôt que d'utiliser l'API de gestion. Fonctionne uniquement lors de l'exécution d'un script depuis PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Nom de cette définition de documentation.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

Rôles autorisés à consulter cette documentation.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Url

L'URL utilisée pour accéder à cette documentation.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseDefaultCredentials

Utiliser les identifiants par défaut lors de la connexion à l'API de gestion

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Identifiants pour se connecter à l'API de gestion de PowerShell Universal.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrustCertificate

Indique si l'applet de commande doit ignorer les problèmes de certificat.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactEmail

Spécifie l'adresse courriel de contact affichée dans la documentation de l'API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactName

Spécifie le nom du contact affiché dans la documentation de l'API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContactUrl

Spécifie l'URL des informations de contact de l'API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseName

Spécifie le nom de la licence affiché dans la documentation de l'API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LicenseUrl

Spécifie l'URL de la licence affichée dans la documentation de l'API.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TermsOfServiceUrl

Spécifie l'URL du document des conditions d'utilisation.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version

Spécifie la valeur de version de la ressource.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cookies

Réutilise et conserve les témoins d'authentification pour la session PowerShell en cours.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Paramètres communs

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable et -ProgressAction. Pour plus d'informations, consultez about_CommonParameters.