New-PSUEndpointDocumentation

SINOPSIS

Crea una nueva definición de documentación de endpoint.

SINTAXIS

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

DESCRIPCIÓN

Crea una nueva definición de documentación de endpoint.

EJEMPLOS

Ejemplo 1

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

Crea una definición de ayuda en /psuhelp.

PARÁMETROS

-AppToken

Un token de aplicación para acceder a la API de UA.

Type: String
Parameter Sets: (All)
Aliases:

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

-Authentication

Indica si se requiere autenticación para acceder a esta definición de documentación.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ComputerName

La dirección HTTP del servidor de la API REST de UA.

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

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

-Definition

Clases definidas para los tipos de entrada y salida de esta documentación de endpoint.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

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

-Description

Una descripción de la documentación.

Type: String
Parameter Sets: (All)
Aliases:

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

-Integrated

Ejecuta el comando internamente en lugar de usar la API de gestión. Solo funciona al ejecutar el script desde PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Nombre de esta definición de documentación.

Type: String
Parameter Sets: (All)
Aliases:

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

-Role

Roles con permiso para ver esta documentación.

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

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

-Url

La URL utilizada para acceder a esta documentación.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseDefaultCredentials

Usar las credenciales predeterminadas al conectarse a la API de gestión

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Credential

Credenciales para iniciar sesión en la API de gestión 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

Indica si el cmdlet debe ignorar los problemas de certificado.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ContactEmail

Especifica la dirección de correo electrónico de contacto que se muestra en la documentación de la API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContactName

Especifica el nombre de contacto que se muestra en la documentación de la API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContactUrl

Especifica la URL de la información de contacto de la API.

Type: String
Parameter Sets: (All)
Aliases:

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

-LicenseName

Especifica el nombre de la licencia que se muestra en la documentación de la API.

Type: String
Parameter Sets: (All)
Aliases:

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

-LicenseUrl

Especifica la URL de la licencia que se muestra en la documentación de la API.

Type: String
Parameter Sets: (All)
Aliases:

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

-TermsOfServiceUrl

Especifica la URL del documento de condiciones del servicio.

Type: String
Parameter Sets: (All)
Aliases:

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

-Version

Especifica el valor de versión del recurso.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cookies

Reutiliza y conserva las cookies de autenticación para la sesión actual de PowerShell.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable y -ProgressAction. Para obtener más información, consulte about_CommonParameters.