@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.f0e1354

package/docs/docs/cmd/spo/term/term-get.md

@@ -1,159 +0,0 @@
-# spo term get
-
-Gets information about the specified taxonomy term
-
-## Usage
-
-```sh
-m365 spo term get [options]
-```
-
-## Options
-
-`-u, --webUrl [webUrl]`
-: If specified, allows you to get a term from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
-
-`-i, --id [id]`
-: ID of the term to retrieve. Specify `name` or `id` but not both.
-
-`-n, --name [name]`
-: Name of the term to retrieve. Specify `name` or `id` but not both.
-
-`--termGroupId [termGroupId]`
-: ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
-
-`--termGroupName [termGroupName]`
-: Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.
-
-`--termSetId [termSetId]`
-: ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
-
-`--termSetName [termSetName]`
-: Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-When retrieving term by its ID, it's sufficient to specify just the ID. When retrieving it by its name however, you need to specify the parent term group and term set using either their names or IDs.
-
-!!! important
-    To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
-    
-When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term from the tenant term store as well as a term from the sitecollection term store.
-
-## Examples
-
-Get information about a taxonomy term using its ID from the specified sitecollection.
-
-```sh
-m365 spo term get --webUrl https://contoso.sharepoint.com/sites/project-x --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```
-
-Get information about a taxonomy term using its ID.
-
-```sh
-m365 spo term get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```
-
-Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names.
-
-```sh
-m365 spo term get --name IT --termGroupName People --termSetName Department
-```
-
-Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs.
-
-```sh
-m365 spo term get --name IT --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "CreatedDate": "2021-07-07T09:42:02.283Z",
-      "Id": "2b5c71a6-d72b-49a8-a3bf-d80636d85b44",
-      "LastModifiedDate": "2021-07-07T09:42:02.283Z",
-      "Name": "IT",
-      "CustomProperties": {},
-      "CustomSortOrder": null,
-      "IsAvailableForTagging": true,
-      "Owner": "NT Service\\SPTimerV4",
-      "Description": "",
-      "IsDeprecated": false,
-      "IsKeyword": false,
-      "IsPinned": false,
-      "IsPinnedRoot": false,
-      "IsReused": false,
-      "IsRoot": true,
-      "IsSourceTerm": true,
-      "LocalCustomProperties": {},
-      "MergedTermIds": [],
-      "PathOfTerm": "IT",
-      "TermsCount": 1
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    CreatedDate          : 2021-07-07T09:42:02.283Z
-    CustomProperties     : {}
-    CustomSortOrder      : null
-    Description          :
-    Id                   : 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
-    IsAvailableForTagging: true
-    IsDeprecated         : false
-    IsKeyword            : false
-    IsPinned             : false
-    IsPinnedRoot         : false
-    IsReused             : false
-    IsRoot               : true
-    IsSourceTerm         : true
-    LastModifiedDate     : 2021-07-07T09:42:02.283Z
-    LocalCustomProperties: {}
-    MergedTermIds        : []
-    Name                 : IT
-    Owner                : NT Service\SPTimerV4
-    PathOfTerm           : IT
-    TermsCount           : 1
-    ```
-
-=== "CSV"
-
-    ```csv
-    CreatedDate,Id,LastModifiedDate,Name,IsAvailableForTagging,Owner,Description,IsDeprecated,IsKeyword,IsPinned,IsPinnedRoot,IsReused,IsRoot,IsSourceTerm,PathOfTerm,TermsCount
-    2021-07-07T09:42:02.283Z,2b5c71a6-d72b-49a8-a3bf-d80636d85b44,2021-07-07T09:42:02.283Z,IT,1,NT Service\SPTimerV4,,,,,,,1,1,IT,1
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo term get --termGroupName "People" --termSetName "Department" --name "IT"
-
-    Date: 5/8/2023
-
-    ## IT (2b5c71a6-d72b-49a8-a3bf-d80636d85b44)
-
-    Property | Value
-    ---------|-------
-    CreatedDate | 2021-07-07T09:42:02.283Z
-    Id | 2b5c71a6-d72b-49a8-a3bf-d80636d85b44
-    LastModifiedDate | 2021-07-07T09:42:02.283Z
-    Name | IT
-    IsAvailableForTagging | true
-    Owner | NT Service\SPTimerV4
-    Description |
-    IsDeprecated | false
-    IsKeyword | false
-    IsPinned | false
-    IsPinnedRoot | false
-    IsReused | false
-    IsRoot | true
-    IsSourceTerm | true
-    PathOfTerm | IT
-    TermsCount | 1
-    ```

package/docs/docs/cmd/spo/term/term-group-add.md

