Skip to content

Data types

Options for about of ARM resource.

model Azure.Portal.AboutOptions
NameTypeDescription
icon?FilePathIcon which represent resource
displayNames?DisplayNamesOptionsDisplay names which represent the resource
keywords?string[]Comma-separated set of words or phrases which allow users to search for your asset by identifiers.
learnMoreDocs?Azure.Portal.LearnMoreDocsOptions[]Set of links which can help learn more about the resource

Options for browse of ARM resource.

model Azure.Portal.BrowseOptions
NameTypeDescription
argQuery?string | Azure.Portal.FilePathargQuery can be a literal string query or KQL file path.
KQL query which represents all possible data for your desired browse view.

Options for displayNames of ARM resources.

model Azure.Portal.DisplayNamesOptions
NameTypeDescription
singularstringThe singular display name of the resource.
pluralstringThe plural display name of the resource.

File path of a file

model Azure.Portal.FilePath
NameTypeDescription
filePathstringFile path of a file

Options for learnMoreDocs of ARM resources.

model Azure.Portal.LearnMoreDocsOptions
NameTypeDescription
titlestringThe title of the documentation link.
uristringThe URI of the documentation link.

Options for marketplaceOffer

model Azure.Portal.MarketplaceOfferOptions
NameTypeDescription
id?stringMarketplace offer id of a resource

Options for promotion of ARM resource.

model Azure.Portal.PromotionOptions
NameTypeDescription
apiVersionstring | EnumMemberThe API version to promote, either a literal version string or a version enum member.
autoUpdate?booleanWhether the promoted API version should be updated automatically.