Skip to content

Update-ManagedModuleCatalog.md

Latest commit

 

History

History
172 lines (135 loc) · 3.87 KB

Update-ManagedModuleCatalog.md

File metadata and controls

172 lines (135 loc) · 3.87 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

Update-ManagedModuleCatalog

SYNOPSIS

Refreshes package metadata in a local managed module catalog.

SYNTAX

__AllParameterSets

Update-ManagedModuleCatalog [[-Name] <string>] [[-PackageName] <string[]>] [-IncludePrerelease <bool>] [-Credential <pscredential>] [-CredentialUserName <string>] [-CredentialSecret <string>] [-CredentialSecretFilePath <string>] [-Scope <ModuleRepositoryProfileScope>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Refreshes package metadata in a local managed module catalog.

EXAMPLES

EXAMPLE 1

Update-ManagedModuleCatalog -Name PSGallery -PackageName Pester, Microsoft.Graph.Authentication

Queries live metadata and stores the known versions, dependency metadata, hashes, sizes, and package URLs locally.

PARAMETERS

-Credential

Optional repository credential.

Type: PSCredential
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-CredentialSecret

Optional repository credential secret.

Type: String
Parameter Sets: __AllParameterSets
Aliases: Password, Token
Possible values:

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

-CredentialSecretFilePath

Optional path to a file containing the repository credential secret.

Type: String
Parameter Sets: __AllParameterSets
Aliases: CredentialPath, TokenPath
Possible values:

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

-CredentialUserName

Optional repository credential username.

Type: String
Parameter Sets: __AllParameterSets
Aliases: UserName
Possible values:

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

-IncludePrerelease

Override the catalog's prerelease refresh setting for this run.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-Name

Catalog name. Defaults to PSGallery.

Type: String
Parameter Sets: __AllParameterSets
Aliases: Repository, RepositoryName
Possible values:

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

-PackageName

Package/module names to refresh. When omitted, existing catalog packages are refreshed.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: Package, Module, ModuleName
Possible values:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue, ByPropertyName)
Accept wildcard characters: True

-Scope

Catalog storage scope.

Type: ModuleRepositoryProfileScope
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: User, Machine, All

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • System.String[]

OUTPUTS

  • PowerForge.ManagedModuleCatalogUpdateResult

RELATED LINKS

  • None