@@ -1,47 +0,0 @@
-# spo term group add
-
-Adds taxonomy term group
-
-## Usage
-
-```sh
-m365 spo term group add [options]
-```
-
-## Options
-
-`-n, --name <name>`
-: Name of the term group to add
-
-`-i, --id [id]`
-: ID of the term group to add
-
-`-d, --description [description]`
-: Description of the term group to add
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Add a new taxonomy term group with the specified name
-
-```sh
-m365 spo term group add --name PnPTermSets
-```
-
-Add a new taxonomy term group with the specified name and id
-
-```sh
-m365 spo term group add --name PnPTermSets --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```
-
-Add a new taxonomy term group with the specified name and description
-
-```sh
-m365 spo term group add --name PnPTermSets --description 'Term sets for PnP'
-```

package/docs/docs/cmd/spo/term/term-group-get.md

@@ -1,104 +0,0 @@
-# spo term group get
-
-Gets information about the specified taxonomy term group
-
-## Usage
-
-```sh
-m365 spo term group get [options]
-```
-
-## Options
-
-`-u, --webUrl [webUrl]`
-: If specified, allows you to get a term group from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
-
-`-i, --id [id]`
-: ID of the term group to retrieve. Specify `name` or `id` but not both.
-
-`-n, --name [name]`
-: Name of the term group to retrieve. Specify `name` or `id` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command without the `--webUrl` option you have to have permissions to access the tenant admin site.
-
-When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to get a term group from the tenant term store as well as a term group from the sitecollection term store.
-
-## Examples
-
-Get information about a taxonomy term group using its ID.
-
-```sh
-m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-```
-
-Get information about a taxonomy term group using its name.
-
-```sh
-m365 spo term group get --name PnPTermSets
-```
-
-Get information about a taxonomy term group from the specified sitecollection using its ID.
-
-```sh
-m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    {
-      "CreatedDate": "2019-09-03T06:41:32.070Z",
-      "Id": "0e8f395e-ff58-4d45-9ff7-e331ab728beb",
-      "LastModifiedDate": "2019-09-03T06:41:32.070Z",
-      "Name": "PnPTermSets",
-      "Description": "",
-      "IsSiteCollectionGroup": false,
-      "IsSystemGroup": false
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    CreatedDate          : 2019-09-03T06:41:32.070Z
-    Description          :
-    Id                   : 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-    IsSiteCollectionGroup: false
-    IsSystemGroup        : false
-    LastModifiedDate     : 2019-09-03T06:41:32.070Z
-    Name                 : PnPTermSets
-    ```
-
-=== "CSV"
-
-    ```csv
-    CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
-    2019-09-03T06:41:32.070Z,0e8f395e-ff58-4d45-9ff7-e331ab728beb,2019-09-03T06:41:32.070Z,PnPTermSets,,,
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo term group get --id "0e8f395e-ff58-4d45-9ff7-e331ab728beb"
-
-    Date: 5/14/2023
-
-    ## PnPTermSets (0e8f395e-ff58-4d45-9ff7-e331ab728beb)
-
-    Property | Value
-    ---------|-------
-    CreatedDate | 2019-09-03T06:41:32.070Z
-    Id | 0e8f395e-ff58-4d45-9ff7-e331ab728beb
-    LastModifiedDate | 2019-09-03T06:41:32.070Z
-    Name | PnPTermSets
-    Description |
-    IsSiteCollectionGroup | false
-    IsSystemGroup | false
-    ```

package/docs/docs/cmd/spo/term/term-group-list.md

