Method CreateVersionAsync
CreateVersionAsync(ServiceVersionParameters, CancellationToken)
Asynchronously creates a new version in the service based on the default version.
Declaration
public async Task<ServiceVersionInfo> CreateVersionAsync(ServiceVersionParameters newVersion, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| ServiceVersionParameters | newVersion | The properties of the new version |
| CancellationToken | cancellationToken | A CancellationToken with which to cancel the operation if required. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ServiceVersionInfo> | A task that represents the creation of new service version. The value of the task result contains the full metadata ServiceVersionInfo for the new version. |
Remarks
If the version parameters do not include a name, an error is thrown. Branch versioning requires that the default version always be the ancestor of all other versions. If the service isn't branch versioned, a BranchVersioningNotSupportedByServiceException is thrown.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | |
| BranchVersioningNotSupportedByServiceException |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.12 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.12 - 100.15 |
| .NET 5 | 100.12 |
| .NET Core 3.1 | 100.12 |
| Xamarin.Android | 100.12 - 100.15 |
| Xamarin.iOS | 100.12 - 100.15 |
| UWP | 100.12 - 100.14 |
CreateVersionAsync(ServiceVersionParameters)
Asynchronously creates a new version in the service based on the default version.
Declaration
public Task<ServiceVersionInfo> CreateVersionAsync(ServiceVersionParameters newVersion)Parameters
| Type | Name | Description |
|---|---|---|
| ServiceVersionParameters | newVersion | The properties of the new version |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ServiceVersionInfo> | A task that represents the creation of new service version. The value of the task result contains the full metadata ServiceVersionInfo for the new version. |
Remarks
If the version parameters do not include a name, an error is thrown. Branch versioning requires that the default version always be the ancestor of all other versions. If the service isn't branch versioned, a BranchVersioningNotSupportedByServiceException is thrown.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | |
| BranchVersioningNotSupportedByServiceException |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.9 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.9 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.9 - 100.12 |
| Xamarin.Android | 100.9 - 100.15 |
| Xamarin.iOS | 100.9 - 100.15 |
| UWP | 100.9 - 100.15 |