New-PSUEndpointDocumentation

SINOSSI

Crea una nuova definizione di documentazione dell'endpoint.

SINTASSI

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>]

DESCRIZIONE

Crea una nuova definizione di documentazione dell'endpoint.

ESEMPI

Esempio 1

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

Crea una definizione di guida in /psuhelp.

PARAMETRI

-AppToken

Un token dell'app per accedere all'API UA.

Type: String
Parameter Sets: (All)
Aliases:

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

-Authentication

Indica se è richiesta l'autenticazione per accedere a questa definizione di documentazione.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ComputerName

L'indirizzo HTTP del server 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

Classi definite per i tipi di input e output per questa documentazione dell'endpoint.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

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

-Description

Una descrizione della documentazione.

Type: String
Parameter Sets: (All)
Aliases:

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

-Integrated

Esegue il comando internamente anziché utilizzare l'API di gestione. Funziona solo quando lo script viene eseguito all'interno di PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Nome di questa definizione di documentazione.

Type: String
Parameter Sets: (All)
Aliases:

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

-Role

Ruoli autorizzati a visualizzare questa documentazione.

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

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

-Url

L'URL utilizzato per accedere a questa documentazione.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseDefaultCredentials

Utilizza le credenziali predefinite durante la connessione all'API di gestione

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Credential

Credenziali per accedere all'API di gestione di PowerShell Universal.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-TrustCertificate

Indica se il cmdlet deve ignorare i problemi relativi ai certificati.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ContactEmail

Specifica l'indirizzo e-mail di contatto mostrato nella documentazione dell'API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContactName

Specifica il nome del contatto mostrato nella documentazione dell'API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContactUrl

Specifica l'URL per le informazioni di contatto dell'API.

Type: String
Parameter Sets: (All)
Aliases:

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

-LicenseName

Specifica il nome della licenza mostrato nella documentazione dell'API.

Type: String
Parameter Sets: (All)
Aliases:

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

-LicenseUrl

Specifica l'URL della licenza mostrato nella documentazione dell'API.

Type: String
Parameter Sets: (All)
Aliases:

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

-TermsOfServiceUrl

Specifica l'URL del documento dei termini di servizio.

Type: String
Parameter Sets: (All)
Aliases:

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

-Version

Specifica il valore della versione per la risorsa.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookies

Riutilizza e mantiene i cookie di autenticazione per la sessione PowerShell corrente.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable e -ProgressAction. Per maggiori informazioni, veda about_CommonParameters.