@@ -1,94 +0,0 @@
-# spo term group list
-
-Lists taxonomy term groups
-
-## Usage
-
-```sh
-m365 spo term group list [options]
-```
-
-## Options
-
-`-u, --webUrl [webUrl]`
-: If specified, allows you to list term groups from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
-
-When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to list term groups from the tenant term store as well as term groups from the sitecollection term store.
-
-## Examples
-
-List taxonomy term groups.
-
-```sh
-m365 spo term group list
-```
-
-List taxonomy term groups from the specified sitecollection.
-
-```sh
-m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "_ObjectType_": "SP.Taxonomy.TermGroup",
-        "_ObjectIdentity_": "5522b1a0-b01a-2000-4160-d04eee2e977f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=",
-        "CreatedDate": "2019-09-03T06:41:32.070Z",
-        "Id": "4aa9cd7a-d275-4fda-84b2-b83085dcee0f",
-        "LastModifiedDate": "2019-09-03T06:41:32.070Z",
-        "Name": "People",
-        "Description": "",
-        "IsSiteCollectionGroup": false,
-        "IsSystemGroup": false
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id                                    Name
-    ------------------------------------  -----------------------------------------------------------
-    4aa9cd7a-d275-4fda-84b2-b83085dcee0f  People
-    ```
-
-=== "CSV"
-
-    ```csv
-      _ObjectType_,_ObjectIdentity_,CreatedDate,Id,LastModifiedDate,Name,Description,IsSiteCollectionGroup,IsSystemGroup
-      SP.Taxonomy.TermGroup,7522b1a0-804d-2000-41be-bba084eae72f|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=,2019-09-03T06:41:32.070Z,4aa9cd7a-d275-4fda-84b2-b83085dcee0f,2019-09-03T06:41:32.070Z,People,,,
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo term group list
-
-    Date: 5/9/2023
-
-    ## People (4aa9cd7a-d275-4fda-84b2-b83085dcee0f)
-
-    Property | Value
-    ---------|-------
-    \_ObjectType\_ | SP.Taxonomy.TermGroup
-    \_ObjectIdentity\_ | 8c22b1a0-200f-2000-3976-694ba2bf8a01\|fec14c62-7c3b-481b-851b-c80d7802b224:gr:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g8=
-    CreatedDate | 2019-09-03T06:41:32.070Z
-    Id | 4aa9cd7a-d275-4fda-84b2-b83085dcee0f
-    LastModifiedDate | 2019-09-03T06:41:32.070Z
-    Name | People
-    Description |
-    IsSiteCollectionGroup | false
-    IsSystemGroup | false
-    ```

package/docs/docs/cmd/spo/term/term-list.md

