Skip to main content

spo applicationcustomizer get

Get an application customizer that is added to a site

Usage​

m365 spo applicationcustomizer get [options]

Options​

-u, --webUrl <webUrl>

URL of the site.

-t, --title [title]

The title of the Application Customizer. Specify either title, id or clientSideComponentId.

-i, --id [id]

The id of the Application Customizer. Specify either title, id or clientSideComponentId.

-c, --clientSideComponentId [clientSideComponentId]

The Client Side Component Id (GUID) of the application customizer. Specify either title, id or clientSideComponentId.

-s, --scope [scope]

Scope of the application customizer. Allowed values: Site, Web, All. Defaults to All.

-p, --clientSideComponentProperties

Only output the client-side component properties.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks​

This command can be used for retrieving an application customizer from a specific site. To retrieve an application customizer that's installed tenant-wide, view our dedicated spo tenant applicationcustomizer get command.

Examples​

Retrieves an application customizer by title.

m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales

Retrieves an application customizer by id.

m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales

Retrieves an application customizer by clientSideComponentId.

m365 spo applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales

Retrieves an application customizer by title available at the site scope.

m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales --scope site

Retrieves the client-side component properties of a application customizer.

m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties

Response​

Standard response​

{
  "ClientSideComponentId": "9a8b100c-246b-4592-9454-67826523e159",
  "ClientSideComponentProperties": "{\"testMessage\":\"Test message\"}",
  "CommandUIExtension": null,
  "Description": null,
  "Group": null,
  "HostProperties": "",
  "Id": "4a428b32-08cf-45c7-9986-17585af38806",
  "ImageUrl": null,
  "Location": "ClientSideExtension.ApplicationCustomizer",
  "Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
  "RegistrationId": null,
  "RegistrationType": 0,
  "Rights": {
    "High": 0,
    "Low": 0
  },
  "Scope": "Web",
  "ScriptBlock": null,
  "ScriptSrc": null,
  "Sequence": 65536,
  "Title": "HelloWorld",
  "Url": null,
  "VersionOfUserCustomAction": "1.0.1.0"
}

clientSideComponentProperties response​

{
  "testMessage": "Test message"
}
CTRL + M