PurviewCollection.CreateOrUpdateCollectionAsync Method

Definition

Creates or updates a collection entity.

public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateCollectionAsync (Azure.Core.RequestContent content, Azure.RequestOptions options = default);
abstract member CreateOrUpdateCollectionAsync : Azure.Core.RequestContent * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrUpdateCollectionAsync : Azure.Core.RequestContent * Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CreateOrUpdateCollectionAsync (content As RequestContent, Optional options As RequestOptions = Nothing) As Task(Of Response)

Parameters

content
RequestContent

The content to send as the body of the request.

options
Azure.RequestOptions

The request options.

Returns

Exceptions

content is null.

Remarks

Schema for Request Body:

{
              collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded",
              description: string,
              friendlyName: string,
              name: string,
              parentCollection: {
                referenceName: string,
                type: string
              },
              systemData: {
                createdAt: string (ISO 8601 Format),
                createdBy: string,
                createdByType: "User" | "Application" | "ManagedIdentity" | "Key",
                lastModifiedAt: string (ISO 8601 Format),
                lastModifiedBy: string,
                lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key"
              }
            }

Schema for Response Body:

{
              collectionProvisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded",
              description: string,
              friendlyName: string,
              name: string,
              parentCollection: {
                referenceName: string,
                type: string
              },
              systemData: {
                createdAt: string (ISO 8601 Format),
                createdBy: string,
                createdByType: "User" | "Application" | "ManagedIdentity" | "Key",
                lastModifiedAt: string (ISO 8601 Format),
                lastModifiedBy: string,
                lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key"
              }
            }

Schema for Response Error:

{
              error: {
                code: string,
                details: [
                  {
                    code: string,
                    details: [ErrorModel],
                    message: string,
                    target: string
                  }
                ],
                message: string,
                target: string
              }
            }

Applies to