@@ -1,254 +0,0 @@
-# spo term list
-
-Lists taxonomy terms from the given term set
-
-## Usage
-
-```sh
-m365 spo term list [options]
-```
-
-## Options
-
-`-u, --webUrl [webUrl]`
-: If specified, allows you to list terms from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.
-
-`--termGroupId [termGroupId]`
-: ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
-
-`--termGroupName [termGroupName]`
-: Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.
-
-`--termSetId [termSetId]`
-: ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
-
-`--termSetName [termSetName]`
-: Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
-
-`--includeChildTerms`
-: If specified, child terms are loaded as well.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command without the --webUrl option you have to have permissions to access the tenant admin site.
-
-When using the `--webUrl` option you can connect to the term store with limited permissions, and do not need the SharePoint Administrator role. You need to be a site visitor or more. It allows you to list terms from the tenant term store as well as terms from the sitecollection term store.
-
-## Examples
-
-List taxonomy terms from the specified sitecollection, the term group and term set with the given name
-
-```sh
-m365 spo term list --webUrl https://contoso.sharepoint.com/sites/project-x --termGroupName PnPTermSets --termSetName PnP-Organizations
-```
-
-List taxonomy terms from the term group and term set with the given name.
-
-```sh
-m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations
-```
-
-List taxonomy terms from the term group and term set with the given ID.
-
-```sh
-m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec
-```
-
-List taxonomy terms from the term group and term set with the given ID including child terms if any are found.
-
-```sh
-m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
-```
-
-## Response
-
-### Standard response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "_ObjectType_": "SP.Taxonomy.Term",
-        "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
-        "CreatedDate": "2021-10-12T09:42:44.880Z",
-        "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
-        "LastModifiedDate": "2021-10-12T09:42:45.237Z",
-        "Name": "Departments",
-        "CustomProperties": {},
-        "CustomSortOrder": null,
-        "IsAvailableForTagging": true,
-        "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-        "Description": "",
-        "IsDeprecated": false,
-        "IsKeyword": false,
-        "IsPinned": false,
-        "IsPinnedRoot": false,
-        "IsReused": false,
-        "IsRoot": true,
-        "IsSourceTerm": true,
-        "LocalCustomProperties": {
-          "Id": "termDepartments"
-        },
-        "MergedTermIds": [],
-        "PathOfTerm": "Departments",
-        "TermsCount": 1
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id                                    Name      
-    ------------------------------------  ---------
-    c387e91c-b553-4b92-886b-9af717cd73b0  Financing
-    ```
-
-=== "CSV"
-
-    ```csv
-    Id,Name
-    c387e91c-b553-4b92-886b-9af717cd73b0,Financing
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations"
-
-    Date: 5/8/2023
-
-    ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
-
-    Property | Value
-    ---------|-------
-    \_ObjectType\_ | SP.Taxonomy.Term
-    \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
-    CreatedDate | 2021-07-07T09:42:02.283Z
-    Id | c387e91c-b553-4b92-886b-9af717cd73b0
-    LastModifiedDate | 2021-07-07T09:42:02.283Z
-    Name | Financing
-    IsAvailableForTagging | true
-    Owner | NT Service\SPTimerV4
-    Description |
-    IsDeprecated | false
-    IsKeyword | false
-    IsPinned | false
-    IsPinnedRoot | false
-    IsReused | false
-    IsRoot | true
-    IsSourceTerm | true
-    PathOfTerm | Financing
-    TermsCount | 0
-    ```
-
-### `includeChildTerms` response
-
-When we make use of the option `includeChildTerms` the response will differ. 
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "_ObjectType_": "SP.Taxonomy.Term",
-        "_ObjectIdentity_": "430486a0-200a-6000-02cc-2eb89d8dd424|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNsaKRf7N4K0qppo4zwLIRZg==",
-        "CreatedDate": "2021-10-12T09:42:44.880Z",
-        "Id": "7f91a2b1-78b3-4a2b-a9a6-8e33c0b21166",
-        "LastModifiedDate": "2021-10-12T09:42:45.237Z",
-        "Name": "Departments",
-        "CustomProperties": {},
-        "CustomSortOrder": null,
-        "IsAvailableForTagging": true,
-        "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-        "Description": "",
-        "IsDeprecated": false,
-        "IsKeyword": false,
-        "IsPinned": false,
-        "IsPinnedRoot": false,
-        "IsReused": false,
-        "IsRoot": true,
-        "IsSourceTerm": true,
-        "LocalCustomProperties": {
-          "Id": "termDepartments"
-        },
-        "MergedTermIds": [],
-        "PathOfTerm": "Departments",
-        "TermsCount": 1,
-        "Children": [{
-          "_ObjectType_": "SP.Taxonomy.Term",
-          "_ObjectIdentity_": "d10486a0-4067-5000-de97-bf1ab5bff53c|fec14c62-7c3b-481b-851b-c80d7802b224:te:kTm3XibpGUiE5nxBtVMTf14Jch8b6X1EtvEo9yq4/mCesjVWlBPHRaBqFOZeTRSNf5ybB0mfG0Kx6YO5CODZ1A==",
-          "CreatedDate": "2022-12-25T23:59:15.200Z",
-          "Id": "079b9c7f-9f49-421b-b1e9-83b908e0d9d4",
-          "LastModifiedDate": "2022-12-25T23:59:15.200Z",
-          "Name": "Financing",
-          "CustomProperties": {},
-          "CustomSortOrder": null,
-          "IsAvailableForTagging": true,
-          "Owner": "i:0#.f|membership|admin@contoso.onmicrosoft.com",
-          "Description": "",
-          "IsDeprecated": false,
-          "IsKeyword": false,
-          "IsPinned": false,
-          "IsPinnedRoot": false,
-          "IsReused": false,
-          "IsRoot": false,
-          "IsSourceTerm": true,
-          "LocalCustomProperties": {},
-          "MergedTermIds": [],
-          "PathOfTerm": "Departments;Financing",
-          "TermsCount": 0
-        }]
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id                                    Name       ParentTermId
-    ------------------------------------  ---------  ------------------------------------
-    c387e91c-b553-4b92-886b-9af717cd73b0  Financing  079b9c7f-9f49-421b-b1e9-83b908e0d9d4
-    ```
-
-=== "CSV"
-
-    ```csv
-    Id,Name,ParentTermId
-    c387e91c-b553-4b92-886b-9af717cd73b0,Financing,079b9c7f-9f49-421b-b1e9-83b908e0d9d4
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations" --includeChildTerms "true"
-
-    Date: 5/8/2023
-
-    ## Financing (c387e91c-b553-4b92-886b-9af717cd73b0)
-
-    Property | Value
-    ---------|-------
-    \_ObjectType\_ | SP.Taxonomy.Term
-    \_ObjectIdentity\_ | b6d6b0a0-50c8-2000-41be-bd745120140b\|fec14c62-7c3b-481b-851b-c80d7802b224:te:aCf0Cz4D9UOS7+b/OlUY5XrNqUp10tpPhLK4MIXc7g/qydiOUnAdTKTXucEL/+pvpnFcKyvXqEmjv9gGNthbRA==
-    CreatedDate | 2021-07-07T09:42:02.283Z
-    Id | c387e91c-b553-4b92-886b-9af717cd73b0
-    LastModifiedDate | 2021-07-07T09:42:02.283Z
-    Name | Financing
-    IsAvailableForTagging | true
-    Owner | NT Service\SPTimerV4
-    Description |
-    IsDeprecated | false
-    IsKeyword | false
-    IsPinned | false
-    IsPinnedRoot | false
-    IsReused | false
-    IsRoot | true
-    IsSourceTerm | true
-    PathOfTerm | Financing
-    TermsCount | 0
-    ```