Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Container type lifecycle cmdlets #755

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
external help file: sharepointonline.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spocontainertypebilling
applicable: SharePoint Online
title: Add-SPOContainerTypeBilling
schema: 2.0.0
author: ShreyasSar26
ms.author: shsaravanan
ms.reviewer:
---

# Add-SPOContainerTypeBilling

## SYNOPSIS

Adds the mentioned billing profile details to a standard container type.

## SYNTAX

### ParamSet1

```powershell
Add-SPOContainerTypeBilling –ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup> -Region <Region>
```


## DESCRIPTION

This cmdlet attaches the Azure subscription ID, resource group and region with the container type ID provided.

You must be a SharePoint Embedded Administrator to run this cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).

## EXAMPLES

### Example 1

```powershell
Add-SPOContainerTypeBilling - ContainerTypeId aa1d89b3-b4cf-4c0a-8e1c-0d131c57544a -AzureSubscriptionId 5a8a4d9f-9f8d-4cac-8a97-28ab04ff194c -ResourceGroup "RG100" -Region "(US) East US“
```

Example 1 attaches the billing profile of Azure subscription ID “5a8a4d9f-9f8d-4cac-8a97-28ab04ff194c”, resource group “RG100” and region “(US) East US” to the container type ID “aa1d89b3-b4cf-4c0a-8e1c-0d131c57544a”


## PARAMETERS

### -ContainerTypeId

This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

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

### -AzureSubscriptionId

This parameter describes the Azure subscription ID to which the container type needs to be associated.

```yaml
Type: String
Parameter Sets:
Aliases:
Applicable: SharePoint Online

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


### -ResourceGroup

This parameter describes the resource group to be used for the associated container type.

```yaml
Type: String
Parameter Sets:
Aliases:
Applicable: SharePoint Online

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

### -Region

This parameter describes the region to which the billing profile of the container type is associated with.

```yaml
Type: String
Parameter Sets: ParamSet2, ParamSet3
Aliases:
Applicable: SharePoint Online

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

## RELATED LINKS

[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)

[New-SPOContainerType](./New-SPOContainerType.md)

[Get-SPOContainerType](./Get-SPOContainerType.md)

[Set-SPOContainerType](./Set-SPOContainerType.md)

[Remove-SPOContainerType](./Remove-SPOContainerType.md)
95 changes: 64 additions & 31 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,57 @@ ms.reviewer:

## SYNOPSIS

Returns one or more Containers in a SharePoint Embedded application.
Returns one or more containers in a SharePoint Embedded application.

## SYNTAX

### ParamSet1

```powershell
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [<CommonParameters>]
Get-SPOContainer -Identity <ContainerId>
```

### ParamSet2

```powershell
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged]
Get-SPOContainer -OwningApplicationId <OwningApplicationId>
```

### ParamSet3
```powershell
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged] [-PagingToken <Token String>]
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Paged
```

### ParamSet4

```powershell
Get-SPOContainer [[-Identity] <ContainerId>]
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Paged -PagingToken <Token String>
```

### ParamSet5

```powershell
Get-SPOContainer [[-Identity] <ContainerSiteURL>]
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>
```

### ParamSet6

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>-Paged
```
### ParamSet7

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>-Paged -PagingToken <Token String>
```

## DESCRIPTION

The `Get-SPOContainer` cmdlet retrieves and returns a list of Containers and details of an individual Container created under a SharePoint Embedded application. This command is available only in SharePoint Online Management Shell version 16.0.24211.12000 or higher to run this cmdlet.
The `Get-SPOContainer` cmdlet retrieves and returns the details of an individual container when paired `Identity` parameter, where the container ID needs to be mentioned. The cmdlet returns the list of containers belonging to a SharePoint Embedded application when paired with the `OwningApplicationId` parameter.

You must be a SharePoint Embedded Administrator to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).

You must be a SharePoint Online Administrator to run this cmdlet.

> [!NOTE]
> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet.
Expand All @@ -62,47 +76,58 @@ You must be a SharePoint Online Administrator to run this cmdlet.
### Example 1

```powershell
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 | FT
Get-SPOContainer -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
```

Example 1 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45-jikl-9bnm-b302-1234ghy56789`.

To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: `a187e399-0c36-4b98-8f04-1edc167a0996`.

To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e-4cbd-4754-9ad3-8291c2c81ade

### Example 2

```powershell
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 | FT
```

Example 2 returns the detailed properties of the Container with associated `ContainerId`.
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45-jikl-9bnm-b302-1234ghy56789`.


### Example 3

```powershell
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity https://contoso.sharepoint.com/storagecontainers/CSP_b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Paged | FT
```

Example 3 gives the detailed properties of a Container using the site URL of a Container.
Example 3 uses the `-Paged` command to retrieve a paging token.

### Example 4

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged | FT
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Paged -PagingToken <Token String> | FT
```

Example 4 uses the `-Paged` command to retrieve a paging token.
Example 4 uses the `-PagingToken` parameter along with the `-Paged`parameter to view more containers that were not displayed in Example 3

### Example 5

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged -PagingToken <Token String> | FT
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>
```

Example 5 displays the containers belonging to the application, sorted in ascending order of storage

### Example 6

```powershell
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>-Paged
```

Example 6 displays a paged view of the the containers belonging to the application, sorted in ascending order of storage

### Example 7

```powershell
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>-Paged-PagingToken <Token String>
```

Example 5 uses the `PagingToken` to view more Containers.
Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage


## PARAMETERS

Expand All @@ -125,7 +150,7 @@ Accept wildcard characters: False

### -Identity

Use this parameter to specify the Container in the given OwningApplicationId.
Use this parameter to specify the Container ID of a container.

```yaml
Type: String
Expand All @@ -142,7 +167,7 @@ Accept wildcard characters: False

### -Paged

This parameter can be used when there are more than 200 Containers in a given SharePoint repository services application. Using `-Paged` will provide a `<Paging Token>` that will display the next 200 Containers.
This parameter can be used when there are more than 200 Containers in a given SharePoint Embedded application. Using `-Paged` will provide a `<Paging Token>` that will display the next 200 Containers.

```yaml
Type: String
Expand All @@ -160,7 +185,7 @@ Accept wildcard characters: False

### -PagingToken

Use this parameter to provide the `<Paging Token>` provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message `End of Containers view.` Otherwise, use the given `<Paging Token>` to retrieve the next batch of up to 200 Containers.
Use this parameter to provide the `<Paging Token>` provided to view the remaining Containers as shown in Example 4. If there are no more Containers to display, the commandlet output will return the message `End of Containers view.` Otherwise, use the given `<Paging Token>` to retrieve the next batch of up to 200 Containers.

```yaml
Type: String
Expand All @@ -174,12 +199,20 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -SortByStorage

### CommonParameters
This parameter can be used when you need to see the list of containers, sorted by storage.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
```yaml
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Applies to: SharePoint Online
```

## NOTES

## RELATED LINKS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Get-SPOContainerType
```
### ParamSet2
```powershell
Get-SPOContainerType [-ContainerTypeId <ContainerTypeId>]
Get-SPOContainerType -ContainerTypeId <ContainerTypeId>
```

## DESCRIPTION

This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the containertype ID parameter.
This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the `ContainerTypeId` parameter.

You must be a SharePoint Embedded Administrator to run the cmdlet.

Expand Down
Loading